Steve-Dee-Designs
/
woocommerce
mirror of https://github.com/woocommerce/woocommerce.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Rename update_ functions to edit_item, and get_groups/get_settings to get_item and get_items per feedback. Also move the namespace into each class.

This commit is contained in:
Justin Shreve 2016-04-04 10:34:14 -07:00
parent 170e2a1346
commit 2580c39708
2 changed files with 24 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
includes/api/wc-rest-settings-controller.php
View File

@ -15,6 +15,11 @@ if ( ! defined( 'ABSPATH' ) ) {
*/
class WC_Rest_Settings_Controller extends WP_Rest_Settings_Base {
/**
* WP REST API namespace/version.
*/
protected $namespace = 'wc/v1';
/**
* Route base.
* @var string
@ -26,15 +31,15 @@ class WC_Rest_Settings_Controller extends WP_Rest_Settings_Base {
* @since 2.7.0
*/
public function register_routes() {
register_rest_route( WC_API::REST_API_NAMESPACE, '/' . $this->rest_base . '/(?P<group>[\w-]+)/(?P<setting>[\w-]+)', array(
register_rest_route( $this->namespace, '/' . $this->rest_base . '/(?P<group>[\w-]+)/(?P<setting>[\w-]+)', array(
array(
'methods' => WP_REST_Server::READABLE,
'callback' => array( $this, 'get_setting' ),
'callback' => array( $this, 'get_item' ),
'permission_callback' => array( $this, 'permissions_check' ),
),
array(
'methods' => WP_REST_Server::EDITABLE,
'callback' => array( $this, 'update_setting' ),
'callback' => array( $this, 'edit_item' ),
'permission_callback' => array( $this, 'permissions_check' ),
'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ),
),
@ -48,7 +53,7 @@ class WC_Rest_Settings_Controller extends WP_Rest_Settings_Base {
* @param WP_REST_Request $request
* @return WP_Error|WP_REST_Response
*/
public function get_setting( $request ) {
public function get_item( $request ) {
$setting = $this->_get_setting_from_request( $request );
if ( is_wp_error( $setting ) ) {
return $setting;
@ -62,7 +67,7 @@ class WC_Rest_Settings_Controller extends WP_Rest_Settings_Base {
* @param WP_REST_Request $request
* @return WP_Error|WP_REST_Response
*/
public function update_setting( $request ) {
public function edit_item( $request ) {
$setting = $this->_get_setting_from_request( $request );
if ( is_wp_error( $setting ) ) {
return $setting;

23
includes/api/wc-rest-settings-groups-controller.php
View File

@ -15,28 +15,33 @@ if ( ! defined( 'ABSPATH' ) ) {
*/
class WC_Rest_Settings_Groups_Controller extends WP_Rest_Settings_Base {
/**
* WP REST API namespace/version.
*/
protected $namespace = 'wc/v1';
/**
* Register routes.
* @since 2.7.0
*/
public function register_routes() {
register_rest_route( WC_API::REST_API_NAMESPACE, '/' . $this->rest_base, array(
register_rest_route( $this->namespace, '/' . $this->rest_base, array(
array(
'methods' => WP_REST_Server::READABLE,
'callback' => array( $this, 'get_groups' ),
'callback' => array( $this, 'get_items' ),
'permission_callback' => array( $this, 'permissions_check' ),
),
'schema' => array( $this, 'group_schema' ),
) );
register_rest_route( WC_API::REST_API_NAMESPACE, '/' . $this->rest_base . '/(?P<group>[\w-]+)', array(
register_rest_route( $this->namespace, '/' . $this->rest_base . '/(?P<group>[\w-]+)', array(
array(
'methods' => WP_REST_Server::READABLE,
'callback' => array( $this, 'get_group' ),
'callback' => array( $this, 'get_item' ),
'permission_callback' => array( $this, 'permissions_check' ),
),
array(
'methods' => WP_REST_Server::EDITABLE,
'callback' => array( $this, 'update_settings' ),
'callback' => array( $this, 'edit_item' ),
'permission_callback' => array( $this, 'permissions_check' ),
'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ),
),
@ -45,12 +50,12 @@ class WC_Rest_Settings_Groups_Controller extends WP_Rest_Settings_Base {
}
/**
* Get all settings groups.
* Get all settings groups items.
* @since 2.7.0
* @param WP_REST_Request $request
* @return WP_Error|WP_REST_Response
*/
public function get_groups( $request ) {
public function get_items( $request ) {
$groups = apply_filters( 'woocommerce_settings_groups', array() );
if ( empty( $groups ) ) {
return new WP_Error( 'rest_setting_groups_empty', __( 'No setting groups have been registered.', 'woocommerce' ), array( 'status' => 500 ) );
@ -83,7 +88,7 @@ class WC_Rest_Settings_Groups_Controller extends WP_Rest_Settings_Base {
* @param WP_REST_Request $request
* @return WP_Error|WP_REST_Response
*/
public function get_group( $request ) {
public function get_item( $request ) {
$group = $this->_get_group_from_request( $request );
if ( is_wp_error( $group ) ) {
return $group;
@ -97,7 +102,7 @@ class WC_Rest_Settings_Groups_Controller extends WP_Rest_Settings_Base {
* @param WP_REST_Request $request
* @return WP_Error|WP_REST_Response
*/
public function update_settings( $request ) {
public function edit_item( $request ) {
$group = $this->_get_group_from_request( $request );
if ( is_wp_error( $group ) ) {
return $group;