2019-05-10 16:56:07 +00:00
< ? php
/**
* REST API Product Attributes controller
*
* Handles requests to the products / attributes endpoint .
*
* @ author WooThemes
* @ category API
2019-06-21 09:40:39 +00:00
* @ package Automattic / WooCommerce / RestApi
2019-05-10 16:56:07 +00:00
* @ since 3.0 . 0
*/
if ( ! defined ( 'ABSPATH' ) ) {
exit ;
}
/**
* REST API Product Attributes controller class .
*
2019-06-21 09:40:39 +00:00
* @ package Automattic / WooCommerce / RestApi
2019-05-10 16:56:07 +00:00
* @ extends WC_REST_Controller
*/
class WC_REST_Product_Attributes_V1_Controller extends WC_REST_Controller {
/**
* Endpoint namespace .
*
* @ var string
*/
protected $namespace = 'wc/v1' ;
/**
* Route base .
*
* @ var string
*/
protected $rest_base = 'products/attributes' ;
/**
* Attribute name .
*
* @ var string
*/
protected $attribute = '' ;
/**
* Register the routes for product attributes .
*/
public function register_routes () {
register_rest_route ( $this -> namespace , '/' . $this -> rest_base , array (
array (
'methods' => WP_REST_Server :: READABLE ,
'callback' => array ( $this , 'get_items' ),
'permission_callback' => array ( $this , 'get_items_permissions_check' ),
'args' => $this -> get_collection_params (),
),
array (
'methods' => WP_REST_Server :: CREATABLE ,
'callback' => array ( $this , 'create_item' ),
'permission_callback' => array ( $this , 'create_item_permissions_check' ),
'args' => array_merge ( $this -> get_endpoint_args_for_item_schema ( WP_REST_Server :: CREATABLE ), array (
'name' => array (
2020-08-06 12:48:18 +00:00
'description' => __ ( 'Name for the resource.' , 'woocommerce' ),
2019-05-10 16:56:07 +00:00
'type' => 'string' ,
'required' => true ,
),
) ),
),
'schema' => array ( $this , 'get_public_item_schema' ),
));
register_rest_route ( $this -> namespace , '/' . $this -> rest_base . '/(?P<id>[\d]+)' , array (
'args' => array (
'id' => array (
2020-08-06 12:48:18 +00:00
'description' => __ ( 'Unique identifier for the resource.' , 'woocommerce' ),
2019-05-10 16:56:07 +00:00
'type' => 'integer' ,
),
),
array (
'methods' => WP_REST_Server :: READABLE ,
'callback' => array ( $this , 'get_item' ),
'permission_callback' => array ( $this , 'get_item_permissions_check' ),
'args' => array (
'context' => $this -> get_context_param ( array ( 'default' => 'view' ) ),
),
),
array (
'methods' => WP_REST_Server :: EDITABLE ,
'callback' => array ( $this , 'update_item' ),
'permission_callback' => array ( $this , 'update_item_permissions_check' ),
'args' => $this -> get_endpoint_args_for_item_schema ( WP_REST_Server :: EDITABLE ),
),
array (
'methods' => WP_REST_Server :: DELETABLE ,
'callback' => array ( $this , 'delete_item' ),
'permission_callback' => array ( $this , 'delete_item_permissions_check' ),
'args' => array (
'force' => array (
'default' => true ,
'type' => 'boolean' ,
2020-08-06 12:48:18 +00:00
'description' => __ ( 'Required to be true, as resource does not support trashing.' , 'woocommerce' ),
2019-05-10 16:56:07 +00:00
),
),
),
'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 , 'batch_items_permissions_check' ),
'args' => $this -> get_endpoint_args_for_item_schema ( WP_REST_Server :: EDITABLE ),
),
'schema' => array ( $this , 'get_public_batch_schema' ),
) );
}
/**
* Check if a given request has access to read the attributes .
*
* @ param WP_REST_Request $request Full details about the request .
* @ return WP_Error | boolean
*/
public function get_items_permissions_check ( $request ) {
if ( ! wc_rest_check_manager_permissions ( 'attributes' , 'read' ) ) {
2020-08-06 12:48:18 +00:00
return new WP_Error ( 'woocommerce_rest_cannot_view' , __ ( 'Sorry, you cannot list resources.' , 'woocommerce' ), array ( 'status' => rest_authorization_required_code () ) );
2019-05-10 16:56:07 +00:00
}
return true ;
}
/**
* Check if a given request has access to create a attribute .
*
* @ param WP_REST_Request $request Full details about the request .
* @ return WP_Error | boolean
*/
public function create_item_permissions_check ( $request ) {
if ( ! wc_rest_check_manager_permissions ( 'attributes' , 'create' ) ) {
2020-08-06 12:48:18 +00:00
return new WP_Error ( 'woocommerce_rest_cannot_create' , __ ( 'Sorry, you cannot create new resource.' , 'woocommerce' ), array ( 'status' => rest_authorization_required_code () ) );
2019-05-10 16:56:07 +00:00
}
return true ;
}
/**
* Check if a given request has access to read a attribute .
*
* @ param WP_REST_Request $request Full details about the request .
* @ return WP_Error | boolean
*/
public function get_item_permissions_check ( $request ) {
if ( ! $this -> get_taxonomy ( $request ) ) {
2020-08-06 12:48:18 +00:00
return new WP_Error ( 'woocommerce_rest_taxonomy_invalid' , __ ( 'Resource does not exist.' , 'woocommerce' ), array ( 'status' => 404 ) );
2019-05-10 16:56:07 +00:00
}
if ( ! wc_rest_check_manager_permissions ( 'attributes' , 'read' ) ) {
2020-08-06 12:48:18 +00:00
return new WP_Error ( 'woocommerce_rest_cannot_view' , __ ( 'Sorry, you cannot view this resource.' , 'woocommerce' ), array ( 'status' => rest_authorization_required_code () ) );
2019-05-10 16:56:07 +00:00
}
return true ;
}
/**
* Check if a given request has access to update a attribute .
*
* @ param WP_REST_Request $request Full details about the request .
* @ return WP_Error | boolean
*/
public function update_item_permissions_check ( $request ) {
if ( ! $this -> get_taxonomy ( $request ) ) {
2020-08-06 12:48:18 +00:00
return new WP_Error ( 'woocommerce_rest_taxonomy_invalid' , __ ( 'Resource does not exist.' , 'woocommerce' ), array ( 'status' => 404 ) );
2019-05-10 16:56:07 +00:00
}
if ( ! wc_rest_check_manager_permissions ( 'attributes' , 'edit' ) ) {
2020-08-06 12:48:18 +00:00
return new WP_Error ( 'woocommerce_rest_cannot_update' , __ ( 'Sorry, you cannot update resource.' , 'woocommerce' ), array ( 'status' => rest_authorization_required_code () ) );
2019-05-10 16:56:07 +00:00
}
return true ;
}
/**
* Check if a given request has access to delete a attribute .
*
* @ param WP_REST_Request $request Full details about the request .
* @ return WP_Error | boolean
*/
public function delete_item_permissions_check ( $request ) {
if ( ! $this -> get_taxonomy ( $request ) ) {
2020-08-06 12:48:18 +00:00
return new WP_Error ( 'woocommerce_rest_taxonomy_invalid' , __ ( 'Resource does not exist.' , 'woocommerce' ), array ( 'status' => 404 ) );
2019-05-10 16:56:07 +00:00
}
if ( ! wc_rest_check_manager_permissions ( 'attributes' , 'delete' ) ) {
2020-08-06 12:48:18 +00:00
return new WP_Error ( 'woocommerce_rest_cannot_delete' , __ ( 'Sorry, you are not allowed to delete this resource.' , 'woocommerce' ), array ( 'status' => rest_authorization_required_code () ) );
2019-05-10 16:56:07 +00:00
}
return true ;
}
/**
* Check if a given request has access batch create , update and delete items .
*
* @ param WP_REST_Request $request Full details about the request .
*
* @ return bool | WP_Error
*/
public function batch_items_permissions_check ( $request ) {
if ( ! wc_rest_check_manager_permissions ( 'attributes' , 'batch' ) ) {
2020-08-06 12:48:18 +00:00
return new WP_Error ( 'woocommerce_rest_cannot_batch' , __ ( 'Sorry, you are not allowed to batch manipulate this resource.' , 'woocommerce' ), array ( 'status' => rest_authorization_required_code () ) );
2019-05-10 16:56:07 +00:00
}
return true ;
}
/**
* Get all attributes .
*
* @ param WP_REST_Request $request
* @ return array
*/
public function get_items ( $request ) {
$attributes = wc_get_attribute_taxonomies ();
$data = array ();
foreach ( $attributes as $attribute_obj ) {
$attribute = $this -> prepare_item_for_response ( $attribute_obj , $request );
$attribute = $this -> prepare_response_for_collection ( $attribute );
$data [] = $attribute ;
}
2020-04-17 18:56:27 +00:00
$response = rest_ensure_response ( $data );
// This API call always returns all product attributes due to retrieval from the object cache.
$response -> header ( 'X-WP-Total' , count ( $data ) );
$response -> header ( 'X-WP-TotalPages' , 1 );
return $response ;
2019-05-10 16:56:07 +00:00
}
/**
* Create a single attribute .
*
* @ param WP_REST_Request $request Full details about the request .
* @ return WP_REST_Request | WP_Error
*/
public function create_item ( $request ) {
global $wpdb ;
$id = wc_create_attribute ( array (
'name' => $request [ 'name' ],
'slug' => wc_sanitize_taxonomy_name ( stripslashes ( $request [ 'slug' ] ) ),
'type' => ! empty ( $request [ 'type' ] ) ? $request [ 'type' ] : 'select' ,
'order_by' => ! empty ( $request [ 'order_by' ] ) ? $request [ 'order_by' ] : 'menu_order' ,
'has_archives' => true === $request [ 'has_archives' ],
) );
// Checks for errors.
if ( is_wp_error ( $id ) ) {
return new WP_Error ( 'woocommerce_rest_cannot_create' , $id -> get_error_message (), array ( 'status' => 400 ) );
}
$attribute = $this -> get_attribute ( $id );
if ( is_wp_error ( $attribute ) ) {
return $attribute ;
}
$this -> update_additional_fields_for_object ( $attribute , $request );
/**
* Fires after a single product attribute is created or updated via the REST API .
*
* @ param stdObject $attribute Inserted attribute object .
* @ param WP_REST_Request $request Request object .
* @ param boolean $creating True when creating attribute , false when updating .
*/
do_action ( 'woocommerce_rest_insert_product_attribute' , $attribute , $request , true );
$request -> set_param ( 'context' , 'edit' );
$response = $this -> prepare_item_for_response ( $attribute , $request );
$response = rest_ensure_response ( $response );
$response -> set_status ( 201 );
$response -> header ( 'Location' , rest_url ( '/' . $this -> namespace . '/' . $this -> rest_base . '/' . $attribute -> attribute_id ) );
return $response ;
}
/**
* Get a single attribute .
*
* @ param WP_REST_Request $request Full details about the request .
* @ return WP_REST_Request | WP_Error
*/
public function get_item ( $request ) {
$attribute = $this -> get_attribute ( ( int ) $request [ 'id' ] );
if ( is_wp_error ( $attribute ) ) {
return $attribute ;
}
$response = $this -> prepare_item_for_response ( $attribute , $request );
return rest_ensure_response ( $response );
}
/**
* Update a single term from a taxonomy .
*
* @ param WP_REST_Request $request Full details about the request .
* @ return WP_REST_Request | WP_Error
*/
public function update_item ( $request ) {
global $wpdb ;
$id = ( int ) $request [ 'id' ];
$edited = wc_update_attribute ( $id , array (
'name' => $request [ 'name' ],
'slug' => wc_sanitize_taxonomy_name ( stripslashes ( $request [ 'slug' ] ) ),
'type' => $request [ 'type' ],
'order_by' => $request [ 'order_by' ],
'has_archives' => $request [ 'has_archives' ],
) );
// Checks for errors.
if ( is_wp_error ( $edited ) ) {
return new WP_Error ( 'woocommerce_rest_cannot_edit' , $edited -> get_error_message (), array ( 'status' => 400 ) );
}
$attribute = $this -> get_attribute ( $id );
if ( is_wp_error ( $attribute ) ) {
return $attribute ;
}
$this -> update_additional_fields_for_object ( $attribute , $request );
/**
* Fires after a single product attribute is created or updated via the REST API .
*
* @ param stdObject $attribute Inserted attribute object .
* @ param WP_REST_Request $request Request object .
* @ param boolean $creating True when creating attribute , false when updating .
*/
do_action ( 'woocommerce_rest_insert_product_attribute' , $attribute , $request , false );
$request -> set_param ( 'context' , 'edit' );
$response = $this -> prepare_item_for_response ( $attribute , $request );
return rest_ensure_response ( $response );
}
/**
* Delete a single attribute .
*
* @ param WP_REST_Request $request Full details about the request .
* @ return WP_REST_Response | WP_Error
*/
public function delete_item ( $request ) {
$force = isset ( $request [ 'force' ] ) ? ( bool ) $request [ 'force' ] : false ;
// We don't support trashing for this type, error out.
if ( ! $force ) {
2020-08-06 12:48:18 +00:00
return new WP_Error ( 'woocommerce_rest_trash_not_supported' , __ ( 'Resource does not support trashing.' , 'woocommerce' ), array ( 'status' => 501 ) );
2019-05-10 16:56:07 +00:00
}
$attribute = $this -> get_attribute ( ( int ) $request [ 'id' ] );
if ( is_wp_error ( $attribute ) ) {
return $attribute ;
}
$request -> set_param ( 'context' , 'edit' );
$response = $this -> prepare_item_for_response ( $attribute , $request );
$deleted = wc_delete_attribute ( $attribute -> attribute_id );
if ( false === $deleted ) {
2020-08-06 12:48:18 +00:00
return new WP_Error ( 'woocommerce_rest_cannot_delete' , __ ( 'The resource cannot be deleted.' , 'woocommerce' ), array ( 'status' => 500 ) );
2019-05-10 16:56:07 +00:00
}
/**
* Fires after a single attribute is deleted via the REST API .
*
* @ param stdObject $attribute The deleted attribute .
* @ param WP_REST_Response $response The response data .
* @ param WP_REST_Request $request The request sent to the API .
*/
do_action ( 'woocommerce_rest_delete_product_attribute' , $attribute , $response , $request );
return $response ;
}
/**
* Prepare a single product attribute output for response .
*
* @ param obj $item Term object .
* @ param WP_REST_Request $request
* @ return WP_REST_Response $response
*/
public function prepare_item_for_response ( $item , $request ) {
$data = array (
'id' => ( int ) $item -> attribute_id ,
'name' => $item -> attribute_label ,
'slug' => wc_attribute_taxonomy_name ( $item -> attribute_name ),
'type' => $item -> attribute_type ,
'order_by' => $item -> attribute_orderby ,
'has_archives' => ( bool ) $item -> attribute_public ,
);
$context = ! empty ( $request [ 'context' ] ) ? $request [ 'context' ] : 'view' ;
$data = $this -> add_additional_fields_to_object ( $data , $request );
$data = $this -> filter_response_by_context ( $data , $context );
$response = rest_ensure_response ( $data );
$response -> add_links ( $this -> prepare_links ( $item ) );
/**
* Filter a attribute item returned from the API .
*
* Allows modification of the product attribute data right before it is returned .
*
* @ param WP_REST_Response $response The response object .
* @ param object $item The original attribute object .
* @ param WP_REST_Request $request Request used to generate the response .
*/
return apply_filters ( 'woocommerce_rest_prepare_product_attribute' , $response , $item , $request );
}
/**
* Prepare links for the request .
*
* @ param object $attribute Attribute object .
* @ return array Links for the given attribute .
*/
protected function prepare_links ( $attribute ) {
$base = '/' . $this -> namespace . '/' . $this -> rest_base ;
$links = array (
'self' => array (
'href' => rest_url ( trailingslashit ( $base ) . $attribute -> attribute_id ),
),
'collection' => array (
'href' => rest_url ( $base ),
),
);
return $links ;
}
/**
* Get the Attribute ' s schema , conforming to JSON Schema .
*
* @ return array
*/
public function get_item_schema () {
$schema = array (
'$schema' => 'http://json-schema.org/draft-04/schema#' ,
'title' => 'product_attribute' ,
'type' => 'object' ,
'properties' => array (
'id' => array (
2020-08-06 12:48:18 +00:00
'description' => __ ( 'Unique identifier for the resource.' , 'woocommerce' ),
2019-05-10 16:56:07 +00:00
'type' => 'integer' ,
'context' => array ( 'view' , 'edit' ),
'readonly' => true ,
),
'name' => array (
2020-08-06 12:48:18 +00:00
'description' => __ ( 'Attribute name.' , 'woocommerce' ),
2019-05-10 16:56:07 +00:00
'type' => 'string' ,
'context' => array ( 'view' , 'edit' ),
'arg_options' => array (
'sanitize_callback' => 'sanitize_text_field' ,
),
),
'slug' => array (
2020-08-06 12:48:18 +00:00
'description' => __ ( 'An alphanumeric identifier for the resource unique to its type.' , 'woocommerce' ),
2019-05-10 16:56:07 +00:00
'type' => 'string' ,
'context' => array ( 'view' , 'edit' ),
'arg_options' => array (
'sanitize_callback' => 'sanitize_title' ,
),
),
'type' => array (
2020-08-06 12:48:18 +00:00
'description' => __ ( 'Type of attribute.' , 'woocommerce' ),
2019-05-10 16:56:07 +00:00
'type' => 'string' ,
'default' => 'select' ,
'enum' => array_keys ( wc_get_attribute_types () ),
'context' => array ( 'view' , 'edit' ),
),
'order_by' => array (
2020-08-06 12:48:18 +00:00
'description' => __ ( 'Default sort order.' , 'woocommerce' ),
2019-05-10 16:56:07 +00:00
'type' => 'string' ,
'default' => 'menu_order' ,
'enum' => array ( 'menu_order' , 'name' , 'name_num' , 'id' ),
'context' => array ( 'view' , 'edit' ),
),
'has_archives' => array (
2020-08-06 12:48:18 +00:00
'description' => __ ( 'Enable/Disable attribute archives.' , 'woocommerce' ),
2019-05-10 16:56:07 +00:00
'type' => 'boolean' ,
'default' => false ,
'context' => array ( 'view' , 'edit' ),
),
),
);
return $this -> add_additional_fields_schema ( $schema );
}
/**
* Get the query params for collections
*
* @ return array
*/
public function get_collection_params () {
$params = array ();
$params [ 'context' ] = $this -> get_context_param ( array ( 'default' => 'view' ) );
return $params ;
}
/**
* Get attribute name .
*
* @ param WP_REST_Request $request Full details about the request .
* @ return string
*/
protected function get_taxonomy ( $request ) {
if ( '' !== $this -> attribute ) {
return $this -> attribute ;
}
if ( $request [ 'id' ] ) {
$name = wc_attribute_taxonomy_name_by_id ( ( int ) $request [ 'id' ] );
$this -> attribute = $name ;
}
return $this -> attribute ;
}
/**
* Get attribute data .
*
* @ param int $id Attribute ID .
* @ return stdClass | WP_Error
*/
protected function get_attribute ( $id ) {
global $wpdb ;
$attribute = $wpdb -> get_row ( $wpdb -> prepare ( "
SELECT *
FROM { $wpdb -> prefix } woocommerce_attribute_taxonomies
WHERE attribute_id = % d
" , $id ) );
if ( is_wp_error ( $attribute ) || is_null ( $attribute ) ) {
2020-08-06 12:48:18 +00:00
return new WP_Error ( 'woocommerce_rest_attribute_invalid' , __ ( 'Resource does not exist.' , 'woocommerce' ), array ( 'status' => 404 ) );
2019-05-10 16:56:07 +00:00
}
return $attribute ;
}
/**
* Validate attribute slug .
*
* @ deprecated 3.2 . 0
* @ param string $slug
* @ param bool $new_data
* @ return bool | WP_Error
*/
protected function validate_attribute_slug ( $slug , $new_data = true ) {
if ( strlen ( $slug ) >= 28 ) {
2020-08-06 12:48:18 +00:00
return new WP_Error ( 'woocommerce_rest_invalid_product_attribute_slug_too_long' , sprintf ( __ ( 'Slug "%s" is too long (28 characters max). Shorten it, please.' , 'woocommerce' ), $slug ), array ( 'status' => 400 ) );
2019-05-10 16:56:07 +00:00
} elseif ( wc_check_if_attribute_name_is_reserved ( $slug ) ) {
2020-08-06 12:48:18 +00:00
return new WP_Error ( 'woocommerce_rest_invalid_product_attribute_slug_reserved_name' , sprintf ( __ ( 'Slug "%s" is not allowed because it is a reserved term. Change it, please.' , 'woocommerce' ), $slug ), array ( 'status' => 400 ) );
2019-05-10 16:56:07 +00:00
} elseif ( $new_data && taxonomy_exists ( wc_attribute_taxonomy_name ( $slug ) ) ) {
2020-08-06 12:48:18 +00:00
return new WP_Error ( 'woocommerce_rest_invalid_product_attribute_slug_already_exists' , sprintf ( __ ( 'Slug "%s" is already in use. Change it, please.' , 'woocommerce' ), $slug ), array ( 'status' => 400 ) );
2019-05-10 16:56:07 +00:00
}
return true ;
}
/**
* Schedule to flush rewrite rules .
*
* @ deprecated 3.2 . 0
* @ since 3.0 . 0
*/
protected function flush_rewrite_rules () {
wp_schedule_single_event ( time (), 'woocommerce_flush_rewrite_rules' );
}
}
