<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* REST API Reports coupons controller

[2] Fix | Delete

*

[3] Fix | Delete

* Handles requests to the /reports/coupons endpoint.

[4] Fix | Delete

*/

[5] Fix | Delete

[6] Fix | Delete

namespace Automattic\WooCommerce\Admin\API\Reports\Coupons;

[7] Fix | Delete

[8] Fix | Delete

defined( 'ABSPATH' ) || exit;

[9] Fix | Delete

[10] Fix | Delete

use Automattic\WooCommerce\Admin\API\Reports\GenericController;

[11] Fix | Delete

use Automattic\WooCommerce\Admin\API\Reports\ExportableInterface;

[12] Fix | Delete

use Automattic\WooCommerce\Admin\API\Reports\GenericQuery;

[13] Fix | Delete

use WP_REST_Request;

[14] Fix | Delete

use WP_REST_Response;

[15] Fix | Delete

[16] Fix | Delete

/**

[17] Fix | Delete

* REST API Reports coupons controller class.

[18] Fix | Delete

*

[19] Fix | Delete

* @internal

[20] Fix | Delete

* @extends GenericController

[21] Fix | Delete

*/

[22] Fix | Delete

class Controller extends GenericController implements ExportableInterface {

[23] Fix | Delete

[24] Fix | Delete

/**

[25] Fix | Delete

* Route base.

[26] Fix | Delete

*

[27] Fix | Delete

* @var string

[28] Fix | Delete

*/

[29] Fix | Delete

protected $rest_base = 'reports/coupons';

[30] Fix | Delete

[31] Fix | Delete

/**

[32] Fix | Delete

* Get data from `'coupons'` GenericQuery.

[33] Fix | Delete

*

[34] Fix | Delete

* @override GenericController::get_datastore_data()

[35] Fix | Delete

*

[36] Fix | Delete

* @param array $query_args Query arguments.

[37] Fix | Delete

* @return mixed Results from the data store.

[38] Fix | Delete

*/

[39] Fix | Delete

protected function get_datastore_data( $query_args = array() ) {

[40] Fix | Delete

$query = new GenericQuery( $query_args, 'coupons' );

[41] Fix | Delete

return $query->get_data();

[42] Fix | Delete

}

[43] Fix | Delete

[44] Fix | Delete

/**

[45] Fix | Delete

* Maps query arguments from the REST request.

[46] Fix | Delete

*

[47] Fix | Delete

* @param array $request Request array.

[48] Fix | Delete

* @return array

[49] Fix | Delete

*/

[50] Fix | Delete

protected function prepare_reports_query( $request ) {

[51] Fix | Delete

$args = array();

[52] Fix | Delete

$args['before'] = $request['before'];

[53] Fix | Delete

$args['after'] = $request['after'];

[54] Fix | Delete

$args['page'] = $request['page'];

[55] Fix | Delete

$args['per_page'] = $request['per_page'];

[56] Fix | Delete

$args['orderby'] = $request['orderby'];

[57] Fix | Delete

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

[58] Fix | Delete

$args['coupons'] = (array) $request['coupons'];

[59] Fix | Delete

$args['extended_info'] = $request['extended_info'];

[60] Fix | Delete

$args['force_cache_refresh'] = $request['force_cache_refresh'];

[61] Fix | Delete

return $args;

[62] Fix | Delete

}

[63] Fix | Delete

[64] Fix | Delete

/**

[65] Fix | Delete

* Prepare a report data item for serialization.

[66] Fix | Delete

*

[67] Fix | Delete

* @param array $report Report data item as returned from Data Store.

[68] Fix | Delete

* @param \WP_REST_Request $request Request object.

[69] Fix | Delete

* @return \WP_REST_Response

[70] Fix | Delete

*/

[71] Fix | Delete

public function prepare_item_for_response( $report, $request ) {

[72] Fix | Delete

$response = parent::prepare_item_for_response( $report, $request );

[73] Fix | Delete

$response->add_links( $this->prepare_links( $report ) );

[74] Fix | Delete

[75] Fix | Delete

/**

[76] Fix | Delete

* Filter a report returned from the API.

[77] Fix | Delete

*

[78] Fix | Delete

* Allows modification of the report data right before it is returned.

[79] Fix | Delete

*

[80] Fix | Delete

* @param WP_REST_Response $response The response object.

[81] Fix | Delete

* @param object $report The original report object.

[82] Fix | Delete

* @param WP_REST_Request $request Request used to generate the response.

[83] Fix | Delete

*/

[84] Fix | Delete

return apply_filters( 'woocommerce_rest_prepare_report_coupons', $response, $report, $request );

[85] Fix | Delete

}

[86] Fix | Delete

[87] Fix | Delete

/**

[88] Fix | Delete

* Prepare links for the request.

[89] Fix | Delete

*

[90] Fix | Delete

* @param WC_Reports_Query $object Object data.

[91] Fix | Delete

* @return array

[92] Fix | Delete

*/

[93] Fix | Delete

protected function prepare_links( $object ) {

[94] Fix | Delete

$links = array(

[95] Fix | Delete

'coupon' => array(

[96] Fix | Delete

'href' => rest_url( sprintf( '/%s/coupons/%d', $this->namespace, $object['coupon_id'] ) ),

[97] Fix | Delete

),

[98] Fix | Delete

);

[99] Fix | Delete

[100] Fix | Delete

return $links;

[101] Fix | Delete

}

[102] Fix | Delete

[103] Fix | Delete

/**

[104] Fix | Delete

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

[105] Fix | Delete

*

[106] Fix | Delete

* @return array

[107] Fix | Delete

*/

[108] Fix | Delete

public function get_item_schema() {

[109] Fix | Delete

$schema = array(

[110] Fix | Delete

'$schema' => 'http://json-schema.org/draft-04/schema#',

[111] Fix | Delete

'title' => 'report_coupons',

[112] Fix | Delete

'type' => 'object',

[113] Fix | Delete

'properties' => array(

[114] Fix | Delete

'coupon_id' => array(

[115] Fix | Delete

'description' => __( 'Coupon ID.', 'woocommerce' ),

[116] Fix | Delete

'type' => 'integer',

[117] Fix | Delete

'context' => array( 'view', 'edit' ),

[118] Fix | Delete

'readonly' => true,

[119] Fix | Delete

),

[120] Fix | Delete

'amount' => array(

[121] Fix | Delete

'description' => __( 'Net discount amount.', 'woocommerce' ),

[122] Fix | Delete

'type' => 'number',

[123] Fix | Delete

'context' => array( 'view', 'edit' ),

[124] Fix | Delete

'readonly' => true,

[125] Fix | Delete

),

[126] Fix | Delete

'orders_count' => array(

[127] Fix | Delete

'description' => __( 'Number of orders.', 'woocommerce' ),

[128] Fix | Delete

'type' => 'integer',

[129] Fix | Delete

'context' => array( 'view', 'edit' ),

[130] Fix | Delete

'readonly' => true,

[131] Fix | Delete

),

[132] Fix | Delete

'extended_info' => array(

[133] Fix | Delete

'code' => array(

[134] Fix | Delete

'type' => 'string',

[135] Fix | Delete

'readonly' => true,

[136] Fix | Delete

'context' => array( 'view', 'edit' ),

[137] Fix | Delete

'description' => __( 'Coupon code.', 'woocommerce' ),

[138] Fix | Delete

),

[139] Fix | Delete

'date_created' => array(

[140] Fix | Delete

'type' => 'date-time',

[141] Fix | Delete

'readonly' => true,

[142] Fix | Delete

'context' => array( 'view', 'edit' ),

[143] Fix | Delete

'description' => __( 'Coupon creation date.', 'woocommerce' ),

[144] Fix | Delete

),

[145] Fix | Delete

'date_created_gmt' => array(

[146] Fix | Delete

'type' => 'date-time',

[147] Fix | Delete

'readonly' => true,

[148] Fix | Delete

'context' => array( 'view', 'edit' ),

[149] Fix | Delete

'description' => __( 'Coupon creation date in GMT.', 'woocommerce' ),

[150] Fix | Delete

),

[151] Fix | Delete

'date_expires' => array(

[152] Fix | Delete

'type' => 'date-time',

[153] Fix | Delete

'readonly' => true,

[154] Fix | Delete

'context' => array( 'view', 'edit' ),

[155] Fix | Delete

'description' => __( 'Coupon expiration date.', 'woocommerce' ),

[156] Fix | Delete

),

[157] Fix | Delete

'date_expires_gmt' => array(

[158] Fix | Delete

'type' => 'date-time',

[159] Fix | Delete

'readonly' => true,

[160] Fix | Delete

'context' => array( 'view', 'edit' ),

[161] Fix | Delete

'description' => __( 'Coupon expiration date in GMT.', 'woocommerce' ),

[162] Fix | Delete

),

[163] Fix | Delete

'discount_type' => array(

[164] Fix | Delete

'type' => 'string',

[165] Fix | Delete

'readonly' => true,

[166] Fix | Delete

'context' => array( 'view', 'edit' ),

[167] Fix | Delete

'enum' => array_keys( wc_get_coupon_types() ),

[168] Fix | Delete

'description' => __( 'Coupon discount type.', 'woocommerce' ),

[169] Fix | Delete

),

[170] Fix | Delete

),

[171] Fix | Delete

),

[172] Fix | Delete

);

[173] Fix | Delete

[174] Fix | Delete

return $this->add_additional_fields_schema( $schema );

[175] Fix | Delete

}

[176] Fix | Delete

[177] Fix | Delete

/**

[178] Fix | Delete

* Get the query params for collections.

[179] Fix | Delete

*

[180] Fix | Delete

* @return array

[181] Fix | Delete

*/

[182] Fix | Delete

public function get_collection_params() {

[183] Fix | Delete

$params = parent::get_collection_params();

[184] Fix | Delete

$params['orderby']['default'] = 'coupon_id';

[185] Fix | Delete

$params['orderby']['enum'] = $this->apply_custom_orderby_filters(

[186] Fix | Delete

array(

[187] Fix | Delete

'coupon_id',

[188] Fix | Delete

'code',

[189] Fix | Delete

'amount',

[190] Fix | Delete

'orders_count',

[191] Fix | Delete

)

[192] Fix | Delete

);

[193] Fix | Delete

$params['coupons'] = array(

[194] Fix | Delete

'description' => __( 'Limit result set to coupons assigned specific coupon IDs.', 'woocommerce' ),

[195] Fix | Delete

'type' => 'array',

[196] Fix | Delete

'sanitize_callback' => 'wp_parse_id_list',

[197] Fix | Delete

'validate_callback' => 'rest_validate_request_arg',

[198] Fix | Delete

'items' => array(

[199] Fix | Delete

'type' => 'integer',

[200] Fix | Delete

),

[201] Fix | Delete

);

[202] Fix | Delete

$params['extended_info'] = array(

[203] Fix | Delete

'description' => __( 'Add additional piece of info about each coupon to the report.', 'woocommerce' ),

[204] Fix | Delete

'type' => 'boolean',

[205] Fix | Delete

'default' => false,

[206] Fix | Delete

'sanitize_callback' => 'wc_string_to_bool',

[207] Fix | Delete

'validate_callback' => 'rest_validate_request_arg',

[208] Fix | Delete

);

[209] Fix | Delete

[210] Fix | Delete

return $params;

[211] Fix | Delete

}

[212] Fix | Delete

[213] Fix | Delete

/**

[214] Fix | Delete

* Get the column names for export.

[215] Fix | Delete

*

[216] Fix | Delete

* @return array Key value pair of Column ID => Label.

[217] Fix | Delete

*/

[218] Fix | Delete

public function get_export_columns() {

[219] Fix | Delete

$export_columns = array(

[220] Fix | Delete

'code' => __( 'Coupon code', 'woocommerce' ),

[221] Fix | Delete

'orders_count' => __( 'Orders', 'woocommerce' ),

[222] Fix | Delete

'amount' => __( 'Amount discounted', 'woocommerce' ),

[223] Fix | Delete

'created' => __( 'Created', 'woocommerce' ),

[224] Fix | Delete

'expires' => __( 'Expires', 'woocommerce' ),

[225] Fix | Delete

'type' => __( 'Type', 'woocommerce' ),

[226] Fix | Delete

);

[227] Fix | Delete

[228] Fix | Delete

/**

[229] Fix | Delete

* Filter to add or remove column names from the coupons report for

[230] Fix | Delete

* export.

[231] Fix | Delete

*

[232] Fix | Delete

* @since 1.6.0

[233] Fix | Delete

*/

[234] Fix | Delete

return apply_filters(

[235] Fix | Delete

'woocommerce_report_coupons_export_columns',

[236] Fix | Delete

$export_columns

[237] Fix | Delete

);

[238] Fix | Delete

}

[239] Fix | Delete

[240] Fix | Delete

/**

[241] Fix | Delete

* Get the column values for export.

[242] Fix | Delete

*

[243] Fix | Delete

* @param array $item Single report item/row.

[244] Fix | Delete

* @return array Key value pair of Column ID => Row Value.

[245] Fix | Delete

*/

[246] Fix | Delete

public function prepare_item_for_export( $item ) {

[247] Fix | Delete

$date_expires = empty( $item['extended_info']['date_expires'] )

[248] Fix | Delete

? __( 'N/A', 'woocommerce' )

[249] Fix | Delete

: $item['extended_info']['date_expires'];

[250] Fix | Delete

[251] Fix | Delete

$export_item = array(

[252] Fix | Delete

'code' => $item['extended_info']['code'],

[253] Fix | Delete

'orders_count' => $item['orders_count'],

[254] Fix | Delete

'amount' => $item['amount'],

[255] Fix | Delete

'created' => $item['extended_info']['date_created'],

[256] Fix | Delete

'expires' => $date_expires,

[257] Fix | Delete

'type' => $item['extended_info']['discount_type'],

[258] Fix | Delete

);

[259] Fix | Delete

[260] Fix | Delete

/**

[261] Fix | Delete

* Filter to prepare extra columns in the export item for the coupons

[262] Fix | Delete

* report.

[263] Fix | Delete

*

[264] Fix | Delete

* @since 1.6.0

[265] Fix | Delete

*/

[266] Fix | Delete

return apply_filters(

[267] Fix | Delete

'woocommerce_report_coupons_prepare_export_item',

[268] Fix | Delete

$export_item,

[269] Fix | Delete

$item

[270] Fix | Delete

);

[271] Fix | Delete

}

[272] Fix | Delete

}

[273] Fix | Delete

[274] Fix | Delete