Revised schema handling
This commit is contained in:
Mike Jolley
parent
aa41b1ffd5
commit
2b3c870884
|
|
@ -11,7 +11,8 @@ namespace WooCommerce\RestApi\Controllers\Version4;
|
|||
|
||||
defined( 'ABSPATH' ) || exit;
|
||||
|
||||
use WooCommerce\RestApi\Controllers\Version4\Schema\ProductVariationSchema;
|
||||
use WooCommerce\RestApi\Controllers\Version4\Schema\ProductVariationRequest;
|
||||
use WooCommerce\RestApi\Controllers\Version4\Schema\ProductVariationResponse;
|
||||
|
||||
/**
|
||||
* REST API variations controller class.
|
||||
|
|
@ -138,7 +139,376 @@ class ProductVariations extends Products {
|
|||
* @return array
|
||||
*/
|
||||
public function get_item_schema() {
|
||||
$schema = ProductVariationSchema::get_schema();
|
||||
$weight_unit = get_option( 'woocommerce_weight_unit' );
|
||||
$dimension_unit = get_option( 'woocommerce_dimension_unit' );
|
||||
$schema = array(
|
||||
'$schema' => 'http://json-schema.org/draft-04/schema#',
|
||||
'title' => 'product_variation',
|
||||
'type' => 'object',
|
||||
'properties' => array(
|
||||
'id' => array(
|
||||
'description' => __( 'Unique identifier for the resource.', 'woocommerce' ),
|
||||
'type' => 'integer',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
'name' => array(
|
||||
'description' => __( 'Product parent name.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'type' => array(
|
||||
'description' => __( 'Product type.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'default' => 'variation',
|
||||
'enum' => array( 'variation' ),
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'parent_id' => array(
|
||||
'description' => __( 'Product parent ID.', 'woocommerce' ),
|
||||
'type' => 'integer',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'date_created' => array(
|
||||
'description' => __( "The date the variation was created, in the site's timezone.", 'woocommerce' ),
|
||||
'type' => 'date-time',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
'date_modified' => array(
|
||||
'description' => __( "The date the variation was last modified, in the site's timezone.", 'woocommerce' ),
|
||||
'type' => 'date-time',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
'description' => array(
|
||||
'description' => __( 'Variation description.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'arg_options' => array(
|
||||
'sanitize_callback' => 'wp_filter_post_kses',
|
||||
),
|
||||
),
|
||||
'permalink' => array(
|
||||
'description' => __( 'Variation URL.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'format' => 'uri',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
'sku' => array(
|
||||
'description' => __( 'Unique identifier.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'arg_options' => array(
|
||||
'sanitize_callback' => 'wc_clean',
|
||||
),
|
||||
),
|
||||
'price' => array(
|
||||
'description' => __( 'Current variation price.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
'regular_price' => array(
|
||||
'description' => __( 'Variation regular price.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'sale_price' => array(
|
||||
'description' => __( 'Variation sale price.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'date_on_sale_from' => array(
|
||||
'description' => __( "Start date of sale price, in the site's timezone.", 'woocommerce' ),
|
||||
'type' => 'date-time',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'date_on_sale_from_gmt' => array(
|
||||
'description' => __( 'Start date of sale price, as GMT.', 'woocommerce' ),
|
||||
'type' => 'date-time',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'date_on_sale_to' => array(
|
||||
'description' => __( "End date of sale price, in the site's timezone.", 'woocommerce' ),
|
||||
'type' => 'date-time',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'date_on_sale_to_gmt' => array(
|
||||
'description' => __( "End date of sale price, in the site's timezone.", 'woocommerce' ),
|
||||
'type' => 'date-time',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'on_sale' => array(
|
||||
'description' => __( 'Shows if the variation is on sale.', 'woocommerce' ),
|
||||
'type' => 'boolean',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
'status' => array(
|
||||
'description' => __( 'Variation status.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'default' => 'publish',
|
||||
'enum' => array_keys( get_post_statuses() ),
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'purchasable' => array(
|
||||
'description' => __( 'Shows if the variation can be bought.', 'woocommerce' ),
|
||||
'type' => 'boolean',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
'virtual' => array(
|
||||
'description' => __( 'If the variation is virtual.', 'woocommerce' ),
|
||||
'type' => 'boolean',
|
||||
'default' => false,
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'downloadable' => array(
|
||||
'description' => __( 'If the variation is downloadable.', 'woocommerce' ),
|
||||
'type' => 'boolean',
|
||||
'default' => false,
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'downloads' => array(
|
||||
'description' => __( 'List of downloadable files.', 'woocommerce' ),
|
||||
'type' => 'array',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'items' => array(
|
||||
'type' => 'object',
|
||||
'properties' => array(
|
||||
'id' => array(
|
||||
'description' => __( 'File ID.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'name' => array(
|
||||
'description' => __( 'File name.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'file' => array(
|
||||
'description' => __( 'File URL.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
),
|
||||
),
|
||||
),
|
||||
'download_limit' => array(
|
||||
'description' => __( 'Number of times downloadable files can be downloaded after purchase.', 'woocommerce' ),
|
||||
'type' => 'integer',
|
||||
'default' => -1,
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'download_expiry' => array(
|
||||
'description' => __( 'Number of days until access to downloadable files expires.', 'woocommerce' ),
|
||||
'type' => 'integer',
|
||||
'default' => -1,
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'tax_status' => array(
|
||||
'description' => __( 'Tax status.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'default' => 'taxable',
|
||||
'enum' => array( 'taxable', 'shipping', 'none' ),
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'tax_class' => array(
|
||||
'description' => __( 'Tax class.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'manage_stock' => array(
|
||||
'description' => __( 'Stock management at variation level.', 'woocommerce' ),
|
||||
'type' => 'boolean',
|
||||
'default' => false,
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'stock_quantity' => array(
|
||||
'description' => __( 'Stock quantity.', 'woocommerce' ),
|
||||
'type' => 'integer',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'stock_status' => array(
|
||||
'description' => __( 'Controls the stock status of the product.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'default' => 'instock',
|
||||
'enum' => array_keys( wc_get_product_stock_status_options() ),
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'backorders' => array(
|
||||
'description' => __( 'If managing stock, this controls if backorders are allowed.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'default' => 'no',
|
||||
'enum' => array( 'no', 'notify', 'yes' ),
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'backorders_allowed' => array(
|
||||
'description' => __( 'Shows if backorders are allowed.', 'woocommerce' ),
|
||||
'type' => 'boolean',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
'backordered' => array(
|
||||
'description' => __( 'Shows if the variation is on backordered.', 'woocommerce' ),
|
||||
'type' => 'boolean',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
'weight' => array(
|
||||
/* translators: %s: weight unit */
|
||||
'description' => sprintf( __( 'Variation weight (%s).', 'woocommerce' ), $weight_unit ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'dimensions' => array(
|
||||
'description' => __( 'Variation dimensions.', 'woocommerce' ),
|
||||
'type' => 'object',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'properties' => array(
|
||||
'length' => array(
|
||||
/* translators: %s: dimension unit */
|
||||
'description' => sprintf( __( 'Variation length (%s).', 'woocommerce' ), $dimension_unit ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'width' => array(
|
||||
/* translators: %s: dimension unit */
|
||||
'description' => sprintf( __( 'Variation width (%s).', 'woocommerce' ), $dimension_unit ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'height' => array(
|
||||
/* translators: %s: dimension unit */
|
||||
'description' => sprintf( __( 'Variation height (%s).', 'woocommerce' ), $dimension_unit ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
),
|
||||
),
|
||||
'shipping_class' => array(
|
||||
'description' => __( 'Shipping class slug.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'shipping_class_id' => array(
|
||||
'description' => __( 'Shipping class ID.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
'image' => array(
|
||||
'description' => __( 'Variation image data.', 'woocommerce' ),
|
||||
'type' => 'object',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'properties' => array(
|
||||
'id' => array(
|
||||
'description' => __( 'Image ID.', 'woocommerce' ),
|
||||
'type' => 'integer',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'date_created' => array(
|
||||
'description' => __( "The date the image was created, in the site's timezone.", 'woocommerce' ),
|
||||
'type' => 'date-time',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
'date_created_gmt' => array(
|
||||
'description' => __( 'The date the image was created, as GMT.', 'woocommerce' ),
|
||||
'type' => 'date-time',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
'date_modified' => array(
|
||||
'description' => __( "The date the image was last modified, in the site's timezone.", 'woocommerce' ),
|
||||
'type' => 'date-time',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
'date_modified_gmt' => array(
|
||||
'description' => __( 'The date the image was last modified, as GMT.', 'woocommerce' ),
|
||||
'type' => 'date-time',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
'src' => array(
|
||||
'description' => __( 'Image URL.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'format' => 'uri',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'name' => array(
|
||||
'description' => __( 'Image name.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'alt' => array(
|
||||
'description' => __( 'Image alternative text.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
),
|
||||
),
|
||||
'attributes' => array(
|
||||
'description' => __( 'List of attributes.', 'woocommerce' ),
|
||||
'type' => 'array',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'items' => array(
|
||||
'type' => 'object',
|
||||
'properties' => array(
|
||||
'id' => array(
|
||||
'description' => __( 'Attribute ID.', 'woocommerce' ),
|
||||
'type' => 'integer',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'name' => array(
|
||||
'description' => __( 'Attribute name.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'option' => array(
|
||||
'description' => __( 'Selected attribute term name.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
),
|
||||
),
|
||||
),
|
||||
'menu_order' => array(
|
||||
'description' => __( 'Menu order, used to custom sort products.', 'woocommerce' ),
|
||||
'type' => 'integer',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'meta_data' => array(
|
||||
'description' => __( 'Meta data.', 'woocommerce' ),
|
||||
'type' => 'array',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'items' => array(
|
||||
'type' => 'object',
|
||||
'properties' => array(
|
||||
'id' => array(
|
||||
'description' => __( 'Meta ID.', 'woocommerce' ),
|
||||
'type' => 'integer',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
'key' => array(
|
||||
'description' => __( 'Meta key.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'value' => array(
|
||||
'description' => __( 'Meta value.', 'woocommerce' ),
|
||||
'type' => 'mixed',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
),
|
||||
),
|
||||
),
|
||||
),
|
||||
);
|
||||
return $this->add_additional_fields_schema( $schema );
|
||||
}
|
||||
|
||||
|
|
@ -218,11 +588,12 @@ class ProductVariations extends Products {
|
|||
* @return \WP_REST_Response
|
||||
*/
|
||||
public function prepare_object_for_response( $object, $request ) {
|
||||
$context = ! empty( $request['context'] ) ? $request['context'] : 'view';
|
||||
$data = ProductVariationSchema::object_to_schema( $object, $context );
|
||||
$data = $this->add_additional_fields_to_object( $data, $request );
|
||||
$data = $this->filter_response_by_context( $data, $context );
|
||||
$response = rest_ensure_response( $data );
|
||||
$context = ! empty( $request['context'] ) ? $request['context'] : 'view';
|
||||
$variation_response = new ProductVariationResponse();
|
||||
$data = $variation_response->prepare_response( $object, $context );
|
||||
$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( $object, $request ) );
|
||||
|
||||
/**
|
||||
|
|
@ -312,7 +683,12 @@ class ProductVariations extends Products {
|
|||
* @return \WP_Error|\WC_Data
|
||||
*/
|
||||
protected function prepare_object_for_database( $request, $creating = false ) {
|
||||
$variation = ProductVariationSchema::schema_to_object( $request );
|
||||
try {
|
||||
$variation_request = new ProductVariationRequest( $request );
|
||||
$variation = $variation_request->prepare_object();
|
||||
} catch ( \WC_REST_Exception $e ) {
|
||||
return new \WP_Error( $e->getErrorCode(), $e->getMessage(), array( 'status' => $e->getCode() ) );
|
||||
}
|
||||
|
||||
/**
|
||||
* Filters an object before it is inserted via the REST API.
|
||||
|
|
|
|||
|
|
@ -11,7 +11,8 @@ namespace WooCommerce\RestApi\Controllers\Version4;
|
|||
|
||||
defined( 'ABSPATH' ) || exit;
|
||||
|
||||
use WooCommerce\RestApi\Controllers\Version4\Schema\ProductSchema;
|
||||
use WooCommerce\RestApi\Controllers\Version4\Schema\ProductRequest;
|
||||
use WooCommerce\RestApi\Controllers\Version4\Schema\ProductResponse;
|
||||
|
||||
/**
|
||||
* REST API Products controller class.
|
||||
|
|
@ -45,7 +46,629 @@ class Products extends AbstractObjectsController {
|
|||
* @return array
|
||||
*/
|
||||
public function get_item_schema() {
|
||||
return $this->add_additional_fields_schema( ProductSchema::get_schema() );
|
||||
$weight_unit = get_option( 'woocommerce_weight_unit' );
|
||||
$dimension_unit = get_option( 'woocommerce_dimension_unit' );
|
||||
$schema = array(
|
||||
'$schema' => 'http://json-schema.org/draft-04/schema#',
|
||||
'title' => 'product',
|
||||
'type' => 'object',
|
||||
'properties' => array(
|
||||
'id' => array(
|
||||
'description' => __( 'Unique identifier for the resource.', 'woocommerce' ),
|
||||
'type' => 'integer',
|
||||
'context' => array( 'view', 'edit', 'embed' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
'name' => array(
|
||||
'description' => __( 'Product name.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit', 'embed' ),
|
||||
'arg_options' => array(
|
||||
'sanitize_callback' => 'wp_filter_post_kses',
|
||||
),
|
||||
),
|
||||
'slug' => array(
|
||||
'description' => __( 'Product slug.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit', 'embed' ),
|
||||
),
|
||||
'permalink' => array(
|
||||
'description' => __( 'Product URL.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'format' => 'uri',
|
||||
'context' => array( 'view', 'edit', 'embed' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
'date_created' => array(
|
||||
'description' => __( "The date the product was created, in the site's timezone.", 'woocommerce' ),
|
||||
'type' => 'date-time',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'date_created_gmt' => array(
|
||||
'description' => __( 'The date the product was created, as GMT.', 'woocommerce' ),
|
||||
'type' => 'date-time',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'date_modified' => array(
|
||||
'description' => __( "The date the product was last modified, in the site's timezone.", 'woocommerce' ),
|
||||
'type' => 'date-time',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
'date_modified_gmt' => array(
|
||||
'description' => __( 'The date the product was last modified, as GMT.', 'woocommerce' ),
|
||||
'type' => 'date-time',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
'type' => array(
|
||||
'description' => __( 'Product type.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'default' => 'simple',
|
||||
'enum' => array_keys( wc_get_product_types() ),
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'status' => array(
|
||||
'description' => __( 'Product status (post status).', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'default' => 'publish',
|
||||
'enum' => array_merge( array_keys( get_post_statuses() ), array( 'future' ) ),
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'featured' => array(
|
||||
'description' => __( 'Featured product.', 'woocommerce' ),
|
||||
'type' => 'boolean',
|
||||
'default' => false,
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'catalog_visibility' => array(
|
||||
'description' => __( 'Catalog visibility.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'default' => 'visible',
|
||||
'enum' => array( 'visible', 'catalog', 'search', 'hidden' ),
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'description' => array(
|
||||
'description' => __( 'Product description.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit', 'embed' ),
|
||||
'arg_options' => array(
|
||||
'sanitize_callback' => 'wp_filter_post_kses',
|
||||
),
|
||||
),
|
||||
'short_description' => array(
|
||||
'description' => __( 'Product short description.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit', 'embed' ),
|
||||
'arg_options' => array(
|
||||
'sanitize_callback' => 'wp_filter_post_kses',
|
||||
),
|
||||
),
|
||||
'sku' => array(
|
||||
'description' => __( 'Unique identifier.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'arg_options' => array(
|
||||
'sanitize_callback' => 'wc_clean',
|
||||
),
|
||||
),
|
||||
'price' => array(
|
||||
'description' => __( 'Current product price.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
'regular_price' => array(
|
||||
'description' => __( 'Product regular price.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'sale_price' => array(
|
||||
'description' => __( 'Product sale price.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'date_on_sale_from' => array(
|
||||
'description' => __( "Start date of sale price, in the site's timezone.", 'woocommerce' ),
|
||||
'type' => 'date-time',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'date_on_sale_from_gmt' => array(
|
||||
'description' => __( 'Start date of sale price, as GMT.', 'woocommerce' ),
|
||||
'type' => 'date-time',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'date_on_sale_to' => array(
|
||||
'description' => __( "End date of sale price, in the site's timezone.", 'woocommerce' ),
|
||||
'type' => 'date-time',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'date_on_sale_to_gmt' => array(
|
||||
'description' => __( "End date of sale price, in the site's timezone.", 'woocommerce' ),
|
||||
'type' => 'date-time',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'price_html' => array(
|
||||
'description' => __( 'Price formatted in HTML.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
'on_sale' => array(
|
||||
'description' => __( 'Shows if the product is on sale.', 'woocommerce' ),
|
||||
'type' => 'boolean',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
'purchasable' => array(
|
||||
'description' => __( 'Shows if the product can be bought.', 'woocommerce' ),
|
||||
'type' => 'boolean',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
'total_sales' => array(
|
||||
'description' => __( 'Amount of sales.', 'woocommerce' ),
|
||||
'type' => 'integer',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
'virtual' => array(
|
||||
'description' => __( 'If the product is virtual.', 'woocommerce' ),
|
||||
'type' => 'boolean',
|
||||
'default' => false,
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'downloadable' => array(
|
||||
'description' => __( 'If the product is downloadable.', 'woocommerce' ),
|
||||
'type' => 'boolean',
|
||||
'default' => false,
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'downloads' => array(
|
||||
'description' => __( 'List of downloadable files.', 'woocommerce' ),
|
||||
'type' => 'array',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'items' => array(
|
||||
'type' => 'object',
|
||||
'properties' => array(
|
||||
'id' => array(
|
||||
'description' => __( 'File ID.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'name' => array(
|
||||
'description' => __( 'File name.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'file' => array(
|
||||
'description' => __( 'File URL.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
),
|
||||
),
|
||||
),
|
||||
'download_limit' => array(
|
||||
'description' => __( 'Number of times downloadable files can be downloaded after purchase.', 'woocommerce' ),
|
||||
'type' => 'integer',
|
||||
'default' => -1,
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'download_expiry' => array(
|
||||
'description' => __( 'Number of days until access to downloadable files expires.', 'woocommerce' ),
|
||||
'type' => 'integer',
|
||||
'default' => -1,
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'external_url' => array(
|
||||
'description' => __( 'Product external URL. Only for external products.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'format' => 'uri',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'button_text' => array(
|
||||
'description' => __( 'Product external button text. Only for external products.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'tax_status' => array(
|
||||
'description' => __( 'Tax status.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'default' => 'taxable',
|
||||
'enum' => array( 'taxable', 'shipping', 'none' ),
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'tax_class' => array(
|
||||
'description' => __( 'Tax class.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'manage_stock' => array(
|
||||
'description' => __( 'Stock management at product level.', 'woocommerce' ),
|
||||
'type' => 'boolean',
|
||||
'default' => false,
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'stock_quantity' => array(
|
||||
'description' => __( 'Stock quantity.', 'woocommerce' ),
|
||||
'type' => 'integer',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'stock_status' => array(
|
||||
'description' => __( 'Controls the stock status of the product.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'default' => 'instock',
|
||||
'enum' => array_keys( wc_get_product_stock_status_options() ),
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'backorders' => array(
|
||||
'description' => __( 'If managing stock, this controls if backorders are allowed.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'default' => 'no',
|
||||
'enum' => array( 'no', 'notify', 'yes' ),
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'backorders_allowed' => array(
|
||||
'description' => __( 'Shows if backorders are allowed.', 'woocommerce' ),
|
||||
'type' => 'boolean',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
'backordered' => array(
|
||||
'description' => __( 'Shows if the product is on backordered.', 'woocommerce' ),
|
||||
'type' => 'boolean',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
'sold_individually' => array(
|
||||
'description' => __( 'Allow one item to be bought in a single order.', 'woocommerce' ),
|
||||
'type' => 'boolean',
|
||||
'default' => false,
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'weight' => array(
|
||||
/* translators: %s: weight unit */
|
||||
'description' => sprintf( __( 'Product weight (%s).', 'woocommerce' ), $weight_unit ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'dimensions' => array(
|
||||
'description' => __( 'Product dimensions.', 'woocommerce' ),
|
||||
'type' => 'object',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'properties' => array(
|
||||
'length' => array(
|
||||
/* translators: %s: dimension unit */
|
||||
'description' => sprintf( __( 'Product length (%s).', 'woocommerce' ), $dimension_unit ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'width' => array(
|
||||
/* translators: %s: dimension unit */
|
||||
'description' => sprintf( __( 'Product width (%s).', 'woocommerce' ), $dimension_unit ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'height' => array(
|
||||
/* translators: %s: dimension unit */
|
||||
'description' => sprintf( __( 'Product height (%s).', 'woocommerce' ), $dimension_unit ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
),
|
||||
),
|
||||
'shipping_required' => array(
|
||||
'description' => __( 'Shows if the product need to be shipped.', 'woocommerce' ),
|
||||
'type' => 'boolean',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
'shipping_taxable' => array(
|
||||
'description' => __( 'Shows whether or not the product shipping is taxable.', 'woocommerce' ),
|
||||
'type' => 'boolean',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
'shipping_class' => array(
|
||||
'description' => __( 'Shipping class slug.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'shipping_class_id' => array(
|
||||
'description' => __( 'Shipping class ID.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
'reviews_allowed' => array(
|
||||
'description' => __( 'Allow reviews.', 'woocommerce' ),
|
||||
'type' => 'boolean',
|
||||
'default' => true,
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'average_rating' => array(
|
||||
'description' => __( 'Reviews average rating.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
'rating_count' => array(
|
||||
'description' => __( 'Amount of reviews that the product have.', 'woocommerce' ),
|
||||
'type' => 'integer',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
'related_ids' => array(
|
||||
'description' => __( 'List of related products IDs.', 'woocommerce' ),
|
||||
'type' => 'array',
|
||||
'items' => array(
|
||||
'type' => 'integer',
|
||||
),
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
'upsell_ids' => array(
|
||||
'description' => __( 'List of up-sell products IDs.', 'woocommerce' ),
|
||||
'type' => 'array',
|
||||
'items' => array(
|
||||
'type' => 'integer',
|
||||
),
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'cross_sell_ids' => array(
|
||||
'description' => __( 'List of cross-sell products IDs.', 'woocommerce' ),
|
||||
'type' => 'array',
|
||||
'items' => array(
|
||||
'type' => 'integer',
|
||||
),
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'parent_id' => array(
|
||||
'description' => __( 'Product parent ID.', 'woocommerce' ),
|
||||
'type' => 'integer',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'purchase_note' => array(
|
||||
'description' => __( 'Optional note to send the customer after purchase.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'arg_options' => array(
|
||||
'sanitize_callback' => 'wp_kses_post',
|
||||
),
|
||||
),
|
||||
'categories' => array(
|
||||
'description' => __( 'List of categories.', 'woocommerce' ),
|
||||
'type' => 'array',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'items' => array(
|
||||
'type' => 'object',
|
||||
'properties' => array(
|
||||
'id' => array(
|
||||
'description' => __( 'Category ID.', 'woocommerce' ),
|
||||
'type' => 'integer',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'name' => array(
|
||||
'description' => __( 'Category name.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
'slug' => array(
|
||||
'description' => __( 'Category slug.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
),
|
||||
),
|
||||
),
|
||||
'tags' => array(
|
||||
'description' => __( 'List of tags.', 'woocommerce' ),
|
||||
'type' => 'array',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'items' => array(
|
||||
'type' => 'object',
|
||||
'properties' => array(
|
||||
'id' => array(
|
||||
'description' => __( 'Tag ID.', 'woocommerce' ),
|
||||
'type' => 'integer',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'name' => array(
|
||||
'description' => __( 'Tag name.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
'slug' => array(
|
||||
'description' => __( 'Tag slug.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
),
|
||||
),
|
||||
),
|
||||
'images' => array(
|
||||
'description' => __( 'List of images.', 'woocommerce' ),
|
||||
'type' => 'object',
|
||||
'context' => array( 'view', 'edit', 'embed' ),
|
||||
'items' => array(
|
||||
'type' => 'object',
|
||||
'properties' => array(
|
||||
'id' => array(
|
||||
'description' => __( 'Image ID.', 'woocommerce' ),
|
||||
'type' => 'integer',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'date_created' => array(
|
||||
'description' => __( "The date the image was created, in the site's timezone.", 'woocommerce' ),
|
||||
'type' => 'date-time',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
'date_created_gmt' => array(
|
||||
'description' => __( 'The date the image was created, as GMT.', 'woocommerce' ),
|
||||
'type' => 'date-time',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
'date_modified' => array(
|
||||
'description' => __( "The date the image was last modified, in the site's timezone.", 'woocommerce' ),
|
||||
'type' => 'date-time',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
'date_modified_gmt' => array(
|
||||
'description' => __( 'The date the image was last modified, as GMT.', 'woocommerce' ),
|
||||
'type' => 'date-time',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
'src' => array(
|
||||
'description' => __( 'Image URL.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'format' => 'uri',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'name' => array(
|
||||
'description' => __( 'Image name.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'alt' => array(
|
||||
'description' => __( 'Image alternative text.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
),
|
||||
),
|
||||
),
|
||||
'attributes' => array(
|
||||
'description' => __( 'List of attributes.', 'woocommerce' ),
|
||||
'type' => 'array',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'items' => array(
|
||||
'type' => 'object',
|
||||
'properties' => array(
|
||||
'id' => array(
|
||||
'description' => __( 'Attribute ID.', 'woocommerce' ),
|
||||
'type' => 'integer',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'name' => array(
|
||||
'description' => __( 'Attribute name.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'position' => array(
|
||||
'description' => __( 'Attribute position.', 'woocommerce' ),
|
||||
'type' => 'integer',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'visible' => array(
|
||||
'description' => __( "Define if the attribute is visible on the \"Additional information\" tab in the product's page.", 'woocommerce' ),
|
||||
'type' => 'boolean',
|
||||
'default' => false,
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'variation' => array(
|
||||
'description' => __( 'Define if the attribute can be used as variation.', 'woocommerce' ),
|
||||
'type' => 'boolean',
|
||||
'default' => false,
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'options' => array(
|
||||
'description' => __( 'List of available term names of the attribute.', 'woocommerce' ),
|
||||
'type' => 'array',
|
||||
'items' => array(
|
||||
'type' => 'string',
|
||||
),
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
),
|
||||
),
|
||||
),
|
||||
'default_attributes' => array(
|
||||
'description' => __( 'Defaults variation attributes.', 'woocommerce' ),
|
||||
'type' => 'array',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'items' => array(
|
||||
'type' => 'object',
|
||||
'properties' => array(
|
||||
'id' => array(
|
||||
'description' => __( 'Attribute ID.', 'woocommerce' ),
|
||||
'type' => 'integer',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'name' => array(
|
||||
'description' => __( 'Attribute name.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'option' => array(
|
||||
'description' => __( 'Selected attribute term name.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
),
|
||||
),
|
||||
),
|
||||
'variations' => array(
|
||||
'description' => __( 'List of variations IDs.', 'woocommerce' ),
|
||||
'type' => 'array',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'items' => array(
|
||||
'type' => 'integer',
|
||||
),
|
||||
'readonly' => true,
|
||||
),
|
||||
'grouped_products' => array(
|
||||
'description' => __( 'List of grouped products ID.', 'woocommerce' ),
|
||||
'type' => 'array',
|
||||
'items' => array(
|
||||
'type' => 'integer',
|
||||
),
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
'menu_order' => array(
|
||||
'description' => __( 'Menu order, used to custom sort products.', 'woocommerce' ),
|
||||
'type' => 'integer',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'meta_data' => array(
|
||||
'description' => __( 'Meta data.', 'woocommerce' ),
|
||||
'type' => 'array',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'items' => array(
|
||||
'type' => 'object',
|
||||
'properties' => array(
|
||||
'id' => array(
|
||||
'description' => __( 'Meta ID.', 'woocommerce' ),
|
||||
'type' => 'integer',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
'key' => array(
|
||||
'description' => __( 'Meta key.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'value' => array(
|
||||
'description' => __( 'Meta value.', 'woocommerce' ),
|
||||
'type' => 'mixed',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
),
|
||||
),
|
||||
),
|
||||
),
|
||||
);
|
||||
|
||||
return $this->add_additional_fields_schema( $schema );
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -207,11 +830,12 @@ class Products extends AbstractObjectsController {
|
|||
* @return \WP_REST_Response
|
||||
*/
|
||||
public function prepare_object_for_response( $object, $request ) {
|
||||
$context = ! empty( $request['context'] ) ? $request['context'] : 'view';
|
||||
$data = ProductSchema::object_to_schema( $object, $context );
|
||||
$data = $this->add_additional_fields_to_object( $data, $request );
|
||||
$data = $this->filter_response_by_context( $data, $context );
|
||||
$response = rest_ensure_response( $data );
|
||||
$context = ! empty( $request['context'] ) ? $request['context'] : 'view';
|
||||
$product_response = new ProductResponse();
|
||||
$data = $product_response->prepare_response( $object, $context );
|
||||
$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( $object, $request ) );
|
||||
|
||||
/**
|
||||
|
|
@ -235,7 +859,12 @@ class Products extends AbstractObjectsController {
|
|||
* @return \WP_Error|\WC_Data
|
||||
*/
|
||||
protected function prepare_object_for_database( $request, $creating = false ) {
|
||||
$product = ProductSchema::schema_to_object( $request );
|
||||
try {
|
||||
$product_request = new ProductRequest( $request );
|
||||
$product = $product_request->prepare_object();
|
||||
} catch ( \WC_REST_Exception $e ) {
|
||||
return new \WP_Error( $e->getErrorCode(), $e->getMessage(), array( 'status' => $e->getCode() ) );
|
||||
}
|
||||
|
||||
/**
|
||||
* Filters an object before it is inserted via the REST API.
|
||||
|
|
|
|||
|
|
@ -0,0 +1,49 @@
|
|||
<?php
|
||||
/**
|
||||
* Convert data in the product schema format to an object.
|
||||
*
|
||||
* @package WooCommerce/RestApi
|
||||
*/
|
||||
|
||||
namespace WooCommerce\RestApi\Controllers\Version4\Schema;
|
||||
|
||||
defined( 'ABSPATH' ) || exit;
|
||||
|
||||
/**
|
||||
* AbstractRequest class.
|
||||
*/
|
||||
abstract class AbstractRequest {
|
||||
|
||||
/**
|
||||
* Request data.
|
||||
*
|
||||
* @var array Array of request data.
|
||||
*/
|
||||
protected $request;
|
||||
|
||||
/**
|
||||
* Constructor. Takes an existing or blank object and updates values based on the requset.
|
||||
*
|
||||
* @param \WP_REST_Request $request Request data.
|
||||
*/
|
||||
public function __construct( $request ) {
|
||||
$this->request = (array) $request->get_params();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get param from request.
|
||||
*
|
||||
* @param string $name Param name.
|
||||
* @param mixed $default Default to return if not set.
|
||||
*/
|
||||
protected function get_param( $name, $default = null ) {
|
||||
return isset( $this->request[ $name ] ) ? $this->request[ $name ] : $default;
|
||||
}
|
||||
|
||||
/**
|
||||
* Convert request to object.
|
||||
*
|
||||
* @throws \WC_REST_Exception Will throw an exception if the resulting product object is invalid.
|
||||
*/
|
||||
abstract public function prepare_object();
|
||||
}
|
||||
|
|
@ -0,0 +1,25 @@
|
|||
<?php
|
||||
/**
|
||||
* Convert an object to the product schema format.
|
||||
*
|
||||
* @package WooCommerce/RestApi
|
||||
*/
|
||||
|
||||
namespace WooCommerce\RestApi\Controllers\Version4\Schema;
|
||||
|
||||
defined( 'ABSPATH' ) || exit;
|
||||
|
||||
/**
|
||||
* AbstractResponse class.
|
||||
*/
|
||||
abstract class AbstractResponse {
|
||||
|
||||
/**
|
||||
* Convert object to match data in the schema.
|
||||
*
|
||||
* @param mixed $object Object.
|
||||
* @param string $context Request context. Options: 'view' and 'edit'.
|
||||
* @return array
|
||||
*/
|
||||
abstract public function prepare_response( $object, $context );
|
||||
}
|
||||
|
|
@ -0,0 +1,508 @@
|
|||
<?php
|
||||
/**
|
||||
* Convert data in the product schema format to a product object.
|
||||
*
|
||||
* @package WooCommerce/RestApi
|
||||
*/
|
||||
|
||||
namespace WooCommerce\RestApi\Controllers\Version4\Schema;
|
||||
|
||||
defined( 'ABSPATH' ) || exit;
|
||||
|
||||
/**
|
||||
* ProductRequest class.
|
||||
*/
|
||||
class ProductRequest extends AbstractRequest {
|
||||
|
||||
/**
|
||||
* Convert request to object.
|
||||
*
|
||||
* @return \WC_Product_Simple|\WC_Product_Grouped|\WC_Product_Variable|\WC_Product_External
|
||||
*/
|
||||
public function prepare_object() {
|
||||
$object = $this->get_product_object();
|
||||
|
||||
$this->set_common_props( $object );
|
||||
$this->set_meta_data( $object );
|
||||
|
||||
switch ( $object->get_type() ) {
|
||||
case 'grouped':
|
||||
$this->set_grouped_props( $object );
|
||||
break;
|
||||
case 'variable':
|
||||
$this->set_variable_props( $object );
|
||||
break;
|
||||
case 'external':
|
||||
$this->set_external_props( $object );
|
||||
break;
|
||||
}
|
||||
|
||||
if ( $object->get_downloadable() ) {
|
||||
$this->set_downloadable_props( $object );
|
||||
}
|
||||
|
||||
return $object;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get product object from request args.
|
||||
*
|
||||
* @throws \WC_REST_Exception Will throw an exception if the resulting product object is invalid.
|
||||
* @return \WC_Product_Simple|\WC_Product_Grouped|\WC_Product_Variable|\WC_Product_External
|
||||
*/
|
||||
protected function get_product_object() {
|
||||
$id = (int) $this->get_param( 'id', 0 );
|
||||
$type = $this->get_param( 'type', '' );
|
||||
|
||||
if ( $type ) {
|
||||
$classname = '\\' . \WC_Product_Factory::get_classname_from_product_type( $type );
|
||||
$object = class_exists( $classname ) ? new $classname( $id ) : new \WC_Product_Simple( $id );
|
||||
} elseif ( $id ) {
|
||||
$object = wc_get_product( $id );
|
||||
} else {
|
||||
$object = new \WC_Product_Simple();
|
||||
}
|
||||
|
||||
if ( ! $object ) {
|
||||
throw new \WC_REST_Exception( 'woocommerce_rest_invalid_product_id', __( 'Invalid product.', 'woocommerce' ), 404 );
|
||||
}
|
||||
|
||||
if ( $object->is_type( 'variation' ) ) {
|
||||
throw new \WC_REST_Exception( 'woocommerce_rest_invalid_product_id', __( 'To manipulate product variations you should use the /products/<product_id>/variations/<id> endpoint.', 'woocommerce' ), 404 );
|
||||
}
|
||||
|
||||
return $object;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set common product props.
|
||||
*
|
||||
* @param \WC_Product_Simple|\WC_Product_Grouped|\WC_Product_Variable|\WC_Product_External $object Product object reference.
|
||||
*/
|
||||
protected function set_common_props( &$object ) {
|
||||
$props = [
|
||||
'name',
|
||||
'sku',
|
||||
'description',
|
||||
'short_description',
|
||||
'slug',
|
||||
'menu_order',
|
||||
'reviews_allowed',
|
||||
'virtual',
|
||||
'tax_status',
|
||||
'tax_class',
|
||||
'catalog_visibility',
|
||||
'purchase_note',
|
||||
'status',
|
||||
'featured',
|
||||
'regular_price',
|
||||
'sale_price',
|
||||
'date_on_sale_from',
|
||||
'date_on_sale_from_gmt',
|
||||
'date_on_sale_to',
|
||||
'date_on_sale_to_gmt',
|
||||
'parent_id',
|
||||
'sold_individually',
|
||||
'manage_stock',
|
||||
'backorders',
|
||||
'stock_status',
|
||||
'stock_quantity',
|
||||
'downloadable',
|
||||
'date_created',
|
||||
'date_created_gmt',
|
||||
'upsell_ids',
|
||||
'cross_sell_ids',
|
||||
'images',
|
||||
'categories',
|
||||
'tags',
|
||||
'attributes',
|
||||
'weight',
|
||||
'dimensions',
|
||||
'shipping_class',
|
||||
];
|
||||
|
||||
$request_props = array_intersect_key( $this->request, array_flip( $props ) );
|
||||
$prop_values = [];
|
||||
|
||||
foreach ( $request_props as $prop => $value ) {
|
||||
switch ( $prop ) {
|
||||
case 'date_created':
|
||||
case 'date_created_gmt':
|
||||
$prop_values[ $prop ] = rest_parse_date( $value );
|
||||
break;
|
||||
case 'upsell_ids':
|
||||
case 'cross_sell_ids':
|
||||
$prop_values[ $prop ] = wp_parse_id_list( $value );
|
||||
break;
|
||||
case 'images':
|
||||
$images = $this->parse_images_field( $value, $object );
|
||||
$prop_values = array_merge( $prop_values, $images );
|
||||
break;
|
||||
case 'categories':
|
||||
$prop_values['category_ids'] = $this->parse_terms_field( $value );
|
||||
break;
|
||||
case 'tags':
|
||||
$prop_values['tag_ids'] = $this->parse_terms_field( $value );
|
||||
break;
|
||||
case 'attributes':
|
||||
$prop_values['attributes'] = $this->parse_attributes_field( $value );
|
||||
break;
|
||||
case 'dimensions':
|
||||
$dimensions = $this->parse_dimensions_fields( $value );
|
||||
$prop_values = array_merge( $prop_values, $dimensions );
|
||||
break;
|
||||
case 'shipping_class':
|
||||
$prop_values['shipping_class_id'] = $this->parse_shipping_class( $value, $object );
|
||||
break;
|
||||
default:
|
||||
$prop_values[ $prop ] = $value;
|
||||
}
|
||||
}
|
||||
|
||||
foreach ( $prop_values as $prop => $value ) {
|
||||
$object->{"set_$prop"}( $value );
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Set grouped product props.
|
||||
*
|
||||
* @param \WC_Product_Grouped $object Product object reference.
|
||||
*/
|
||||
protected function set_grouped_props( &$object ) {
|
||||
$children = $this->get_param( 'grouped_products', null );
|
||||
|
||||
if ( ! is_null( $children ) ) {
|
||||
$object->set_children( $children );
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Set variable product props.
|
||||
*
|
||||
* @param \WC_Product_Variable $object Product object reference.
|
||||
*/
|
||||
protected function set_variable_props( &$object ) {
|
||||
$default_attributes = $this->get_param( 'default_attributes', null );
|
||||
|
||||
if ( ! is_null( $default_attributes ) ) {
|
||||
$object->set_default_attributes( $this->parse_default_attributes( $default_attributes, $object ) );
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Set external product props.
|
||||
*
|
||||
* @param \WC_Product_External $object Product object reference.
|
||||
*/
|
||||
protected function set_external_props( &$object ) {
|
||||
$button_text = $this->get_param( 'button_text', null );
|
||||
$external_url = $this->get_param( 'external_url', null );
|
||||
|
||||
if ( ! is_null( $button_text ) ) {
|
||||
$object->set_button_text( $button_text );
|
||||
}
|
||||
|
||||
if ( ! is_null( $external_url ) ) {
|
||||
$object->set_product_url( $external_url );
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Set downloadable product props.
|
||||
*
|
||||
* @param \WC_Product_Simple|\WC_Product_Grouped|\WC_Product_Variable|\WC_Product_External $object Product object reference.
|
||||
*/
|
||||
protected function set_downloadable_props( &$object ) {
|
||||
$download_limit = $this->get_param( 'download_limit', null );
|
||||
$download_expiry = $this->get_param( 'download_expiry', null );
|
||||
$downloads = $this->get_param( 'downloads', null );
|
||||
|
||||
if ( ! is_null( $download_limit ) ) {
|
||||
$object->set_download_limit( $download_limit );
|
||||
}
|
||||
|
||||
if ( ! is_null( $download_expiry ) ) {
|
||||
$object->set_download_expiry( $download_expiry );
|
||||
}
|
||||
|
||||
if ( ! is_null( $downloads ) ) {
|
||||
$object->set_downloads( $this->parse_downloads_field( $downloads ) );
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Set meta data.
|
||||
*
|
||||
* @param \WC_Product_Simple|\WC_Product_Grouped|\WC_Product_Variable|\WC_Product_External $object Product object reference.
|
||||
*/
|
||||
protected function set_meta_data( &$object ) {
|
||||
$meta_data = $this->get_param( 'meta_data', null );
|
||||
|
||||
if ( ! is_null( $meta_data ) ) {
|
||||
foreach ( $meta_data as $meta ) {
|
||||
$object->update_meta_data( $meta['key'], $meta['value'], isset( $meta['id'] ) ? $meta['id'] : '' );
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Set product object's attributes.
|
||||
*
|
||||
* @param array $raw_attributes Attribute data from request.
|
||||
* @return array
|
||||
*/
|
||||
protected function parse_attributes_field( $raw_attributes ) {
|
||||
$attributes = array();
|
||||
|
||||
foreach ( $raw_attributes as $attribute ) {
|
||||
$attribute_id = 0;
|
||||
$attribute_name = '';
|
||||
|
||||
// Check ID for global attributes or name for product attributes.
|
||||
if ( ! empty( $attribute['id'] ) ) {
|
||||
$attribute_id = absint( $attribute['id'] );
|
||||
$attribute_name = wc_attribute_taxonomy_name_by_id( $attribute_id );
|
||||
} elseif ( ! empty( $attribute['name'] ) ) {
|
||||
$attribute_name = wc_clean( $attribute['name'] );
|
||||
}
|
||||
|
||||
if ( ! $attribute_id && ! $attribute_name ) {
|
||||
continue;
|
||||
}
|
||||
|
||||
if ( $attribute_id ) {
|
||||
|
||||
if ( isset( $attribute['options'] ) ) {
|
||||
$options = $attribute['options'];
|
||||
|
||||
if ( ! is_array( $attribute['options'] ) ) {
|
||||
// Text based attributes - Posted values are term names.
|
||||
$options = explode( WC_DELIMITER, $options );
|
||||
}
|
||||
|
||||
$values = array_map( 'wc_sanitize_term_text_based', $options );
|
||||
$values = array_filter( $values, 'strlen' );
|
||||
} else {
|
||||
$values = array();
|
||||
}
|
||||
|
||||
if ( ! empty( $values ) ) {
|
||||
// Add attribute to array, but don't set values.
|
||||
$attribute_object = new \WC_Product_Attribute();
|
||||
$attribute_object->set_id( $attribute_id );
|
||||
$attribute_object->set_name( $attribute_name );
|
||||
$attribute_object->set_options( $values );
|
||||
$attribute_object->set_position( isset( $attribute['position'] ) ? (string) absint( $attribute['position'] ) : '0' );
|
||||
$attribute_object->set_visible( ( isset( $attribute['visible'] ) && $attribute['visible'] ) ? 1 : 0 );
|
||||
$attribute_object->set_variation( ( isset( $attribute['variation'] ) && $attribute['variation'] ) ? 1 : 0 );
|
||||
$attributes[] = $attribute_object;
|
||||
}
|
||||
} elseif ( isset( $attribute['options'] ) ) {
|
||||
// Custom attribute - Add attribute to array and set the values.
|
||||
if ( is_array( $attribute['options'] ) ) {
|
||||
$values = $attribute['options'];
|
||||
} else {
|
||||
$values = explode( WC_DELIMITER, $attribute['options'] );
|
||||
}
|
||||
$attribute_object = new \WC_Product_Attribute();
|
||||
$attribute_object->set_name( $attribute_name );
|
||||
$attribute_object->set_options( $values );
|
||||
$attribute_object->set_position( isset( $attribute['position'] ) ? (string) absint( $attribute['position'] ) : '0' );
|
||||
$attribute_object->set_visible( ( isset( $attribute['visible'] ) && $attribute['visible'] ) ? 1 : 0 );
|
||||
$attribute_object->set_variation( ( isset( $attribute['variation'] ) && $attribute['variation'] ) ? 1 : 0 );
|
||||
$attributes[] = $attribute_object;
|
||||
}
|
||||
}
|
||||
return $attributes;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set product images.
|
||||
*
|
||||
* @throws \WC_REST_Exception REST API exceptions.
|
||||
* @param array $images Images data.
|
||||
* @param \WC_Product_Simple|\WC_Product_Grouped|\WC_Product_Variable|\WC_Product_External $object Product object.
|
||||
* @return array
|
||||
*/
|
||||
protected function parse_images_field( $images, $object ) {
|
||||
$response = [
|
||||
'image_id' => '',
|
||||
'gallery_image_ids' => [],
|
||||
];
|
||||
|
||||
$images = is_array( $images ) ? array_filter( $images ) : [];
|
||||
|
||||
if ( empty( $images ) ) {
|
||||
return $response;
|
||||
}
|
||||
|
||||
foreach ( $images as $index => $image ) {
|
||||
$attachment_id = isset( $image['id'] ) ? absint( $image['id'] ) : 0;
|
||||
|
||||
if ( 0 === $attachment_id && isset( $image['src'] ) ) {
|
||||
$upload = wc_rest_upload_image_from_url( esc_url_raw( $image['src'] ) );
|
||||
|
||||
if ( is_wp_error( $upload ) ) {
|
||||
if ( ! apply_filters( 'woocommerce_rest_suppress_image_upload_error', false, $upload, $object->get_id(), $images ) ) {
|
||||
throw new \WC_REST_Exception( 'woocommerce_product_image_upload_error', $upload->get_error_message(), 400 );
|
||||
} else {
|
||||
continue;
|
||||
}
|
||||
}
|
||||
|
||||
$attachment_id = wc_rest_set_uploaded_image_as_attachment( $upload, $object->get_id() );
|
||||
}
|
||||
|
||||
if ( ! wp_attachment_is_image( $attachment_id ) ) {
|
||||
/* translators: %s: image ID */
|
||||
throw new \WC_REST_Exception( 'woocommerce_product_invalid_image_id', sprintf( __( '#%s is an invalid image ID.', 'woocommerce' ), $attachment_id ), 400 );
|
||||
}
|
||||
|
||||
if ( 0 === $index ) {
|
||||
$response['image_id'] = $attachment_id;
|
||||
} else {
|
||||
$response['gallery_image_ids'][] = $attachment_id;
|
||||
}
|
||||
|
||||
// Set the image alt if present.
|
||||
if ( ! empty( $image['alt'] ) ) {
|
||||
update_post_meta( $attachment_id, '_wp_attachment_image_alt', wc_clean( $image['alt'] ) );
|
||||
}
|
||||
|
||||
// Set the image name if present.
|
||||
if ( ! empty( $image['name'] ) ) {
|
||||
wp_update_post(
|
||||
array(
|
||||
'ID' => $attachment_id,
|
||||
'post_title' => $image['name'],
|
||||
)
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
return $response;
|
||||
}
|
||||
|
||||
/**
|
||||
* Parse dimensions.
|
||||
*
|
||||
* @param array $dimensions Product dimensions.
|
||||
* @return array
|
||||
*/
|
||||
protected function parse_dimensions_fields( $dimensions ) {
|
||||
$response = [];
|
||||
|
||||
if ( isset( $dimensions['length'] ) ) {
|
||||
$response['length'] = $dimensions['length'];
|
||||
}
|
||||
|
||||
if ( isset( $dimensions['width'] ) ) {
|
||||
$response['width'] = $dimensions['width'];
|
||||
}
|
||||
|
||||
if ( isset( $dimensions['height'] ) ) {
|
||||
$response['height'] = $dimensions['height'];
|
||||
}
|
||||
|
||||
return $response;
|
||||
}
|
||||
|
||||
/**
|
||||
* Parse shipping class.
|
||||
*
|
||||
* @param string $shipping_class Shipping class slug.
|
||||
* @param \WC_Product_Simple|\WC_Product_Grouped|\WC_Product_Variable|\WC_Product_External $object Product object.
|
||||
* @return int
|
||||
*/
|
||||
protected function parse_shipping_class( $shipping_class, $object ) {
|
||||
$data_store = $object->get_data_store();
|
||||
return $data_store->get_shipping_class_id_by_slug( wc_clean( $shipping_class ) );
|
||||
}
|
||||
|
||||
/**
|
||||
* Parse downloadable files.
|
||||
*
|
||||
* @param array $downloads Downloads data.
|
||||
* @return array
|
||||
*/
|
||||
protected function parse_downloads_field( $downloads ) {
|
||||
$files = array();
|
||||
foreach ( $downloads as $key => $file ) {
|
||||
if ( empty( $file['file'] ) ) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$download = new \WC_Product_Download();
|
||||
$download->set_id( ! empty( $file['id'] ) ? $file['id'] : wp_generate_uuid4() );
|
||||
$download->set_name( $file['name'] ? $file['name'] : wc_get_filename_from_url( $file['file'] ) );
|
||||
$download->set_file( $file['file'] );
|
||||
$files[] = $download;
|
||||
}
|
||||
return $files;
|
||||
}
|
||||
|
||||
/**
|
||||
* Save taxonomy terms.
|
||||
*
|
||||
* @param array $terms Terms data.
|
||||
* @return array
|
||||
*/
|
||||
protected function parse_terms_field( $terms ) {
|
||||
return wp_list_pluck( $terms, 'id' );
|
||||
}
|
||||
|
||||
/**
|
||||
* Save default attributes.
|
||||
*
|
||||
* @param array $raw_default_attributes Default attributes.
|
||||
* @param \WC_Product_Variable $object Product object reference.
|
||||
* @return array
|
||||
*/
|
||||
protected function parse_default_attributes( $raw_default_attributes, $object ) {
|
||||
$attributes = $object->get_attributes();
|
||||
$default_attributes = array();
|
||||
|
||||
foreach ( $raw_default_attributes as $attribute ) {
|
||||
$attribute_id = 0;
|
||||
$attribute_name = '';
|
||||
|
||||
// Check ID for global attributes or name for product attributes.
|
||||
if ( ! empty( $attribute['id'] ) ) {
|
||||
$attribute_id = absint( $attribute['id'] );
|
||||
$attribute_name = wc_attribute_taxonomy_name_by_id( $attribute_id );
|
||||
} elseif ( ! empty( $attribute['name'] ) ) {
|
||||
$attribute_name = sanitize_title( $attribute['name'] );
|
||||
}
|
||||
|
||||
if ( ! $attribute_id && ! $attribute_name ) {
|
||||
continue;
|
||||
}
|
||||
|
||||
if ( isset( $attributes[ $attribute_name ] ) ) {
|
||||
$_attribute = $attributes[ $attribute_name ];
|
||||
|
||||
if ( $_attribute['is_variation'] ) {
|
||||
$value = isset( $attribute['option'] ) ? wc_clean( stripslashes( $attribute['option'] ) ) : '';
|
||||
|
||||
if ( ! empty( $_attribute['is_taxonomy'] ) ) {
|
||||
// If dealing with a taxonomy, we need to get the slug from the name posted to the API.
|
||||
$term = get_term_by( 'name', $value, $attribute_name );
|
||||
|
||||
if ( $term && ! is_wp_error( $term ) ) {
|
||||
$value = $term->slug;
|
||||
} else {
|
||||
$value = sanitize_title( $value );
|
||||
}
|
||||
}
|
||||
|
||||
if ( $value ) {
|
||||
$default_attributes[ $attribute_name ] = $value;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return $default_attributes;
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,354 @@
|
|||
<?php
|
||||
/**
|
||||
* Convert a product object to the product schema format.
|
||||
*
|
||||
* @package WooCommerce/RestApi
|
||||
*/
|
||||
|
||||
namespace WooCommerce\RestApi\Controllers\Version4\Schema;
|
||||
|
||||
defined( 'ABSPATH' ) || exit;
|
||||
|
||||
/**
|
||||
* ProductResponse class.
|
||||
*/
|
||||
class ProductResponse extends AbstractResponse {
|
||||
|
||||
/**
|
||||
* Convert object to match data in the schema.
|
||||
*
|
||||
* @param \WC_Product_Simple|\WC_Product_Grouped|\WC_Product_Variable|\WC_Product_External $object Product data.
|
||||
* @param string $context Request context. Options: 'view' and 'edit'.
|
||||
* @return array
|
||||
*/
|
||||
public function prepare_response( $object, $context ) {
|
||||
$data = array(
|
||||
'id' => $object->get_id(),
|
||||
'name' => $object->get_name( $context ),
|
||||
'slug' => $object->get_slug( $context ),
|
||||
'permalink' => $object->get_permalink(),
|
||||
'date_created' => wc_rest_prepare_date_response( $object->get_date_created( $context ), false ),
|
||||
'date_created_gmt' => wc_rest_prepare_date_response( $object->get_date_created( $context ) ),
|
||||
'date_modified' => wc_rest_prepare_date_response( $object->get_date_modified( $context ), false ),
|
||||
'date_modified_gmt' => wc_rest_prepare_date_response( $object->get_date_modified( $context ) ),
|
||||
'type' => $object->get_type(),
|
||||
'status' => $object->get_status( $context ),
|
||||
'featured' => $object->is_featured(),
|
||||
'catalog_visibility' => $object->get_catalog_visibility( $context ),
|
||||
'description' => $object->get_description( $context ),
|
||||
'short_description' => $object->get_short_description( $context ),
|
||||
'sku' => $object->get_sku( $context ),
|
||||
'price' => $object->get_price( $context ),
|
||||
'regular_price' => $object->get_regular_price( $context ),
|
||||
'sale_price' => $object->get_sale_price( $context ) ? $object->get_sale_price( $context ) : '',
|
||||
'date_on_sale_from' => wc_rest_prepare_date_response( $object->get_date_on_sale_from( $context ), false ),
|
||||
'date_on_sale_from_gmt' => wc_rest_prepare_date_response( $object->get_date_on_sale_from( $context ) ),
|
||||
'date_on_sale_to' => wc_rest_prepare_date_response( $object->get_date_on_sale_to( $context ), false ),
|
||||
'date_on_sale_to_gmt' => wc_rest_prepare_date_response( $object->get_date_on_sale_to( $context ) ),
|
||||
'price_html' => $object->get_price_html(),
|
||||
'on_sale' => $object->is_on_sale( $context ),
|
||||
'purchasable' => $object->is_purchasable(),
|
||||
'total_sales' => $object->get_total_sales( $context ),
|
||||
'virtual' => $object->is_virtual(),
|
||||
'downloadable' => $object->is_downloadable(),
|
||||
'downloads' => $this->prepare_downloads( $object ),
|
||||
'download_limit' => $object->get_download_limit( $context ),
|
||||
'download_expiry' => $object->get_download_expiry( $context ),
|
||||
'external_url' => '',
|
||||
'button_text' => '',
|
||||
'tax_status' => $object->get_tax_status( $context ),
|
||||
'tax_class' => $object->get_tax_class( $context ),
|
||||
'manage_stock' => $object->managing_stock(),
|
||||
'stock_quantity' => $object->get_stock_quantity( $context ),
|
||||
'stock_status' => $object->get_stock_status( $context ),
|
||||
'backorders' => $object->get_backorders( $context ),
|
||||
'backorders_allowed' => $object->backorders_allowed(),
|
||||
'backordered' => $object->is_on_backorder(),
|
||||
'sold_individually' => $object->is_sold_individually(),
|
||||
'weight' => $object->get_weight( $context ),
|
||||
'dimensions' => array(
|
||||
'length' => $object->get_length( $context ),
|
||||
'width' => $object->get_width( $context ),
|
||||
'height' => $object->get_height( $context ),
|
||||
),
|
||||
'shipping_required' => $object->needs_shipping(),
|
||||
'shipping_taxable' => $object->is_shipping_taxable(),
|
||||
'shipping_class' => $object->get_shipping_class(),
|
||||
'shipping_class_id' => $object->get_shipping_class_id( $context ),
|
||||
'reviews_allowed' => $object->get_reviews_allowed( $context ),
|
||||
'average_rating' => $object->get_average_rating( $context ),
|
||||
'rating_count' => $object->get_rating_count(),
|
||||
'related_ids' => wp_parse_id_list( wc_get_related_products( $object->get_id() ) ),
|
||||
'upsell_ids' => wp_parse_id_list( $object->get_upsell_ids( $context ) ),
|
||||
'cross_sell_ids' => wp_parse_id_list( $object->get_cross_sell_ids( $context ) ),
|
||||
'parent_id' => $object->get_parent_id( $context ),
|
||||
'purchase_note' => $object->get_purchase_note( $context ),
|
||||
'categories' => $this->prepare_taxonomy_terms( $object ),
|
||||
'tags' => $this->prepare_taxonomy_terms( $object, 'tag' ),
|
||||
'images' => $this->prepare_images( $object ),
|
||||
'attributes' => $this->prepare_attributes( $object ),
|
||||
'default_attributes' => $this->prepare_default_attributes( $object ),
|
||||
'variations' => array(),
|
||||
'grouped_products' => array(),
|
||||
'menu_order' => $object->get_menu_order( $context ),
|
||||
'meta_data' => $object->get_meta_data(),
|
||||
);
|
||||
|
||||
// Add variations to variable products.
|
||||
if ( $object->is_type( 'variable' ) ) {
|
||||
$data['variations'] = $object->get_children();
|
||||
}
|
||||
|
||||
// Add grouped products data.
|
||||
if ( $object->is_type( 'grouped' ) ) {
|
||||
$data['grouped_products'] = $object->get_children();
|
||||
}
|
||||
|
||||
// Add external product data.
|
||||
if ( $object->is_type( 'external' ) ) {
|
||||
$data['external_url'] = $object->get_product_url( $context );
|
||||
$data['button_text'] = $object->get_button_text( $context );
|
||||
}
|
||||
|
||||
if ( 'view' === $context ) {
|
||||
$data['description'] = wpautop( do_shortcode( $data['description'] ) );
|
||||
$data['short_description'] = apply_filters( 'woocommerce_short_description', $data['short_description'] );
|
||||
$data['average_rating'] = wc_format_decimal( $data['average_rating'], 2 );
|
||||
$data['purchase_note'] = wpautop( do_shortcode( $data['purchase_note'] ) );
|
||||
}
|
||||
|
||||
return $data;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the downloads for a product or product variation.
|
||||
*
|
||||
* @param \WC_Product|\WC_Product_Variation $object Product instance.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
protected function prepare_downloads( $object ) {
|
||||
$downloads = array();
|
||||
|
||||
if ( $object->is_downloadable() ) {
|
||||
foreach ( $object->get_downloads() as $file_id => $file ) {
|
||||
$downloads[] = array(
|
||||
'id' => $file_id, // MD5 hash.
|
||||
'name' => $file['name'],
|
||||
'file' => $file['file'],
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
return $downloads;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get taxonomy terms.
|
||||
*
|
||||
* @param \WC_Product $object Product instance.
|
||||
* @param string $taxonomy Taxonomy slug.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
protected function prepare_taxonomy_terms( $object, $taxonomy = 'cat' ) {
|
||||
$terms = array();
|
||||
|
||||
foreach ( wc_get_object_terms( $object->get_id(), 'product_' . $taxonomy ) as $term ) {
|
||||
$terms[] = array(
|
||||
'id' => $term->term_id,
|
||||
'name' => $term->name,
|
||||
'slug' => $term->slug,
|
||||
);
|
||||
}
|
||||
|
||||
return $terms;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the images for a product or product variation.
|
||||
*
|
||||
* @param \WC_Product|\WC_Product_Variation $object Product instance.
|
||||
* @return array
|
||||
*/
|
||||
protected function prepare_images( $object ) {
|
||||
$images = array();
|
||||
$attachment_ids = array();
|
||||
|
||||
// Add featured image.
|
||||
if ( $object->get_image_id() ) {
|
||||
$attachment_ids[] = $object->get_image_id();
|
||||
}
|
||||
|
||||
// Add gallery images.
|
||||
$attachment_ids = array_merge( $attachment_ids, $object->get_gallery_image_ids() );
|
||||
|
||||
// Build image data.
|
||||
foreach ( $attachment_ids as $attachment_id ) {
|
||||
$attachment_post = get_post( $attachment_id );
|
||||
if ( is_null( $attachment_post ) ) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$attachment = wp_get_attachment_image_src( $attachment_id, 'full' );
|
||||
if ( ! is_array( $attachment ) ) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$images[] = array(
|
||||
'id' => (int) $attachment_id,
|
||||
'date_created' => wc_rest_prepare_date_response( $attachment_post->post_date, false ),
|
||||
'date_created_gmt' => wc_rest_prepare_date_response( strtotime( $attachment_post->post_date_gmt ) ),
|
||||
'date_modified' => wc_rest_prepare_date_response( $attachment_post->post_modified, false ),
|
||||
'date_modified_gmt' => wc_rest_prepare_date_response( strtotime( $attachment_post->post_modified_gmt ) ),
|
||||
'src' => current( $attachment ),
|
||||
'name' => get_the_title( $attachment_id ),
|
||||
'alt' => get_post_meta( $attachment_id, '_wp_attachment_image_alt', true ),
|
||||
);
|
||||
}
|
||||
|
||||
return $images;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get default attributes.
|
||||
*
|
||||
* @param \WC_Product $object Product instance.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
protected function prepare_default_attributes( $object ) {
|
||||
$default = array();
|
||||
|
||||
if ( $object->is_type( 'variable' ) ) {
|
||||
foreach ( array_filter( (array) $object->get_default_attributes(), 'strlen' ) as $key => $value ) {
|
||||
if ( 0 === strpos( $key, 'pa_' ) ) {
|
||||
$default[] = array(
|
||||
'id' => wc_attribute_taxonomy_id_by_name( $key ),
|
||||
'name' => $this->get_attribute_taxonomy_name( $key, $object ),
|
||||
'option' => $value,
|
||||
);
|
||||
} else {
|
||||
$default[] = array(
|
||||
'id' => 0,
|
||||
'name' => $this->get_attribute_taxonomy_name( $key, $object ),
|
||||
'option' => $value,
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return $default;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the attributes for a product or product variation.
|
||||
*
|
||||
* @param \WC_Product|\WC_Product_Variation $object Product instance.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
protected function prepare_attributes( $object ) {
|
||||
$attributes = array();
|
||||
|
||||
if ( $object->is_type( 'variation' ) ) {
|
||||
$_product = wc_get_product( $object->get_parent_id() );
|
||||
foreach ( $object->get_variation_attributes() as $attribute_name => $attribute ) {
|
||||
$name = str_replace( 'attribute_', '', $attribute_name );
|
||||
|
||||
if ( empty( $attribute ) && '0' !== $attribute ) {
|
||||
continue;
|
||||
}
|
||||
|
||||
// Taxonomy-based attributes are prefixed with `pa_`, otherwise simply `attribute_`.
|
||||
if ( 0 === strpos( $attribute_name, 'attribute_pa_' ) ) {
|
||||
$option_term = get_term_by( 'slug', $attribute, $name );
|
||||
$attributes[] = array(
|
||||
'id' => wc_attribute_taxonomy_id_by_name( $name ),
|
||||
'name' => $this->get_attribute_taxonomy_name( $name, $_product ),
|
||||
'option' => $option_term && ! is_wp_error( $option_term ) ? $option_term->name : $attribute,
|
||||
);
|
||||
} else {
|
||||
$attributes[] = array(
|
||||
'id' => 0,
|
||||
'name' => $this->get_attribute_taxonomy_name( $name, $_product ),
|
||||
'option' => $attribute,
|
||||
);
|
||||
}
|
||||
}
|
||||
} else {
|
||||
foreach ( $object->get_attributes() as $attribute ) {
|
||||
$attributes[] = array(
|
||||
'id' => $attribute['is_taxonomy'] ? wc_attribute_taxonomy_id_by_name( $attribute['name'] ) : 0,
|
||||
'name' => $this->get_attribute_taxonomy_name( $attribute['name'], $object ),
|
||||
'position' => (int) $attribute['position'],
|
||||
'visible' => (bool) $attribute['is_visible'],
|
||||
'variation' => (bool) $attribute['is_variation'],
|
||||
'options' => $this->get_attribute_options( $object->get_id(), $attribute ),
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
return $attributes;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get product attribute taxonomy name.
|
||||
*
|
||||
* @param string $slug Taxonomy name.
|
||||
* @param \WC_Product $object Product data.
|
||||
*
|
||||
* @since 3.0.0
|
||||
* @return string
|
||||
*/
|
||||
protected function get_attribute_taxonomy_name( $slug, $object ) {
|
||||
// Format slug so it matches attributes of the product.
|
||||
$slug = wc_attribute_taxonomy_slug( $slug );
|
||||
$attributes = $object->get_attributes();
|
||||
$attribute = false;
|
||||
|
||||
// pa_ attributes.
|
||||
if ( isset( $attributes[ wc_attribute_taxonomy_name( $slug ) ] ) ) {
|
||||
$attribute = $attributes[ wc_attribute_taxonomy_name( $slug ) ];
|
||||
} elseif ( isset( $attributes[ $slug ] ) ) {
|
||||
$attribute = $attributes[ $slug ];
|
||||
}
|
||||
|
||||
if ( ! $attribute ) {
|
||||
return $slug;
|
||||
}
|
||||
|
||||
// Taxonomy attribute name.
|
||||
if ( $attribute->is_taxonomy() ) {
|
||||
$taxonomy = $attribute->get_taxonomy_object();
|
||||
return $taxonomy->attribute_label;
|
||||
}
|
||||
|
||||
// Custom product attribute name.
|
||||
return $attribute->get_name();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get attribute options.
|
||||
*
|
||||
* @param int $object_id Product ID.
|
||||
* @param array $attribute Attribute data.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
protected function get_attribute_options( $object_id, $attribute ) {
|
||||
if ( isset( $attribute['is_taxonomy'] ) && $attribute['is_taxonomy'] ) {
|
||||
return wc_get_product_terms(
|
||||
$object_id,
|
||||
$attribute['name'],
|
||||
array(
|
||||
'fields' => 'names',
|
||||
)
|
||||
);
|
||||
} elseif ( isset( $attribute['value'] ) ) {
|
||||
return array_map( 'trim', explode( '|', $attribute['value'] ) );
|
||||
}
|
||||
|
||||
return array();
|
||||
}
|
||||
}
|
||||
File diff suppressed because it is too large
Load Diff
|
|
@ -0,0 +1,205 @@
|
|||
<?php
|
||||
/**
|
||||
* Convert data in the product schema format to a product object.
|
||||
*
|
||||
* @package WooCommerce/RestApi
|
||||
*/
|
||||
|
||||
namespace WooCommerce\RestApi\Controllers\Version4\Schema;
|
||||
|
||||
defined( 'ABSPATH' ) || exit;
|
||||
|
||||
/**
|
||||
* ProductVariationRequest class.
|
||||
*/
|
||||
class ProductVariationRequest extends ProductRequest {
|
||||
|
||||
/**
|
||||
* Convert request to object.
|
||||
*
|
||||
* @throws \WC_REST_Exception Will throw an exception if the resulting product object is invalid.
|
||||
* @return \WC_Product_Variation
|
||||
*/
|
||||
public function prepare_object() {
|
||||
$id = (int) $this->get_param( 'id', 0 );
|
||||
$object = new \WC_Product_Variation( $id );
|
||||
$object->set_parent_id( (int) $this->get_param( 'product_id', 0 ) );
|
||||
$parent = wc_get_product( $object->get_parent_id() );
|
||||
|
||||
if ( ! $parent ) {
|
||||
throw new \WC_REST_Exception( 'woocommerce_rest_product_variation_invalid_parent', __( 'Invalid parent product.', 'woocommerce' ), 404 );
|
||||
}
|
||||
|
||||
$this->set_common_props( $object );
|
||||
$this->set_meta_data( $object );
|
||||
|
||||
if ( $object->get_downloadable() ) {
|
||||
$this->set_downloadable_props( $object );
|
||||
}
|
||||
|
||||
return $object;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set common product props.
|
||||
*
|
||||
* @param \WC_Product_Variation $object Product object reference.
|
||||
*/
|
||||
protected function set_common_props( &$object ) {
|
||||
$props = [
|
||||
'status',
|
||||
'sku',
|
||||
'virtual',
|
||||
'downloadable',
|
||||
'download_limit',
|
||||
'download_expiry',
|
||||
'manage_stock',
|
||||
'stock_status',
|
||||
'backorders',
|
||||
'regular_price',
|
||||
'sale_price',
|
||||
'date_on_sale_from',
|
||||
'date_on_sale_from_gmt',
|
||||
'date_on_sale_to',
|
||||
'date_on_sale_to_gmt',
|
||||
'tax_class',
|
||||
'description',
|
||||
'menu_order',
|
||||
'stock_quantity',
|
||||
'image',
|
||||
'downloads',
|
||||
'attributes',
|
||||
'weight',
|
||||
'dimensions',
|
||||
'shipping_class',
|
||||
];
|
||||
|
||||
$request_props = array_intersect_key( $this->request, array_flip( $props ) );
|
||||
$prop_values = [];
|
||||
|
||||
foreach ( $request_props as $prop => $value ) {
|
||||
switch ( $prop ) {
|
||||
case 'image':
|
||||
$prop_values['image_id'] = $this->parse_image_field( $value, $object );
|
||||
break;
|
||||
case 'attributes':
|
||||
$prop_values['attributes'] = $this->parse_attributes_field( $value, $object );
|
||||
break;
|
||||
case 'dimensions':
|
||||
$dimensions = $this->parse_dimensions_fields( $value );
|
||||
$prop_values = array_merge( $prop_values, $dimensions );
|
||||
break;
|
||||
case 'shipping_class':
|
||||
$prop_values['shipping_class_id'] = $this->parse_shipping_class( $value, $object );
|
||||
break;
|
||||
default:
|
||||
$prop_values[ $prop ] = $value;
|
||||
}
|
||||
}
|
||||
|
||||
foreach ( $prop_values as $prop => $value ) {
|
||||
$object->{"set_$prop"}( $value );
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Set product object's attributes.
|
||||
*
|
||||
* @param array $raw_attributes Attribute data from request.
|
||||
* @param \WC_Product_Variation $object Product object.
|
||||
*/
|
||||
protected function parse_attributes_field( $raw_attributes, $object = null ) {
|
||||
$attributes = array();
|
||||
$parent = wc_get_product( $object->get_parent_id() );
|
||||
$parent_attributes = $parent->get_attributes();
|
||||
|
||||
foreach ( $raw_attributes as $attribute ) {
|
||||
$attribute_id = 0;
|
||||
$attribute_name = '';
|
||||
|
||||
// Check ID for global attributes or name for product attributes.
|
||||
if ( ! empty( $attribute['id'] ) ) {
|
||||
$attribute_id = absint( $attribute['id'] );
|
||||
$attribute_name = wc_attribute_taxonomy_name_by_id( $attribute_id );
|
||||
} elseif ( ! empty( $attribute['name'] ) ) {
|
||||
$attribute_name = sanitize_title( $attribute['name'] );
|
||||
}
|
||||
|
||||
if ( ! $attribute_id && ! $attribute_name ) {
|
||||
continue;
|
||||
}
|
||||
|
||||
if ( ! isset( $parent_attributes[ $attribute_name ] ) || ! $parent_attributes[ $attribute_name ]->get_variation() ) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$attribute_key = sanitize_title( $parent_attributes[ $attribute_name ]->get_name() );
|
||||
$attribute_value = isset( $attribute['option'] ) ? wc_clean( stripslashes( $attribute['option'] ) ) : '';
|
||||
|
||||
if ( $parent_attributes[ $attribute_name ]->is_taxonomy() ) {
|
||||
// If dealing with a taxonomy, we need to get the slug from the name posted to the API.
|
||||
$term = get_term_by( 'name', $attribute_value, $attribute_name );
|
||||
|
||||
if ( $term && ! is_wp_error( $term ) ) {
|
||||
$attribute_value = $term->slug;
|
||||
} else {
|
||||
$attribute_value = sanitize_title( $attribute_value );
|
||||
}
|
||||
}
|
||||
|
||||
$attributes[ $attribute_key ] = $attribute_value;
|
||||
}
|
||||
|
||||
return $attributes;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set product images.
|
||||
*
|
||||
* @throws \WC_REST_Exception REST API exceptions.
|
||||
* @param array $image Image data.
|
||||
* @param \WC_Product_Variation $object Product object.
|
||||
* @return array
|
||||
*/
|
||||
protected function parse_image_field( $image, $object ) {
|
||||
if ( empty( $image ) ) {
|
||||
return '';
|
||||
}
|
||||
|
||||
$attachment_id = isset( $image['id'] ) ? absint( $image['id'] ) : 0;
|
||||
|
||||
if ( 0 === $attachment_id && isset( $image['src'] ) ) {
|
||||
$upload = wc_rest_upload_image_from_url( esc_url_raw( $image['src'] ) );
|
||||
|
||||
if ( is_wp_error( $upload ) ) {
|
||||
if ( ! apply_filters( 'woocommerce_rest_suppress_image_upload_error', false, $upload, $object->get_id(), array( $image ) ) ) {
|
||||
throw new \WC_REST_Exception( 'woocommerce_variation_image_upload_error', $upload->get_error_message(), 400 );
|
||||
}
|
||||
}
|
||||
|
||||
$attachment_id = wc_rest_set_uploaded_image_as_attachment( $upload, $object->get_id() );
|
||||
}
|
||||
|
||||
if ( ! wp_attachment_is_image( $attachment_id ) ) {
|
||||
/* translators: %s: attachment ID */
|
||||
throw new \WC_REST_Exception( 'woocommerce_variation_invalid_image_id', sprintf( __( '#%s is an invalid image ID.', 'woocommerce' ), $attachment_id ), 400 );
|
||||
}
|
||||
|
||||
// Set the image alt if present.
|
||||
if ( ! empty( $image['alt'] ) ) {
|
||||
update_post_meta( $attachment_id, '_wp_attachment_image_alt', wc_clean( $image['alt'] ) );
|
||||
}
|
||||
|
||||
// Set the image name if present.
|
||||
if ( ! empty( $image['name'] ) ) {
|
||||
wp_update_post(
|
||||
array(
|
||||
'ID' => $attachment_id,
|
||||
'post_title' => $image['name'],
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
return $attachment_id;
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,111 @@
|
|||
<?php
|
||||
/**
|
||||
* Convert a product variation object to the product variation schema format.
|
||||
*
|
||||
* @package WooCommerce/RestApi
|
||||
*/
|
||||
|
||||
namespace WooCommerce\RestApi\Controllers\Version4\Schema;
|
||||
|
||||
defined( 'ABSPATH' ) || exit;
|
||||
|
||||
/**
|
||||
* ProductVariationResponse class.
|
||||
*/
|
||||
class ProductVariationResponse extends ProductResponse {
|
||||
|
||||
/**
|
||||
* Convert object to match data in the schema.
|
||||
*
|
||||
* @param \WC_Product_Variation $object Variation data.
|
||||
* @param string $context Request context. Options: 'view' and 'edit'.
|
||||
* @return array
|
||||
*/
|
||||
public function prepare_response( $object, $context ) {
|
||||
$data = array(
|
||||
'id' => $object->get_id(),
|
||||
'name' => $object->get_name( $context ),
|
||||
'type' => $object->get_type(),
|
||||
'parent_id' => $object->get_parent_id( $context ),
|
||||
'date_created' => wc_rest_prepare_date_response( $object->get_date_created(), false ),
|
||||
'date_created_gmt' => wc_rest_prepare_date_response( $object->get_date_created() ),
|
||||
'date_modified' => wc_rest_prepare_date_response( $object->get_date_modified(), false ),
|
||||
'date_modified_gmt' => wc_rest_prepare_date_response( $object->get_date_modified() ),
|
||||
'description' => wc_format_content( $object->get_description() ),
|
||||
'permalink' => $object->get_permalink(),
|
||||
'sku' => $object->get_sku(),
|
||||
'price' => $object->get_price(),
|
||||
'regular_price' => $object->get_regular_price(),
|
||||
'sale_price' => $object->get_sale_price(),
|
||||
'date_on_sale_from' => wc_rest_prepare_date_response( $object->get_date_on_sale_from(), false ),
|
||||
'date_on_sale_from_gmt' => wc_rest_prepare_date_response( $object->get_date_on_sale_from() ),
|
||||
'date_on_sale_to' => wc_rest_prepare_date_response( $object->get_date_on_sale_to(), false ),
|
||||
'date_on_sale_to_gmt' => wc_rest_prepare_date_response( $object->get_date_on_sale_to() ),
|
||||
'on_sale' => $object->is_on_sale(),
|
||||
'status' => $object->get_status(),
|
||||
'purchasable' => $object->is_purchasable(),
|
||||
'virtual' => $object->is_virtual(),
|
||||
'downloadable' => $object->is_downloadable(),
|
||||
'downloads' => $this->prepare_downloads( $object ),
|
||||
'download_limit' => '' !== $object->get_download_limit() ? (int) $object->get_download_limit() : -1,
|
||||
'download_expiry' => '' !== $object->get_download_expiry() ? (int) $object->get_download_expiry() : -1,
|
||||
'tax_status' => $object->get_tax_status(),
|
||||
'tax_class' => $object->get_tax_class(),
|
||||
'manage_stock' => $object->managing_stock(),
|
||||
'stock_quantity' => $object->get_stock_quantity(),
|
||||
'stock_status' => $object->get_stock_status(),
|
||||
'backorders' => $object->get_backorders(),
|
||||
'backorders_allowed' => $object->backorders_allowed(),
|
||||
'backordered' => $object->is_on_backorder(),
|
||||
'weight' => $object->get_weight(),
|
||||
'dimensions' => array(
|
||||
'length' => $object->get_length(),
|
||||
'width' => $object->get_width(),
|
||||
'height' => $object->get_height(),
|
||||
),
|
||||
'shipping_class' => $object->get_shipping_class(),
|
||||
'shipping_class_id' => $object->get_shipping_class_id(),
|
||||
'image' => $this->prepare_image( $object ),
|
||||
'attributes' => $this->prepare_attributes( $object ),
|
||||
'menu_order' => $object->get_menu_order(),
|
||||
'meta_data' => $object->get_meta_data(),
|
||||
);
|
||||
return $data;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the image for a product variation.
|
||||
*
|
||||
* @param \WC_Product_Variation $object Variation data.
|
||||
* @return array
|
||||
*/
|
||||
protected static function prepare_image( $object ) {
|
||||
if ( ! $object->get_image_id() ) {
|
||||
return;
|
||||
}
|
||||
|
||||
$attachment_id = $object->get_image_id();
|
||||
$attachment_post = get_post( $attachment_id );
|
||||
if ( is_null( $attachment_post ) ) {
|
||||
return;
|
||||
}
|
||||
|
||||
$attachment = wp_get_attachment_image_src( $attachment_id, 'full' );
|
||||
if ( ! is_array( $attachment ) ) {
|
||||
return;
|
||||
}
|
||||
|
||||
if ( ! isset( $image ) ) {
|
||||
return array(
|
||||
'id' => (int) $attachment_id,
|
||||
'date_created' => wc_rest_prepare_date_response( $attachment_post->post_date, false ),
|
||||
'date_created_gmt' => wc_rest_prepare_date_response( strtotime( $attachment_post->post_date_gmt ) ),
|
||||
'date_modified' => wc_rest_prepare_date_response( $attachment_post->post_modified, false ),
|
||||
'date_modified_gmt' => wc_rest_prepare_date_response( strtotime( $attachment_post->post_modified_gmt ) ),
|
||||
'src' => current( $attachment ),
|
||||
'name' => get_the_title( $attachment_id ),
|
||||
'alt' => get_post_meta( $attachment_id, '_wp_attachment_image_alt', true ),
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -1,688 +0,0 @@
|
|||
<?php
|
||||
/**
|
||||
* Product variation schema.
|
||||
*
|
||||
* @package WooCommerce/RestApi
|
||||
*/
|
||||
|
||||
namespace WooCommerce\RestApi\Controllers\Version4\Schema;
|
||||
|
||||
defined( 'ABSPATH' ) || exit;
|
||||
|
||||
/**
|
||||
* ProductVariationSchema class.
|
||||
*/
|
||||
class ProductVariationSchema extends ProductSchema {
|
||||
|
||||
/**
|
||||
* Return schema for products.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public static function get_schema() {
|
||||
$weight_unit = get_option( 'woocommerce_weight_unit' );
|
||||
$dimension_unit = get_option( 'woocommerce_dimension_unit' );
|
||||
$schema = array(
|
||||
'$schema' => 'http://json-schema.org/draft-04/schema#',
|
||||
'title' => 'product_variation',
|
||||
'type' => 'object',
|
||||
'properties' => array(
|
||||
'id' => array(
|
||||
'description' => __( 'Unique identifier for the resource.', 'woocommerce' ),
|
||||
'type' => 'integer',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
'name' => array(
|
||||
'description' => __( 'Product parent name.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'type' => array(
|
||||
'description' => __( 'Product type.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'default' => 'variation',
|
||||
'enum' => array( 'variation' ),
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'parent_id' => array(
|
||||
'description' => __( 'Product parent ID.', 'woocommerce' ),
|
||||
'type' => 'integer',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'date_created' => array(
|
||||
'description' => __( "The date the variation was created, in the site's timezone.", 'woocommerce' ),
|
||||
'type' => 'date-time',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
'date_modified' => array(
|
||||
'description' => __( "The date the variation was last modified, in the site's timezone.", 'woocommerce' ),
|
||||
'type' => 'date-time',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
'description' => array(
|
||||
'description' => __( 'Variation description.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'arg_options' => array(
|
||||
'sanitize_callback' => 'wp_filter_post_kses',
|
||||
),
|
||||
),
|
||||
'permalink' => array(
|
||||
'description' => __( 'Variation URL.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'format' => 'uri',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
'sku' => array(
|
||||
'description' => __( 'Unique identifier.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'arg_options' => array(
|
||||
'sanitize_callback' => 'wc_clean',
|
||||
),
|
||||
),
|
||||
'price' => array(
|
||||
'description' => __( 'Current variation price.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
'regular_price' => array(
|
||||
'description' => __( 'Variation regular price.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'sale_price' => array(
|
||||
'description' => __( 'Variation sale price.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'date_on_sale_from' => array(
|
||||
'description' => __( "Start date of sale price, in the site's timezone.", 'woocommerce' ),
|
||||
'type' => 'date-time',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'date_on_sale_from_gmt' => array(
|
||||
'description' => __( 'Start date of sale price, as GMT.', 'woocommerce' ),
|
||||
'type' => 'date-time',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'date_on_sale_to' => array(
|
||||
'description' => __( "End date of sale price, in the site's timezone.", 'woocommerce' ),
|
||||
'type' => 'date-time',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'date_on_sale_to_gmt' => array(
|
||||
'description' => __( "End date of sale price, in the site's timezone.", 'woocommerce' ),
|
||||
'type' => 'date-time',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'on_sale' => array(
|
||||
'description' => __( 'Shows if the variation is on sale.', 'woocommerce' ),
|
||||
'type' => 'boolean',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
'status' => array(
|
||||
'description' => __( 'Variation status.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'default' => 'publish',
|
||||
'enum' => array_keys( get_post_statuses() ),
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'purchasable' => array(
|
||||
'description' => __( 'Shows if the variation can be bought.', 'woocommerce' ),
|
||||
'type' => 'boolean',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
'virtual' => array(
|
||||
'description' => __( 'If the variation is virtual.', 'woocommerce' ),
|
||||
'type' => 'boolean',
|
||||
'default' => false,
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'downloadable' => array(
|
||||
'description' => __( 'If the variation is downloadable.', 'woocommerce' ),
|
||||
'type' => 'boolean',
|
||||
'default' => false,
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'downloads' => array(
|
||||
'description' => __( 'List of downloadable files.', 'woocommerce' ),
|
||||
'type' => 'array',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'items' => array(
|
||||
'type' => 'object',
|
||||
'properties' => array(
|
||||
'id' => array(
|
||||
'description' => __( 'File ID.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'name' => array(
|
||||
'description' => __( 'File name.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'file' => array(
|
||||
'description' => __( 'File URL.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
),
|
||||
),
|
||||
),
|
||||
'download_limit' => array(
|
||||
'description' => __( 'Number of times downloadable files can be downloaded after purchase.', 'woocommerce' ),
|
||||
'type' => 'integer',
|
||||
'default' => -1,
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'download_expiry' => array(
|
||||
'description' => __( 'Number of days until access to downloadable files expires.', 'woocommerce' ),
|
||||
'type' => 'integer',
|
||||
'default' => -1,
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'tax_status' => array(
|
||||
'description' => __( 'Tax status.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'default' => 'taxable',
|
||||
'enum' => array( 'taxable', 'shipping', 'none' ),
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'tax_class' => array(
|
||||
'description' => __( 'Tax class.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'manage_stock' => array(
|
||||
'description' => __( 'Stock management at variation level.', 'woocommerce' ),
|
||||
'type' => 'boolean',
|
||||
'default' => false,
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'stock_quantity' => array(
|
||||
'description' => __( 'Stock quantity.', 'woocommerce' ),
|
||||
'type' => 'integer',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'stock_status' => array(
|
||||
'description' => __( 'Controls the stock status of the product.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'default' => 'instock',
|
||||
'enum' => array_keys( wc_get_product_stock_status_options() ),
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'backorders' => array(
|
||||
'description' => __( 'If managing stock, this controls if backorders are allowed.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'default' => 'no',
|
||||
'enum' => array( 'no', 'notify', 'yes' ),
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'backorders_allowed' => array(
|
||||
'description' => __( 'Shows if backorders are allowed.', 'woocommerce' ),
|
||||
'type' => 'boolean',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
'backordered' => array(
|
||||
'description' => __( 'Shows if the variation is on backordered.', 'woocommerce' ),
|
||||
'type' => 'boolean',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
'weight' => array(
|
||||
/* translators: %s: weight unit */
|
||||
'description' => sprintf( __( 'Variation weight (%s).', 'woocommerce' ), $weight_unit ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'dimensions' => array(
|
||||
'description' => __( 'Variation dimensions.', 'woocommerce' ),
|
||||
'type' => 'object',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'properties' => array(
|
||||
'length' => array(
|
||||
/* translators: %s: dimension unit */
|
||||
'description' => sprintf( __( 'Variation length (%s).', 'woocommerce' ), $dimension_unit ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'width' => array(
|
||||
/* translators: %s: dimension unit */
|
||||
'description' => sprintf( __( 'Variation width (%s).', 'woocommerce' ), $dimension_unit ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'height' => array(
|
||||
/* translators: %s: dimension unit */
|
||||
'description' => sprintf( __( 'Variation height (%s).', 'woocommerce' ), $dimension_unit ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
),
|
||||
),
|
||||
'shipping_class' => array(
|
||||
'description' => __( 'Shipping class slug.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'shipping_class_id' => array(
|
||||
'description' => __( 'Shipping class ID.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
'image' => array(
|
||||
'description' => __( 'Variation image data.', 'woocommerce' ),
|
||||
'type' => 'object',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'properties' => array(
|
||||
'id' => array(
|
||||
'description' => __( 'Image ID.', 'woocommerce' ),
|
||||
'type' => 'integer',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'date_created' => array(
|
||||
'description' => __( "The date the image was created, in the site's timezone.", 'woocommerce' ),
|
||||
'type' => 'date-time',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
'date_created_gmt' => array(
|
||||
'description' => __( 'The date the image was created, as GMT.', 'woocommerce' ),
|
||||
'type' => 'date-time',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
'date_modified' => array(
|
||||
'description' => __( "The date the image was last modified, in the site's timezone.", 'woocommerce' ),
|
||||
'type' => 'date-time',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
'date_modified_gmt' => array(
|
||||
'description' => __( 'The date the image was last modified, as GMT.', 'woocommerce' ),
|
||||
'type' => 'date-time',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
'src' => array(
|
||||
'description' => __( 'Image URL.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'format' => 'uri',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'name' => array(
|
||||
'description' => __( 'Image name.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'alt' => array(
|
||||
'description' => __( 'Image alternative text.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
),
|
||||
),
|
||||
'attributes' => array(
|
||||
'description' => __( 'List of attributes.', 'woocommerce' ),
|
||||
'type' => 'array',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'items' => array(
|
||||
'type' => 'object',
|
||||
'properties' => array(
|
||||
'id' => array(
|
||||
'description' => __( 'Attribute ID.', 'woocommerce' ),
|
||||
'type' => 'integer',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'name' => array(
|
||||
'description' => __( 'Attribute name.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'option' => array(
|
||||
'description' => __( 'Selected attribute term name.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
),
|
||||
),
|
||||
),
|
||||
'menu_order' => array(
|
||||
'description' => __( 'Menu order, used to custom sort products.', 'woocommerce' ),
|
||||
'type' => 'integer',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'meta_data' => array(
|
||||
'description' => __( 'Meta data.', 'woocommerce' ),
|
||||
'type' => 'array',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'items' => array(
|
||||
'type' => 'object',
|
||||
'properties' => array(
|
||||
'id' => array(
|
||||
'description' => __( 'Meta ID.', 'woocommerce' ),
|
||||
'type' => 'integer',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
'readonly' => true,
|
||||
),
|
||||
'key' => array(
|
||||
'description' => __( 'Meta key.', 'woocommerce' ),
|
||||
'type' => 'string',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
'value' => array(
|
||||
'description' => __( 'Meta value.', 'woocommerce' ),
|
||||
'type' => 'mixed',
|
||||
'context' => array( 'view', 'edit' ),
|
||||
),
|
||||
),
|
||||
),
|
||||
),
|
||||
),
|
||||
);
|
||||
return $schema;
|
||||
}
|
||||
|
||||
/**
|
||||
* Convert object to match data in the schema.
|
||||
*
|
||||
* @param \WC_Product_Variation $object Product instance.
|
||||
* @param string $context Request context. Options: 'view' and 'edit'.
|
||||
* @return array
|
||||
*/
|
||||
public static function object_to_schema( $object, $context ) {
|
||||
$data = array(
|
||||
'id' => $object->get_id(),
|
||||
'name' => $object->get_name( $context ),
|
||||
'type' => $object->get_type(),
|
||||
'parent_id' => $object->get_parent_id( $context ),
|
||||
'date_created' => wc_rest_prepare_date_response( $object->get_date_created(), false ),
|
||||
'date_created_gmt' => wc_rest_prepare_date_response( $object->get_date_created() ),
|
||||
'date_modified' => wc_rest_prepare_date_response( $object->get_date_modified(), false ),
|
||||
'date_modified_gmt' => wc_rest_prepare_date_response( $object->get_date_modified() ),
|
||||
'description' => wc_format_content( $object->get_description() ),
|
||||
'permalink' => $object->get_permalink(),
|
||||
'sku' => $object->get_sku(),
|
||||
'price' => $object->get_price(),
|
||||
'regular_price' => $object->get_regular_price(),
|
||||
'sale_price' => $object->get_sale_price(),
|
||||
'date_on_sale_from' => wc_rest_prepare_date_response( $object->get_date_on_sale_from(), false ),
|
||||
'date_on_sale_from_gmt' => wc_rest_prepare_date_response( $object->get_date_on_sale_from() ),
|
||||
'date_on_sale_to' => wc_rest_prepare_date_response( $object->get_date_on_sale_to(), false ),
|
||||
'date_on_sale_to_gmt' => wc_rest_prepare_date_response( $object->get_date_on_sale_to() ),
|
||||
'on_sale' => $object->is_on_sale(),
|
||||
'status' => $object->get_status(),
|
||||
'purchasable' => $object->is_purchasable(),
|
||||
'virtual' => $object->is_virtual(),
|
||||
'downloadable' => $object->is_downloadable(),
|
||||
'downloads' => self::get_downloads( $object ),
|
||||
'download_limit' => '' !== $object->get_download_limit() ? (int) $object->get_download_limit() : -1,
|
||||
'download_expiry' => '' !== $object->get_download_expiry() ? (int) $object->get_download_expiry() : -1,
|
||||
'tax_status' => $object->get_tax_status(),
|
||||
'tax_class' => $object->get_tax_class(),
|
||||
'manage_stock' => $object->managing_stock(),
|
||||
'stock_quantity' => $object->get_stock_quantity(),
|
||||
'stock_status' => $object->get_stock_status(),
|
||||
'backorders' => $object->get_backorders(),
|
||||
'backorders_allowed' => $object->backorders_allowed(),
|
||||
'backordered' => $object->is_on_backorder(),
|
||||
'weight' => $object->get_weight(),
|
||||
'dimensions' => array(
|
||||
'length' => $object->get_length(),
|
||||
'width' => $object->get_width(),
|
||||
'height' => $object->get_height(),
|
||||
),
|
||||
'shipping_class' => $object->get_shipping_class(),
|
||||
'shipping_class_id' => $object->get_shipping_class_id(),
|
||||
'image' => self::get_image( $object ),
|
||||
'attributes' => self::get_attributes( $object ),
|
||||
'menu_order' => $object->get_menu_order(),
|
||||
'meta_data' => $object->get_meta_data(),
|
||||
);
|
||||
return $data;
|
||||
}
|
||||
|
||||
/**
|
||||
* Take data in the format of the schema and convert to a product object.
|
||||
*
|
||||
* @param \WP_REST_Request $request Request object.
|
||||
* @return \WP_Error|\WC_Product_Variation
|
||||
*/
|
||||
public static function schema_to_object( $request ) {
|
||||
if ( isset( $request['id'] ) ) {
|
||||
$object = wc_get_product( absint( $request['id'] ) );
|
||||
} else {
|
||||
$object = new \WC_Product_Variation();
|
||||
}
|
||||
|
||||
$object->set_parent_id( absint( $request['product_id'] ) );
|
||||
|
||||
self::set_object_data( $object, $request );
|
||||
|
||||
return $object;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set object data from a request.
|
||||
*
|
||||
* @param \WC_Product_Variation $object Product object.
|
||||
* @param \WP_REST_Request $request Request object.
|
||||
*/
|
||||
protected static function set_object_data( &$object, $request ) {
|
||||
$values = $request->get_params();
|
||||
$prop_keys = [
|
||||
'status',
|
||||
'sku',
|
||||
'virtual',
|
||||
'downloadable',
|
||||
'download_limit',
|
||||
'download_expiry',
|
||||
'manage_stock',
|
||||
'stock_status',
|
||||
'backorders',
|
||||
'regular_price',
|
||||
'sale_price',
|
||||
'date_on_sale_from',
|
||||
'date_on_sale_from_gmt',
|
||||
'date_on_sale_to',
|
||||
'date_on_sale_to_gmt',
|
||||
'tax_class',
|
||||
'description',
|
||||
'menu_order',
|
||||
'stock_quantity',
|
||||
];
|
||||
|
||||
$props_to_set = array_intersect_key( $values, array_flip( $prop_keys ) );
|
||||
$props_to_set = array_filter(
|
||||
$props_to_set,
|
||||
function ( $prop ) use ( $object ) {
|
||||
return is_callable( array( $object, "set_$prop" ) );
|
||||
},
|
||||
ARRAY_FILTER_USE_KEY
|
||||
);
|
||||
|
||||
foreach ( $props_to_set as $prop => $value ) {
|
||||
$object->{"set_$prop"}( $value );
|
||||
}
|
||||
|
||||
// Allow set meta_data.
|
||||
if ( isset( $values['meta_data'] ) ) {
|
||||
foreach ( $values['meta_data'] as $meta ) {
|
||||
$object->update_meta_data( $meta['key'], $meta['value'], isset( $meta['id'] ) ? $meta['id'] : '' );
|
||||
}
|
||||
}
|
||||
|
||||
// Check for featured/gallery images, upload it and set it.
|
||||
if ( isset( $values['image'] ) ) {
|
||||
self::set_image( $object, $values['image'] );
|
||||
}
|
||||
|
||||
// Downloadable files.
|
||||
if ( isset( $values['downloads'] ) && is_array( $values['downloads'] ) ) {
|
||||
self::set_downloadable_files( $object, $values['downloads'] );
|
||||
}
|
||||
|
||||
if ( isset( $values['attributes'] ) ) {
|
||||
self::set_attributes( $object, $values['attributes'] );
|
||||
}
|
||||
|
||||
self::set_shipping_data( $object, $values );
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the image for a product variation.
|
||||
*
|
||||
* @param \WC_Product_Variation $object Variation data.
|
||||
* @return array
|
||||
*/
|
||||
protected static function get_image( $object ) {
|
||||
if ( ! $object->get_image_id() ) {
|
||||
return;
|
||||
}
|
||||
|
||||
$attachment_id = $object->get_image_id();
|
||||
$attachment_post = get_post( $attachment_id );
|
||||
if ( is_null( $attachment_post ) ) {
|
||||
return;
|
||||
}
|
||||
|
||||
$attachment = wp_get_attachment_image_src( $attachment_id, 'full' );
|
||||
if ( ! is_array( $attachment ) ) {
|
||||
return;
|
||||
}
|
||||
|
||||
if ( ! isset( $image ) ) {
|
||||
return array(
|
||||
'id' => (int) $attachment_id,
|
||||
'date_created' => wc_rest_prepare_date_response( $attachment_post->post_date, false ),
|
||||
'date_created_gmt' => wc_rest_prepare_date_response( strtotime( $attachment_post->post_date_gmt ) ),
|
||||
'date_modified' => wc_rest_prepare_date_response( $attachment_post->post_modified, false ),
|
||||
'date_modified_gmt' => wc_rest_prepare_date_response( strtotime( $attachment_post->post_modified_gmt ) ),
|
||||
'src' => current( $attachment ),
|
||||
'name' => get_the_title( $attachment_id ),
|
||||
'alt' => get_post_meta( $attachment_id, '_wp_attachment_image_alt', true ),
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Set product object's attributes.
|
||||
*
|
||||
* @param \WC_Product_Variation $object Product object.
|
||||
* @param array $raw_attributes Attribute data from request.
|
||||
*/
|
||||
protected static function set_attributes( &$object, $raw_attributes ) {
|
||||
$attributes = array();
|
||||
$parent = wc_get_product( $object->get_parent_id() );
|
||||
|
||||
if ( ! $parent ) {
|
||||
return new \WP_Error(
|
||||
// Translators: %d parent ID.
|
||||
"woocommerce_rest_product_variation_invalid_parent", sprintf( __( 'Cannot set attributes due to invalid parent product.', 'woocommerce' ), $object->get_parent_id() ), array(
|
||||
'status' => 404,
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
$parent_attributes = $parent->get_attributes();
|
||||
|
||||
foreach ( $raw_attributes as $attribute ) {
|
||||
$attribute_id = 0;
|
||||
$attribute_name = '';
|
||||
|
||||
// Check ID for global attributes or name for product attributes.
|
||||
if ( ! empty( $attribute['id'] ) ) {
|
||||
$attribute_id = absint( $attribute['id'] );
|
||||
$attribute_name = wc_attribute_taxonomy_name_by_id( $attribute_id );
|
||||
} elseif ( ! empty( $attribute['name'] ) ) {
|
||||
$attribute_name = sanitize_title( $attribute['name'] );
|
||||
}
|
||||
|
||||
if ( ! $attribute_id && ! $attribute_name ) {
|
||||
continue;
|
||||
}
|
||||
|
||||
if ( ! isset( $parent_attributes[ $attribute_name ] ) || ! $parent_attributes[ $attribute_name ]->get_variation() ) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$attribute_key = sanitize_title( $parent_attributes[ $attribute_name ]->get_name() );
|
||||
$attribute_value = isset( $attribute['option'] ) ? wc_clean( stripslashes( $attribute['option'] ) ) : '';
|
||||
|
||||
if ( $parent_attributes[ $attribute_name ]->is_taxonomy() ) {
|
||||
// If dealing with a taxonomy, we need to get the slug from the name posted to the API.
|
||||
$term = get_term_by( 'name', $attribute_value, $attribute_name );
|
||||
|
||||
if ( $term && ! is_wp_error( $term ) ) {
|
||||
$attribute_value = $term->slug;
|
||||
} else {
|
||||
$attribute_value = sanitize_title( $attribute_value );
|
||||
}
|
||||
}
|
||||
|
||||
$attributes[ $attribute_key ] = $attribute_value;
|
||||
}
|
||||
|
||||
$object->set_attributes( $attributes );
|
||||
}
|
||||
|
||||
/**
|
||||
* Set product images.
|
||||
*
|
||||
* @throws \WC_REST_Exception REST API exceptions.
|
||||
*
|
||||
* @param \WC_Product_Variation $object Product instance.
|
||||
* @param array $image Image data.
|
||||
*/
|
||||
protected static function set_image( &$object, $image ) {
|
||||
if ( ! empty( $image ) ) {
|
||||
$attachment_id = isset( $image['id'] ) ? absint( $image['id'] ) : 0;
|
||||
|
||||
if ( 0 === $attachment_id && isset( $image['src'] ) ) {
|
||||
$upload = wc_rest_upload_image_from_url( esc_url_raw( $image['src'] ) );
|
||||
|
||||
if ( is_wp_error( $upload ) ) {
|
||||
if ( ! apply_filters( 'woocommerce_rest_suppress_image_upload_error', false, $upload, $object->get_id(), array( $image ) ) ) {
|
||||
throw new \WC_REST_Exception( 'woocommerce_variation_image_upload_error', $upload->get_error_message(), 400 );
|
||||
}
|
||||
}
|
||||
|
||||
$attachment_id = wc_rest_set_uploaded_image_as_attachment( $upload, $object->get_id() );
|
||||
}
|
||||
|
||||
if ( ! wp_attachment_is_image( $attachment_id ) ) {
|
||||
/* translators: %s: attachment ID */
|
||||
throw new \WC_REST_Exception( 'woocommerce_variation_invalid_image_id', sprintf( __( '#%s is an invalid image ID.', 'woocommerce' ), $attachment_id ), 400 );
|
||||
}
|
||||
|
||||
$object->set_image_id( $attachment_id );
|
||||
|
||||
// Set the image alt if present.
|
||||
if ( ! empty( $image['alt'] ) ) {
|
||||
update_post_meta( $attachment_id, '_wp_attachment_image_alt', wc_clean( $image['alt'] ) );
|
||||
}
|
||||
|
||||
// Set the image name if present.
|
||||
if ( ! empty( $image['name'] ) ) {
|
||||
wp_update_post(
|
||||
array(
|
||||
'ID' => $attachment_id,
|
||||
'post_title' => $image['name'],
|
||||
)
|
||||
);
|
||||
}
|
||||
} else {
|
||||
$object->set_image_id( '' );
|
||||
}
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue