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

Settings

This commit is contained in:
Mike Jolley 2019-05-30 15:54:11 +01:00
parent ddd75d71d6
commit 2b343e8a67
3 changed files with 56 additions and 137 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/RestApi/Version4/Controllers/PaymentGateways.php
View File

@ -28,7 +28,9 @@ class PaymentGateways extends AbstractController {
*/ */
public function register_routes() { public function register_routes() {
register_rest_route( register_rest_route(
$this->namespace, '/' . $this->rest_base, array( $this->namespace,
'/' . $this->rest_base,
array(
array( array(
'methods' => WP_REST_Server::READABLE, 'methods' => WP_REST_Server::READABLE,
'callback' => array( $this, 'get_items' ), 'callback' => array( $this, 'get_items' ),
@ -39,7 +41,9 @@ class PaymentGateways extends AbstractController {
) )
); );
register_rest_route( register_rest_route(
$this->namespace, '/' . $this->rest_base . '/(?P<id>[\w-]+)', array( $this->namespace,
'/' . $this->rest_base . '/(?P<id>[\w-]+)',
array(
'args' => array( 'args' => array(
'id' => array( 'id' => array(
'description' => __( 'Unique identifier for the resource.', 'woocommerce' ), 'description' => __( 'Unique identifier for the resource.', 'woocommerce' ),

73
src/RestApi/Version4/class-wc-rest-settings-v2-controller.php → src/RestApi/Version4/Controllers/Settings.php
View File

@ -5,25 +5,16 @@
* Handles requests to the /settings endpoints. * Handles requests to the /settings endpoints.
* *
* @package WooCommerce/RestApi * @package WooCommerce/RestApi
* @since 3.0.0
*/ */
namespace WooCommerce\RestApi\Version4\Controllers;
defined( 'ABSPATH' ) || exit; defined( 'ABSPATH' ) || exit;
/** /**
* REST API Settings controller class. * REST API Settings controller class.
*
* @package WooCommerce/RestApi
* @extends WC_REST_Controller
*/ */
class WC_REST_Settings_V2_Controller extends WC_REST_Controller { class Settings extends AbstractController {
/**
* WP REST API namespace/version.
*
* @var string
*/
protected $namespace = 'wc/v2';
/** /**
* Route base. * Route base.
@ -39,7 +30,9 @@ class WC_REST_Settings_V2_Controller extends WC_REST_Controller {
*/ */
public function register_routes() { public function register_routes() {
register_rest_route( register_rest_route(
$this->namespace, '/' . $this->rest_base, array( $this->namespace,
'/' . $this->rest_base,
array(
array( array(
'methods' => WP_REST_Server::READABLE, 'methods' => WP_REST_Server::READABLE,
'callback' => array( $this, 'get_items' ), 'callback' => array( $this, 'get_items' ),
@ -48,6 +41,45 @@ class WC_REST_Settings_V2_Controller extends WC_REST_Controller {
'schema' => array( $this, 'get_public_item_schema' ), 'schema' => array( $this, 'get_public_item_schema' ),
) )
); );
register_rest_route(
$this->namespace,
'/' . $this->rest_base . '/batch',
array(
array(
'methods' => WP_REST_Server::EDITABLE,
'callback' => array( $this, 'batch_items' ),
'permission_callback' => array( $this, 'update_items_permissions_check' ),
),
'schema' => array( $this, 'get_public_batch_schema' ),
)
);
}
/**
* Makes sure the current user has access to WRITE the settings APIs.
*
* @param WP_REST_Request $request Full data about the request.
* @return WP_Error|bool
*/
public function update_items_permissions_check( $request ) {
if ( ! wc_rest_check_manager_permissions( 'settings', 'edit' ) ) {
return new WP_Error( 'woocommerce_rest_cannot_edit', __( 'Sorry, you cannot edit this resource.', 'woocommerce' ), array( 'status' => rest_authorization_required_code() ) );
}
return true;
}
/**
* Update a setting.
*
* @param WP_REST_Request $request Request data.
* @return WP_Error|WP_REST_Response
*/
public function update_item( $request ) {
$options_controller = new WC_REST_Setting_Options_Controller();
$response = $options_controller->update_item( $request );
return $response;
} }
/** /**
@ -197,32 +229,27 @@ class WC_REST_Settings_V2_Controller extends WC_REST_Controller {
'id' => array( 'id' => array(
'description' => __( 'A unique identifier that can be used to link settings together.', 'woocommerce' ), 'description' => __( 'A unique identifier that can be used to link settings together.', 'woocommerce' ),
'type' => 'string', 'type' => 'string',
'context' => array( 'view' ), 'context' => array( 'view', 'edit' ),
'readonly' => true,
), ),
'label' => array( 'label' => array(
'description' => __( 'A human readable label for the setting used in interfaces.', 'woocommerce' ), 'description' => __( 'A human readable label for the setting used in interfaces.', 'woocommerce' ),
'type' => 'string', 'type' => 'string',
'context' => array( 'view' ), 'context' => array( 'view', 'edit' ),
'readonly' => true,
), ),
'description' => array( 'description' => array(
'description' => __( 'A human readable description for the setting used in interfaces.', 'woocommerce' ), 'description' => __( 'A human readable description for the setting used in interfaces.', 'woocommerce' ),
'type' => 'string', 'type' => 'string',
'context' => array( 'view' ), 'context' => array( 'view', 'edit' ),
'readonly' => true,
), ),
'parent_id' => array( 'parent_id' => array(
'description' => __( 'ID of parent grouping.', 'woocommerce' ), 'description' => __( 'ID of parent grouping.', 'woocommerce' ),
'type' => 'string', 'type' => 'string',
'context' => array( 'view' ), 'context' => array( 'view', 'edit' ),
'readonly' => true,
), ),
'sub_groups' => array( 'sub_groups' => array(
'description' => __( 'IDs for settings sub groups.', 'woocommerce' ), 'description' => __( 'IDs for settings sub groups.', 'woocommerce' ),
'type' => 'string', 'type' => 'string',
'context' => array( 'view' ), 'context' => array( 'view', 'edit' ),
'readonly' => true,
), ),
), ),
); );

112
src/RestApi/Version4/class-wc-rest-settings-controller.php
View File

@ -1,112 +0,0 @@
<?php
/**
* REST API Settings controller
*
* Handles requests to the /settings endpoints.
*
* @package WooCommerce/RestApi
* @since 3.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* REST API Settings controller class.
*
* @package WooCommerce/RestApi
* @extends WC_REST_Settings_V2_Controller
*/
class WC_REST_Settings_Controller extends WC_REST_Settings_V2_Controller {
/**
* Endpoint namespace.
*
* @var string
*/
protected $namespace = 'wc/v3';
/**
* Register routes.
*/
public function register_routes() {
parent::register_routes();
register_rest_route( $this->namespace, '/' . $this->rest_base . '/batch', array(
array(
'methods' => WP_REST_Server::EDITABLE,
'callback' => array( $this, 'batch_items' ),
'permission_callback' => array( $this, 'update_items_permissions_check' ),
),
'schema' => array( $this, 'get_public_batch_schema' ),
) );
}
/**
* Makes sure the current user has access to WRITE the settings APIs.
*
* @param WP_REST_Request $request Full data about the request.
* @return WP_Error|bool
*/
public function update_items_permissions_check( $request ) {
if ( ! wc_rest_check_manager_permissions( 'settings', 'edit' ) ) {
return new WP_Error( 'woocommerce_rest_cannot_edit', __( 'Sorry, you cannot edit this resource.', 'woocommerce' ), array( 'status' => rest_authorization_required_code() ) );
}
return true;
}
/**
* Update a setting.
*
* @param WP_REST_Request $request Request data.
* @return WP_Error|WP_REST_Response
*/
public function update_item( $request ) {
$options_controller = new WC_REST_Setting_Options_Controller();
$response = $options_controller->update_item( $request );
return $response;
}
/**
* Get the groups schema, conforming to JSON Schema.
*
* @since 3.0.0
* @return array
*/
public function get_item_schema() {
$schema = array(
'$schema' => 'http://json-schema.org/draft-04/schema#',
'title' => 'setting_group',
'type' => 'object',
'properties' => array(
'id' => array(
'description' => __( 'A unique identifier that can be used to link settings together.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'label' => array(
'description' => __( 'A human readable label for the setting used in interfaces.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'description' => array(
'description' => __( 'A human readable description for the setting used in interfaces.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'parent_id' => array(
'description' => __( 'ID of parent grouping.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
'sub_groups' => array(
'description' => __( 'IDs for settings sub groups.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
),
),
);
return $this->add_additional_fields_schema( $schema );
}
}