woocommerce/includes/api/class-wc-rest-product-shipp...

141 lines
3.9 KiB
PHP
Raw Normal View History

2016-02-17 19:29:09 +00:00
<?php
/**
* REST API Product Shipping Classes controller
*
* Handles requests to the products/shipping_classes endpoint.
*
* @author WooThemes
* @category API
* @package WooCommerce/API
* @since 2.6.0
*/
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
/**
* REST API Product Shipping Classes controller class.
*
* @package WooCommerce/API
* @extends WC_REST_Terms_Controller
2016-02-17 19:29:09 +00:00
*/
class WC_REST_Product_Shipping_Classes_Controller extends WC_REST_Terms_Controller {
2016-02-17 19:29:09 +00:00
/**
* Endpoint namespace.
*
* @var string
*/
protected $namespace = 'wc/v1';
/**
2016-02-17 19:29:09 +00:00
* Route base.
*
* @var string
*/
2016-02-22 18:49:38 +00:00
protected $rest_base = 'products/shipping_classes';
2016-02-17 19:29:09 +00:00
/**
2016-03-02 23:30:54 +00:00
* Taxonomy.
2016-02-17 19:29:09 +00:00
*
* @var string
*/
2016-03-02 23:30:54 +00:00
protected $taxonomy = 'product_shipping_class';
2016-02-17 19:29:09 +00:00
/**
2016-03-02 23:30:54 +00:00
* Prepare a single product shipping class 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->term_id,
'name' => $item->name,
'slug' => $item->slug,
'parent' => (int) $item->parent,
'description' => $item->description,
'count' => (int) $item->count,
);
$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 );
2016-03-07 20:28:52 +00:00
$response->add_links( $this->prepare_links( $item, $request ) );
2016-03-02 23:30:54 +00:00
/**
* Filter a term item returned from the API.
*
* Allows modification of the term data right before it is returned.
*
* @param WP_REST_Response $response The response object.
* @param object $item The original term object.
* @param WP_REST_Request $request Request used to generate the response.
*/
return apply_filters( "woocommerce_rest_prepare_{$this->taxonomy}", $response, $item, $request );
}
/**
2016-03-10 00:34:14 +00:00
* Get the Shipping Class schema, conforming to JSON Schema.
2016-03-02 23:30:54 +00:00
*
* @return array
2016-02-17 19:29:09 +00:00
*/
2016-03-02 23:30:54 +00:00
public function get_item_schema() {
$schema = array(
'$schema' => 'http://json-schema.org/draft-04/schema#',
'title' => $this->taxonomy,
'type' => 'object',
'properties' => array(
'id' => array(
'description' => __( 'Unique identifier for the resource.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
'readonly' => true,
),
'name' => array(
'description' => __( 'Shipping class name.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'arg_options' => array(
'sanitize_callback' => 'sanitize_text_field',
),
),
'slug' => array(
'description' => __( 'An alphanumeric identifier for the resource unique to its type.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'arg_options' => array(
'sanitize_callback' => 'sanitize_title',
),
),
'parent' => array(
'description' => __( 'The id for the parent of the resource.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
),
'description' => array(
'description' => __( 'HTML description of the resource.', 'woocommerce' ),
'type' => 'string',
'context' => array( 'view', 'edit' ),
'arg_options' => array(
'sanitize_callback' => 'wp_filter_post_kses',
),
),
'count' => array(
'description' => __( 'Number of published products for the resource.', 'woocommerce' ),
'type' => 'integer',
'context' => array( 'view', 'edit', 'woocommerce' ),
'readonly' => true,
),
),
);
2016-02-17 19:29:09 +00:00
2016-03-02 23:30:54 +00:00
return $this->add_additional_fields_schema( $schema );
2016-02-17 19:29:09 +00:00
}
}