<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* REST API Product Attributes Controller

[2] Fix | Delete

*

[3] Fix | Delete

* Handles requests to /products/attributes.

[4] Fix | Delete

*/

[5] Fix | Delete

[6] Fix | Delete

namespace Automattic\WooCommerce\Admin\API;

[7] Fix | Delete

[8] Fix | Delete

defined( 'ABSPATH' ) || exit;

[9] Fix | Delete

[10] Fix | Delete

/**

[11] Fix | Delete

* Product categories controller.

[12] Fix | Delete

*

[13] Fix | Delete

* @internal

[14] Fix | Delete

* @extends WC_REST_Product_Attributes_Controller

[15] Fix | Delete

*/

[16] Fix | Delete

class ProductAttributes extends \WC_REST_Product_Attributes_Controller {

[17] Fix | Delete

use CustomAttributeTraits;

[18] Fix | Delete

[19] Fix | Delete

/**

[20] Fix | Delete

* Endpoint namespace.

[21] Fix | Delete

*

[22] Fix | Delete

* @var string

[23] Fix | Delete

*/

[24] Fix | Delete

protected $namespace = 'wc-analytics';

[25] Fix | Delete

[26] Fix | Delete

/**

[27] Fix | Delete

* Register the routes for custom product attributes.

[28] Fix | Delete

*/

[29] Fix | Delete

public function register_routes() {

[30] Fix | Delete

parent::register_routes();

[31] Fix | Delete

[32] Fix | Delete

register_rest_route(

[33] Fix | Delete

$this->namespace,

[34] Fix | Delete

'products/attributes/(?P<slug>[a-z0-9_\-]+)',

[35] Fix | Delete

array(

[36] Fix | Delete

'args' => array(

[37] Fix | Delete

'slug' => array(

[38] Fix | Delete

'description' => __( 'Slug identifier for the resource.', 'woocommerce' ),

[39] Fix | Delete

'type' => 'string',

[40] Fix | Delete

),

[41] Fix | Delete

),

[42] Fix | Delete

array(

[43] Fix | Delete

'methods' => \WP_REST_Server::READABLE,

[44] Fix | Delete

'callback' => array( $this, 'get_item_by_slug' ),

[45] Fix | Delete

'permission_callback' => array( $this, 'get_items_permissions_check' ),

[46] Fix | Delete

),

[47] Fix | Delete

'schema' => array( $this, 'get_public_item_schema' ),

[48] Fix | Delete

)

[49] Fix | Delete

);

[50] Fix | Delete

}

[51] Fix | Delete

[52] Fix | Delete

/**

[53] Fix | Delete

* Get the query params for collections

[54] Fix | Delete

*

[55] Fix | Delete

* @return array

[56] Fix | Delete

*/

[57] Fix | Delete

public function get_collection_params() {

[58] Fix | Delete

$params = parent::get_collection_params();

[59] Fix | Delete

$params['search'] = array(

[60] Fix | Delete

'description' => __( 'Search by similar attribute name.', 'woocommerce' ),

[61] Fix | Delete

'type' => 'string',

[62] Fix | Delete

'validate_callback' => 'rest_validate_request_arg',

[63] Fix | Delete

);

[64] Fix | Delete

[65] Fix | Delete

return $params;

[66] Fix | Delete

}

[67] Fix | Delete

[68] Fix | Delete

/**

[69] Fix | Delete

* Get the Attribute's schema, conforming to JSON Schema.

[70] Fix | Delete

*

[71] Fix | Delete

* @return array

[72] Fix | Delete

*/

[73] Fix | Delete

public function get_item_schema() {

[74] Fix | Delete

$schema = parent::get_item_schema();

[75] Fix | Delete

// Custom attributes substitute slugs for numeric IDs.

[76] Fix | Delete

$schema['properties']['id']['type'] = array( 'integer', 'string' );

[77] Fix | Delete

[78] Fix | Delete

return $schema;

[79] Fix | Delete

}

[80] Fix | Delete

[81] Fix | Delete

/**

[82] Fix | Delete

* Get a single attribute by it's slug.

[83] Fix | Delete

*

[84] Fix | Delete

* @param WP_REST_Request $request The API request.

[85] Fix | Delete

* @return WP_REST_Response

[86] Fix | Delete

*/

[87] Fix | Delete

public function get_item_by_slug( $request ) {

[88] Fix | Delete

if ( empty( $request['slug'] ) ) {

[89] Fix | Delete

return array();

[90] Fix | Delete

}

[91] Fix | Delete

[92] Fix | Delete

$attributes = $this->get_custom_attribute_by_slug( $request['slug'] );

[93] Fix | Delete

[94] Fix | Delete

if ( is_wp_error( $attributes ) ) {

[95] Fix | Delete

return $attributes;

[96] Fix | Delete

}

[97] Fix | Delete

[98] Fix | Delete

$response_items = $this->format_custom_attribute_items_for_response( $attributes );

[99] Fix | Delete

[100] Fix | Delete

return reset( $response_items );

[101] Fix | Delete

}

[102] Fix | Delete

[103] Fix | Delete

/**

[104] Fix | Delete

* Format custom attribute items for response (mimic the structure of a taxonomy - backed attribute).

[105] Fix | Delete

*

[106] Fix | Delete

* @param array $custom_attributes - CustomAttributeTraits::get_custom_attributes().

[107] Fix | Delete

* @return array

[108] Fix | Delete

*/

[109] Fix | Delete

protected function format_custom_attribute_items_for_response( $custom_attributes ) {

[110] Fix | Delete

$response = array();

[111] Fix | Delete

[112] Fix | Delete

foreach ( $custom_attributes as $attribute_key => $attribute_value ) {

[113] Fix | Delete

$data = array(

[114] Fix | Delete

'id' => $attribute_key,

[115] Fix | Delete

'name' => $attribute_value['name'],

[116] Fix | Delete

'slug' => $attribute_key,

[117] Fix | Delete

'type' => 'select',

[118] Fix | Delete

'order_by' => 'menu_order',

[119] Fix | Delete

'has_archives' => false,

[120] Fix | Delete

);

[121] Fix | Delete

[122] Fix | Delete

$item_response = rest_ensure_response( $data );

[123] Fix | Delete

$item_response->add_links( $this->prepare_links( (object) array( 'attribute_id' => $attribute_key ) ) );

[124] Fix | Delete

$item_response = $this->prepare_response_for_collection(

[125] Fix | Delete

$item_response

[126] Fix | Delete

);

[127] Fix | Delete

[128] Fix | Delete

$response[] = $item_response;

[129] Fix | Delete

}

[130] Fix | Delete

[131] Fix | Delete

return $response;

[132] Fix | Delete

}

[133] Fix | Delete

[134] Fix | Delete

/**

[135] Fix | Delete

* Get all attributes, with support for searching (which includes custom attributes).

[136] Fix | Delete

*

[137] Fix | Delete

* @param WP_REST_Request $request The API request.

[138] Fix | Delete

* @return WP_REST_Response

[139] Fix | Delete

*/

[140] Fix | Delete

public function get_items( $request ) {

[141] Fix | Delete

if ( empty( $request['search'] ) ) {

[142] Fix | Delete

return parent::get_items( $request );

[143] Fix | Delete

}

[144] Fix | Delete

[145] Fix | Delete

$search_string = $request['search'];

[146] Fix | Delete

$custom_attributes = $this->get_custom_attributes( array( 'name' => $search_string ) );

[147] Fix | Delete

$matching_attributes = $this->format_custom_attribute_items_for_response( $custom_attributes );

[148] Fix | Delete

$taxonomy_attributes = wc_get_attribute_taxonomies();

[149] Fix | Delete

[150] Fix | Delete

foreach ( $taxonomy_attributes as $attribute_obj ) {

[151] Fix | Delete

// Skip taxonomy attributes that didn't match the query.

[152] Fix | Delete

if ( false === stripos( $attribute_obj->attribute_label, $search_string ) ) {

[153] Fix | Delete

continue;

[154] Fix | Delete

}

[155] Fix | Delete

[156] Fix | Delete

$attribute = $this->prepare_item_for_response( $attribute_obj, $request );

[157] Fix | Delete

$matching_attributes[] = $this->prepare_response_for_collection( $attribute );

[158] Fix | Delete

}

[159] Fix | Delete

[160] Fix | Delete

$response = rest_ensure_response( $matching_attributes );

[161] Fix | Delete

$response->header( 'X-WP-Total', count( $matching_attributes ) );

[162] Fix | Delete

$response->header( 'X-WP-TotalPages', 1 );

[163] Fix | Delete

[164] Fix | Delete

return $response;

[165] Fix | Delete

}

[166] Fix | Delete

}

[167] Fix | Delete

[168] Fix | Delete