<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* REST API Product Attribute Terms Controller

[2] Fix | Delete

*

[3] Fix | Delete

* Handles requests to /products/attributes/<slug>/terms

[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 attribute terms controller.

[12] Fix | Delete

*

[13] Fix | Delete

* @internal

[14] Fix | Delete

* @extends WC_REST_Product_Attribute_Terms_Controller

[15] Fix | Delete

*/

[16] Fix | Delete

class ProductAttributeTerms extends \WC_REST_Product_Attribute_Terms_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

/**

[28] Fix | Delete

* Register the routes for custom product attributes.

[29] Fix | Delete

*/

[30] Fix | Delete

public function register_routes() {

[31] Fix | Delete

parent::register_routes();

[32] Fix | Delete

[33] Fix | Delete

register_rest_route(

[34] Fix | Delete

$this->namespace,

[35] Fix | Delete

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

[36] Fix | Delete

array(

[37] Fix | Delete

'args' => array(

[38] Fix | Delete

'slug' => array(

[39] Fix | Delete

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

[40] Fix | Delete

'type' => 'string',

[41] Fix | Delete

),

[42] Fix | Delete

),

[43] Fix | Delete

array(

[44] Fix | Delete

'methods' => \WP_REST_Server::READABLE,

[45] Fix | Delete

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

[46] Fix | Delete

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

[47] Fix | Delete

'args' => $this->get_collection_params(),

[48] Fix | Delete

),

[49] Fix | Delete

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

[50] Fix | Delete

)

[51] Fix | Delete

);

[52] Fix | Delete

}

[53] Fix | Delete

[54] Fix | Delete

/**

[55] Fix | Delete

* Check if a given request has access to read a custom attribute.

[56] Fix | Delete

*

[57] Fix | Delete

* @param WP_REST_Request $request Full details about the request.

[58] Fix | Delete

* @return WP_Error|boolean

[59] Fix | Delete

*/

[60] Fix | Delete

public function get_custom_attribute_permissions_check( $request ) {

[61] Fix | Delete

if ( ! wc_rest_check_manager_permissions( 'attributes', 'read' ) ) {

[62] Fix | Delete

return new WP_Error(

[63] Fix | Delete

'woocommerce_rest_cannot_view',

[64] Fix | Delete

__( 'Sorry, you cannot view this resource.', 'woocommerce' ),

[65] Fix | Delete

array(

[66] Fix | Delete

'status' => rest_authorization_required_code(),

[67] Fix | Delete

)

[68] Fix | Delete

);

[69] Fix | Delete

}

[70] Fix | Delete

[71] Fix | Delete

return true;

[72] Fix | Delete

}

[73] Fix | Delete

[74] Fix | Delete

/**

[75] Fix | Delete

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

[76] Fix | Delete

*

[77] Fix | Delete

* @return array

[78] Fix | Delete

*/

[79] Fix | Delete

public function get_item_schema() {

[80] Fix | Delete

$schema = parent::get_item_schema();

[81] Fix | Delete

// Custom attributes substitute slugs for numeric IDs.

[82] Fix | Delete

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

[83] Fix | Delete

[84] Fix | Delete

return $schema;

[85] Fix | Delete

}

[86] Fix | Delete

[87] Fix | Delete

/**

[88] Fix | Delete

* Query custom attribute values by slug.

[89] Fix | Delete

*

[90] Fix | Delete

* @param string $slug Attribute slug.

[91] Fix | Delete

* @return array Attribute values, formatted for response.

[92] Fix | Delete

*/

[93] Fix | Delete

protected function get_custom_attribute_values( $slug ) {

[94] Fix | Delete

global $wpdb;

[95] Fix | Delete

[96] Fix | Delete

if ( empty( $slug ) ) {

[97] Fix | Delete

return array();

[98] Fix | Delete

}

[99] Fix | Delete

[100] Fix | Delete

$attribute_values = array();

[101] Fix | Delete

[102] Fix | Delete

// Get the attribute properties.

[103] Fix | Delete

$attribute = $this->get_custom_attribute_by_slug( $slug );

[104] Fix | Delete

[105] Fix | Delete

if ( is_wp_error( $attribute ) ) {

[106] Fix | Delete

return $attribute;

[107] Fix | Delete

}

[108] Fix | Delete

[109] Fix | Delete

// Find all attribute values assigned to products.

[110] Fix | Delete

$query_results = $wpdb->get_results(

[111] Fix | Delete

$wpdb->prepare(

[112] Fix | Delete

"SELECT meta_value, COUNT(meta_id) AS product_count

[113] Fix | Delete

FROM {$wpdb->postmeta}

[114] Fix | Delete

WHERE meta_key = %s

[115] Fix | Delete

AND meta_value != ''

[116] Fix | Delete

GROUP BY meta_value",

[117] Fix | Delete

'attribute_' . esc_sql( $slug )

[118] Fix | Delete

),

[119] Fix | Delete

OBJECT_K

[120] Fix | Delete

);

[121] Fix | Delete

[122] Fix | Delete

// Ensure all defined properties are in the response.

[123] Fix | Delete

$defined_values = wc_get_text_attributes( $attribute[ $slug ]['value'] );

[124] Fix | Delete

[125] Fix | Delete

foreach ( $defined_values as $defined_value ) {

[126] Fix | Delete

if ( array_key_exists( $defined_value, $query_results ) ) {

[127] Fix | Delete

continue;

[128] Fix | Delete

}

[129] Fix | Delete

[130] Fix | Delete

$query_results[ $defined_value ] = (object) array(

[131] Fix | Delete

'meta_value' => $defined_value, // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_value

[132] Fix | Delete

'product_count' => 0,

[133] Fix | Delete

);

[134] Fix | Delete

}

[135] Fix | Delete

[136] Fix | Delete

foreach ( $query_results as $term_value => $term ) {

[137] Fix | Delete

// Mimic the structure of a taxonomy-backed attribute values for response.

[138] Fix | Delete

$data = array(

[139] Fix | Delete

'id' => $term_value,

[140] Fix | Delete

'name' => $term_value,

[141] Fix | Delete

'slug' => $term_value,

[142] Fix | Delete

'description' => '',

[143] Fix | Delete

'menu_order' => 0,

[144] Fix | Delete

'count' => (int) $term->product_count,

[145] Fix | Delete

);

[146] Fix | Delete

[147] Fix | Delete

$response = rest_ensure_response( $data );

[148] Fix | Delete

$response->add_links(

[149] Fix | Delete

array(

[150] Fix | Delete

'collection' => array(

[151] Fix | Delete

'href' => rest_url(

[152] Fix | Delete

$this->namespace . '/products/attributes/' . $slug . '/terms'

[153] Fix | Delete

),

[154] Fix | Delete

),

[155] Fix | Delete

)

[156] Fix | Delete

);

[157] Fix | Delete

$response = $this->prepare_response_for_collection( $response );

[158] Fix | Delete

[159] Fix | Delete

$attribute_values[ $term_value ] = $response;

[160] Fix | Delete

}

[161] Fix | Delete

[162] Fix | Delete

return array_values( $attribute_values );

[163] Fix | Delete

}

[164] Fix | Delete

[165] Fix | Delete

/**

[166] Fix | Delete

* Get a single custom attribute.

[167] Fix | Delete

*

[168] Fix | Delete

* @param WP_REST_Request $request Full details about the request.

[169] Fix | Delete

* @return WP_REST_Request|WP_Error

[170] Fix | Delete

*/

[171] Fix | Delete

public function get_item_by_slug( $request ) {

[172] Fix | Delete

return $this->get_custom_attribute_values( $request['slug'] );

[173] Fix | Delete

}

[174] Fix | Delete

}

[175] Fix | Delete

[176] Fix | Delete