<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* REST API Taxes Controller

[2] Fix | Delete

*

[3] Fix | Delete

* Handles requests to /taxes/*

[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

* Taxes controller.

[12] Fix | Delete

*

[13] Fix | Delete

* @internal

[14] Fix | Delete

* @extends WC_REST_Taxes_Controller

[15] Fix | Delete

*/

[16] Fix | Delete

class Taxes extends \WC_REST_Taxes_Controller {

[17] Fix | Delete

[18] Fix | Delete

/**

[19] Fix | Delete

* Endpoint namespace.

[20] Fix | Delete

*

[21] Fix | Delete

* @var string

[22] Fix | Delete

*/

[23] Fix | Delete

protected $namespace = 'wc-analytics';

[24] Fix | Delete

[25] Fix | Delete

/**

[26] Fix | Delete

* Get the query params for collections.

[27] Fix | Delete

*

[28] Fix | Delete

* @return array

[29] Fix | Delete

*/

[30] Fix | Delete

public function get_collection_params() {

[31] Fix | Delete

$params = parent::get_collection_params();

[32] Fix | Delete

$params['search'] = array(

[33] Fix | Delete

'description' => __( 'Search by similar tax code.', 'woocommerce' ),

[34] Fix | Delete

'type' => 'string',

[35] Fix | Delete

'validate_callback' => 'rest_validate_request_arg',

[36] Fix | Delete

);

[37] Fix | Delete

$params['include'] = array(

[38] Fix | Delete

'description' => __( 'Limit result set to items that have the specified rate ID(s) assigned.', 'woocommerce' ),

[39] Fix | Delete

'type' => 'array',

[40] Fix | Delete

'items' => array(

[41] Fix | Delete

'type' => 'integer',

[42] Fix | Delete

),

[43] Fix | Delete

'default' => array(),

[44] Fix | Delete

'validate_callback' => 'rest_validate_request_arg',

[45] Fix | Delete

);

[46] Fix | Delete

return $params;

[47] Fix | Delete

}

[48] Fix | Delete

[49] Fix | Delete

/**

[50] Fix | Delete

* Get all taxes and allow filtering by tax code.

[51] Fix | Delete

*

[52] Fix | Delete

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

[53] Fix | Delete

* @return WP_Error|WP_REST_Response

[54] Fix | Delete

*/

[55] Fix | Delete

public function get_items( $request ) {

[56] Fix | Delete

global $wpdb;

[57] Fix | Delete

[58] Fix | Delete

$prepared_args = array();

[59] Fix | Delete

$prepared_args['order'] = $request['order'];

[60] Fix | Delete

$prepared_args['number'] = $request['per_page'];

[61] Fix | Delete

if ( ! empty( $request['offset'] ) ) {

[62] Fix | Delete

$prepared_args['offset'] = $request['offset'];

[63] Fix | Delete

} else {

[64] Fix | Delete

$prepared_args['offset'] = ( $request['page'] - 1 ) * $prepared_args['number'];

[65] Fix | Delete

}

[66] Fix | Delete

$orderby_possibles = array(

[67] Fix | Delete

'id' => 'tax_rate_id',

[68] Fix | Delete

'order' => 'tax_rate_order',

[69] Fix | Delete

);

[70] Fix | Delete

$prepared_args['orderby'] = $orderby_possibles[ $request['orderby'] ];

[71] Fix | Delete

$prepared_args['class'] = $request['class'];

[72] Fix | Delete

$prepared_args['search'] = $request['search'];

[73] Fix | Delete

$prepared_args['include'] = $request['include'];

[74] Fix | Delete

[75] Fix | Delete

/**

[76] Fix | Delete

* Filter arguments, before passing to $wpdb->get_results(), when querying taxes via the REST API.

[77] Fix | Delete

*

[78] Fix | Delete

* @param array $prepared_args Array of arguments for $wpdb->get_results().

[79] Fix | Delete

* @param WP_REST_Request $request The current request.

[80] Fix | Delete

*/

[81] Fix | Delete

$prepared_args = apply_filters( 'woocommerce_rest_tax_query', $prepared_args, $request );

[82] Fix | Delete

[83] Fix | Delete

$query = "

[84] Fix | Delete

SELECT *

[85] Fix | Delete

FROM {$wpdb->prefix}woocommerce_tax_rates

[86] Fix | Delete

WHERE 1 = 1

[87] Fix | Delete

";

[88] Fix | Delete

[89] Fix | Delete

// Filter by tax class.

[90] Fix | Delete

if ( ! empty( $prepared_args['class'] ) ) {

[91] Fix | Delete

$class = 'standard' !== $prepared_args['class'] ? sanitize_title( $prepared_args['class'] ) : '';

[92] Fix | Delete

$query .= " AND tax_rate_class = '$class'";

[93] Fix | Delete

}

[94] Fix | Delete

[95] Fix | Delete

// Filter by tax code.

[96] Fix | Delete

$tax_code_search = $prepared_args['search'];

[97] Fix | Delete

if ( $tax_code_search ) {

[98] Fix | Delete

$code_like = '%' . $wpdb->esc_like( $tax_code_search ) . '%';

[99] Fix | Delete

$query .= $wpdb->prepare( ' AND CONCAT_WS( "-", NULLIF(tax_rate_country, ""), NULLIF(tax_rate_state, ""), NULLIF(tax_rate_name, ""), NULLIF(tax_rate_priority, "") ) LIKE %s', $code_like );

[100] Fix | Delete

}

[101] Fix | Delete

[102] Fix | Delete

// Filter by included tax rate IDs.

[103] Fix | Delete

$included_taxes = array_map( 'absint', $prepared_args['include'] );

[104] Fix | Delete

if ( ! empty( $included_taxes ) ) {

[105] Fix | Delete

$included_taxes = implode( ',', $prepared_args['include'] );

[106] Fix | Delete

$query .= " AND tax_rate_id IN ({$included_taxes})";

[107] Fix | Delete

}

[108] Fix | Delete

[109] Fix | Delete

// Order tax rates.

[110] Fix | Delete

$order_by = sprintf( ' ORDER BY %s', sanitize_key( $prepared_args['orderby'] ) );

[111] Fix | Delete

[112] Fix | Delete

// Pagination.

[113] Fix | Delete

$pagination = sprintf( ' LIMIT %d, %d', $prepared_args['offset'], $prepared_args['number'] );

[114] Fix | Delete

[115] Fix | Delete

// Query taxes.

[116] Fix | Delete

$results = $wpdb->get_results( $query . $order_by . $pagination ); // @codingStandardsIgnoreLine.

[117] Fix | Delete

[118] Fix | Delete

$taxes = array();

[119] Fix | Delete

foreach ( $results as $tax ) {

[120] Fix | Delete

$data = $this->prepare_item_for_response( $tax, $request );

[121] Fix | Delete

$taxes[] = $this->prepare_response_for_collection( $data );

[122] Fix | Delete

}

[123] Fix | Delete

[124] Fix | Delete

$response = rest_ensure_response( $taxes );

[125] Fix | Delete

[126] Fix | Delete

// Store pagination values for headers then unset for count query.

[127] Fix | Delete

$per_page = (int) $prepared_args['number'];

[128] Fix | Delete

$page = ceil( ( ( (int) $prepared_args['offset'] ) / $per_page ) + 1 );

[129] Fix | Delete

[130] Fix | Delete

// Query only for ids.

[131] Fix | Delete

$wpdb->get_results( str_replace( 'SELECT *', 'SELECT tax_rate_id', $query ) ); // @codingStandardsIgnoreLine.

[132] Fix | Delete

[133] Fix | Delete

// Calculate totals.

[134] Fix | Delete

$total_taxes = (int) $wpdb->num_rows;

[135] Fix | Delete

$response->header( 'X-WP-Total', (int) $total_taxes );

[136] Fix | Delete

$max_pages = ceil( $total_taxes / $per_page );

[137] Fix | Delete

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

[138] Fix | Delete

[139] Fix | Delete

$base = add_query_arg( $request->get_query_params(), rest_url( sprintf( '/%s/%s', $this->namespace, $this->rest_base ) ) );

[140] Fix | Delete

if ( $page > 1 ) {

[141] Fix | Delete

$prev_page = $page - 1;

[142] Fix | Delete

if ( $prev_page > $max_pages ) {

[143] Fix | Delete

$prev_page = $max_pages;

[144] Fix | Delete

}

[145] Fix | Delete

$prev_link = add_query_arg( 'page', $prev_page, $base );

[146] Fix | Delete

$response->link_header( 'prev', $prev_link );

[147] Fix | Delete

}

[148] Fix | Delete

if ( $max_pages > $page ) {

[149] Fix | Delete

$next_page = $page + 1;

[150] Fix | Delete

$next_link = add_query_arg( 'page', $next_page, $base );

[151] Fix | Delete

$response->link_header( 'next', $next_link );

[152] Fix | Delete

}

[153] Fix | Delete

[154] Fix | Delete

return $response;

[155] Fix | Delete

}

[156] Fix | Delete

}

[157] Fix | Delete

[158] Fix | Delete