<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* API\Reports\Orders\DataStore class file.

[2] Fix | Delete

*/

[3] Fix | Delete

[4] Fix | Delete

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

[5] Fix | Delete

[6] Fix | Delete

defined( 'ABSPATH' ) || exit;

[7] Fix | Delete

[8] Fix | Delete

use Automattic\WooCommerce\Admin\API\Reports\DataStore as ReportsDataStore;

[9] Fix | Delete

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

[10] Fix | Delete

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

[11] Fix | Delete

use Automattic\WooCommerce\Internal\DataStores\Orders\OrdersTableDataStore;

[12] Fix | Delete

use Automattic\WooCommerce\Internal\Traits\OrderAttributionMeta;

[13] Fix | Delete

use Automattic\WooCommerce\Utilities\OrderUtil;

[14] Fix | Delete

[15] Fix | Delete

[16] Fix | Delete

/**

[17] Fix | Delete

* API\Reports\Orders\DataStore.

[18] Fix | Delete

*/

[19] Fix | Delete

class DataStore extends ReportsDataStore implements DataStoreInterface {

[20] Fix | Delete

use OrderAttributionMeta;

[21] Fix | Delete

[22] Fix | Delete

/**

[23] Fix | Delete

* The cache key for order statuses.

[24] Fix | Delete

*/

[25] Fix | Delete

const ORDERS_STATUSES_ALL_CACHE_KEY = 'woocommerce_analytics_orders_statuses_all';

[26] Fix | Delete

[27] Fix | Delete

/**

[28] Fix | Delete

* Dynamically sets the date column name based on configuration

[29] Fix | Delete

*

[30] Fix | Delete

* @override ReportsDataStore::__construct()

[31] Fix | Delete

*/

[32] Fix | Delete

public function __construct() {

[33] Fix | Delete

$this->date_column_name = get_option( 'woocommerce_date_type', 'date_paid' );

[34] Fix | Delete

parent::__construct();

[35] Fix | Delete

}

[36] Fix | Delete

[37] Fix | Delete

/**

[38] Fix | Delete

* Set up all the hooks for maintaining data consistency (transients and co).

[39] Fix | Delete

*

[40] Fix | Delete

* @internal

[41] Fix | Delete

*/

[42] Fix | Delete

final public static function init() {

[43] Fix | Delete

add_action( 'woocommerce_analytics_update_order_stats', array( __CLASS__, 'maybe_update_order_statuses_cache' ) );

[44] Fix | Delete

}

[45] Fix | Delete

[46] Fix | Delete

/**

[47] Fix | Delete

* Table used to get the data.

[48] Fix | Delete

*

[49] Fix | Delete

* @override ReportsDataStore::$table_name

[50] Fix | Delete

*

[51] Fix | Delete

* @var string

[52] Fix | Delete

*/

[53] Fix | Delete

protected static $table_name = 'wc_order_stats';

[54] Fix | Delete

[55] Fix | Delete

/**

[56] Fix | Delete

* Cache identifier.

[57] Fix | Delete

*

[58] Fix | Delete

* @override ReportsDataStore::$cache_key

[59] Fix | Delete

*

[60] Fix | Delete

* @var string

[61] Fix | Delete

*/

[62] Fix | Delete

protected $cache_key = 'orders';

[63] Fix | Delete

[64] Fix | Delete

/**

[65] Fix | Delete

* Mapping columns to data type to return correct response types.

[66] Fix | Delete

*

[67] Fix | Delete

* @override ReportsDataStore::$column_types

[68] Fix | Delete

*

[69] Fix | Delete

* @var array

[70] Fix | Delete

*/

[71] Fix | Delete

protected $column_types = array(

[72] Fix | Delete

'order_id' => 'intval',

[73] Fix | Delete

'parent_id' => 'intval',

[74] Fix | Delete

'date_created' => 'strval',

[75] Fix | Delete

'date_created_gmt' => 'strval',

[76] Fix | Delete

'status' => 'strval',

[77] Fix | Delete

'customer_id' => 'intval',

[78] Fix | Delete

'net_total' => 'floatval',

[79] Fix | Delete

'total_sales' => 'floatval',

[80] Fix | Delete

'num_items_sold' => 'intval',

[81] Fix | Delete

'customer_type' => 'strval',

[82] Fix | Delete

);

[83] Fix | Delete

[84] Fix | Delete

/**

[85] Fix | Delete

* Data store context used to pass to filters.

[86] Fix | Delete

*

[87] Fix | Delete

* @override ReportsDataStore::$context

[88] Fix | Delete

*

[89] Fix | Delete

* @var string

[90] Fix | Delete

*/

[91] Fix | Delete

protected $context = 'orders';

[92] Fix | Delete

[93] Fix | Delete

/**

[94] Fix | Delete

* Assign report columns once full table name has been assigned.

[95] Fix | Delete

*

[96] Fix | Delete

* @override ReportsDataStore::assign_report_columns()

[97] Fix | Delete

*/

[98] Fix | Delete

protected function assign_report_columns() {

[99] Fix | Delete

$table_name = self::get_db_table_name();

[100] Fix | Delete

// Avoid ambiguous columns in SQL query.

[101] Fix | Delete

$this->report_columns = array(

[102] Fix | Delete

'order_id' => "DISTINCT {$table_name}.order_id",

[103] Fix | Delete

'parent_id' => "{$table_name}.parent_id",

[104] Fix | Delete

// Add 'date' field based on date type setting.

[105] Fix | Delete

'date' => "{$table_name}.{$this->date_column_name} AS date",

[106] Fix | Delete

'date_created' => "{$table_name}.date_created",

[107] Fix | Delete

'date_created_gmt' => "{$table_name}.date_created_gmt",

[108] Fix | Delete

'status' => "REPLACE({$table_name}.status, 'wc-', '') as status",

[109] Fix | Delete

'customer_id' => "{$table_name}.customer_id",

[110] Fix | Delete

'net_total' => "{$table_name}.net_total",

[111] Fix | Delete

'total_sales' => "{$table_name}.total_sales",

[112] Fix | Delete

'num_items_sold' => "{$table_name}.num_items_sold",

[113] Fix | Delete

'customer_type' => "(CASE WHEN {$table_name}.returning_customer = 0 THEN 'new' ELSE 'returning' END) as customer_type",

[114] Fix | Delete

);

[115] Fix | Delete

}

[116] Fix | Delete

[117] Fix | Delete

/**

[118] Fix | Delete

* Updates the database query with parameters used for orders report: coupons and products filters.

[119] Fix | Delete

*

[120] Fix | Delete

* @param array $query_args Query arguments supplied by the user.

[121] Fix | Delete

*/

[122] Fix | Delete

protected function add_sql_query_params( $query_args ) {

[123] Fix | Delete

global $wpdb;

[124] Fix | Delete

$order_stats_lookup_table = self::get_db_table_name();

[125] Fix | Delete

$order_coupon_lookup_table = $wpdb->prefix . 'wc_order_coupon_lookup';

[126] Fix | Delete

$order_product_lookup_table = $wpdb->prefix . 'wc_order_product_lookup';

[127] Fix | Delete

$order_tax_lookup_table = $wpdb->prefix . 'wc_order_tax_lookup';

[128] Fix | Delete

$operator = $this->get_match_operator( $query_args );

[129] Fix | Delete

$where_subquery = array();

[130] Fix | Delete

$have_joined_products_table = false;

[131] Fix | Delete

[132] Fix | Delete

$this->add_time_period_sql_params( $query_args, $order_stats_lookup_table );

[133] Fix | Delete

$this->get_limit_sql_params( $query_args );

[134] Fix | Delete

$this->add_order_by_sql_params( $query_args );

[135] Fix | Delete

[136] Fix | Delete

$status_subquery = $this->get_status_subquery( $query_args );

[137] Fix | Delete

if ( $status_subquery ) {

[138] Fix | Delete

if ( empty( $query_args['status_is'] ) && empty( $query_args['status_is_not'] ) ) {

[139] Fix | Delete

$this->subquery->add_sql_clause( 'where', "AND {$status_subquery}" );

[140] Fix | Delete

} else {

[141] Fix | Delete

$where_subquery[] = $status_subquery;

[142] Fix | Delete

}

[143] Fix | Delete

}

[144] Fix | Delete

[145] Fix | Delete

$included_orders = $this->get_included_orders( $query_args );

[146] Fix | Delete

if ( $included_orders ) {

[147] Fix | Delete

$where_subquery[] = "{$order_stats_lookup_table}.order_id IN ({$included_orders})";

[148] Fix | Delete

}

[149] Fix | Delete

[150] Fix | Delete

$excluded_orders = $this->get_excluded_orders( $query_args );

[151] Fix | Delete

if ( $excluded_orders ) {

[152] Fix | Delete

$where_subquery[] = "{$order_stats_lookup_table}.order_id NOT IN ({$excluded_orders})";

[153] Fix | Delete

}

[154] Fix | Delete

[155] Fix | Delete

if ( $query_args['customer_type'] ) {

[156] Fix | Delete

$returning_customer = 'returning' === $query_args['customer_type'] ? 1 : 0;

[157] Fix | Delete

$where_subquery[] = "{$order_stats_lookup_table}.returning_customer = {$returning_customer}";

[158] Fix | Delete

}

[159] Fix | Delete

[160] Fix | Delete

$refund_subquery = $this->get_refund_subquery( $query_args );

[161] Fix | Delete

$this->subquery->add_sql_clause( 'from', $refund_subquery['from_clause'] );

[162] Fix | Delete

if ( $refund_subquery['where_clause'] ) {

[163] Fix | Delete

$where_subquery[] = $refund_subquery['where_clause'];

[164] Fix | Delete

}

[165] Fix | Delete

[166] Fix | Delete

$included_coupons = $this->get_included_coupons( $query_args );

[167] Fix | Delete

$excluded_coupons = $this->get_excluded_coupons( $query_args );

[168] Fix | Delete

if ( $included_coupons || $excluded_coupons ) {

[169] Fix | Delete

$this->subquery->add_sql_clause( 'join', "LEFT JOIN {$order_coupon_lookup_table} ON {$order_stats_lookup_table}.order_id = {$order_coupon_lookup_table}.order_id" );

[170] Fix | Delete

}

[171] Fix | Delete

if ( $included_coupons ) {

[172] Fix | Delete

$where_subquery[] = "{$order_coupon_lookup_table}.coupon_id IN ({$included_coupons})";

[173] Fix | Delete

}

[174] Fix | Delete

if ( $excluded_coupons ) {

[175] Fix | Delete

$where_subquery[] = "({$order_coupon_lookup_table}.coupon_id IS NULL OR {$order_coupon_lookup_table}.coupon_id NOT IN ({$excluded_coupons}))";

[176] Fix | Delete

}

[177] Fix | Delete

[178] Fix | Delete

$included_products = $this->get_included_products( $query_args );

[179] Fix | Delete

$excluded_products = $this->get_excluded_products( $query_args );

[180] Fix | Delete

if ( $included_products || $excluded_products ) {

[181] Fix | Delete

$this->subquery->add_sql_clause( 'join', "LEFT JOIN {$order_product_lookup_table} product_lookup" );

[182] Fix | Delete

$this->subquery->add_sql_clause( 'join', "ON {$order_stats_lookup_table}.order_id = product_lookup.order_id" );

[183] Fix | Delete

}

[184] Fix | Delete

if ( $included_products ) {

[185] Fix | Delete

$this->subquery->add_sql_clause( 'join', "AND product_lookup.product_id IN ({$included_products})" );

[186] Fix | Delete

$where_subquery[] = 'product_lookup.order_id IS NOT NULL';

[187] Fix | Delete

}

[188] Fix | Delete

if ( $excluded_products ) {

[189] Fix | Delete

$this->subquery->add_sql_clause( 'join', "AND product_lookup.product_id IN ({$excluded_products})" );

[190] Fix | Delete

$where_subquery[] = 'product_lookup.order_id IS NULL';

[191] Fix | Delete

}

[192] Fix | Delete

[193] Fix | Delete

$included_variations = $this->get_included_variations( $query_args );

[194] Fix | Delete

$excluded_variations = $this->get_excluded_variations( $query_args );

[195] Fix | Delete

if ( $included_variations || $excluded_variations ) {

[196] Fix | Delete

$this->subquery->add_sql_clause( 'join', "LEFT JOIN {$order_product_lookup_table} variation_lookup" );

[197] Fix | Delete

$this->subquery->add_sql_clause( 'join', "ON {$order_stats_lookup_table}.order_id = variation_lookup.order_id" );

[198] Fix | Delete

}

[199] Fix | Delete

if ( $included_variations ) {

[200] Fix | Delete

$this->subquery->add_sql_clause( 'join', "AND variation_lookup.variation_id IN ({$included_variations})" );

[201] Fix | Delete

$where_subquery[] = 'variation_lookup.order_id IS NOT NULL';

[202] Fix | Delete

}

[203] Fix | Delete

if ( $excluded_variations ) {

[204] Fix | Delete

$this->subquery->add_sql_clause( 'join', "AND variation_lookup.variation_id IN ({$excluded_variations})" );

[205] Fix | Delete

$where_subquery[] = 'variation_lookup.order_id IS NULL';

[206] Fix | Delete

}

[207] Fix | Delete

[208] Fix | Delete

$included_tax_rates = ! empty( $query_args['tax_rate_includes'] ) ? implode( ',', array_map( 'esc_sql', $query_args['tax_rate_includes'] ) ) : false;

[209] Fix | Delete

$excluded_tax_rates = ! empty( $query_args['tax_rate_excludes'] ) ? implode( ',', array_map( 'esc_sql', $query_args['tax_rate_excludes'] ) ) : false;

[210] Fix | Delete

if ( $included_tax_rates || $excluded_tax_rates ) {

[211] Fix | Delete

$this->subquery->add_sql_clause( 'join', "LEFT JOIN {$order_tax_lookup_table} ON {$order_stats_lookup_table}.order_id = {$order_tax_lookup_table}.order_id" );

[212] Fix | Delete

}

[213] Fix | Delete

if ( $included_tax_rates ) {

[214] Fix | Delete

$where_subquery[] = "{$order_tax_lookup_table}.tax_rate_id IN ({$included_tax_rates})";

[215] Fix | Delete

}

[216] Fix | Delete

if ( $excluded_tax_rates ) {

[217] Fix | Delete

$where_subquery[] = "{$order_tax_lookup_table}.tax_rate_id NOT IN ({$excluded_tax_rates}) OR {$order_tax_lookup_table}.tax_rate_id IS NULL";

[218] Fix | Delete

}

[219] Fix | Delete

[220] Fix | Delete

$attribute_subqueries = $this->get_attribute_subqueries( $query_args );

[221] Fix | Delete

if ( $attribute_subqueries['join'] && $attribute_subqueries['where'] ) {

[222] Fix | Delete

$this->subquery->add_sql_clause( 'join', "JOIN {$order_product_lookup_table} ON {$order_stats_lookup_table}.order_id = {$order_product_lookup_table}.order_id" );

[223] Fix | Delete

[224] Fix | Delete

// Add JOINs for matching attributes.

[225] Fix | Delete

foreach ( $attribute_subqueries['join'] as $attribute_join ) {

[226] Fix | Delete

$this->subquery->add_sql_clause( 'join', $attribute_join );

[227] Fix | Delete

}

[228] Fix | Delete

// Add WHEREs for matching attributes.

[229] Fix | Delete

$where_subquery = array_merge( $where_subquery, $attribute_subqueries['where'] );

[230] Fix | Delete

}

[231] Fix | Delete

[232] Fix | Delete

if ( 0 < count( $where_subquery ) ) {

[233] Fix | Delete

$this->subquery->add_sql_clause( 'where', 'AND (' . implode( " {$operator} ", $where_subquery ) . ')' );

[234] Fix | Delete

}

[235] Fix | Delete

}

[236] Fix | Delete

[237] Fix | Delete

/**

[238] Fix | Delete

* Get the default query arguments to be used by get_data().

[239] Fix | Delete

* These defaults are only partially applied when used via REST API, as that has its own defaults.

[240] Fix | Delete

*

[241] Fix | Delete

* @override ReportsDataStore::get_default_query_vars()

[242] Fix | Delete

*

[243] Fix | Delete

* @return array Query parameters.

[244] Fix | Delete

*/

[245] Fix | Delete

public function get_default_query_vars() {

[246] Fix | Delete

$defaults = array_merge(

[247] Fix | Delete

parent::get_default_query_vars(),

[248] Fix | Delete

array(

[249] Fix | Delete

'orderby' => $this->date_column_name,

[250] Fix | Delete

'product_includes' => array(),

[251] Fix | Delete

'product_excludes' => array(),

[252] Fix | Delete

'coupon_includes' => array(),

[253] Fix | Delete

'coupon_excludes' => array(),

[254] Fix | Delete

'tax_rate_includes' => array(),

[255] Fix | Delete

'tax_rate_excludes' => array(),

[256] Fix | Delete

'customer_type' => null,

[257] Fix | Delete

'status_is' => array(),

[258] Fix | Delete

'extended_info' => false,

[259] Fix | Delete

'refunds' => null,

[260] Fix | Delete

'order_includes' => array(),

[261] Fix | Delete

'order_excludes' => array(),

[262] Fix | Delete

)

[263] Fix | Delete

);

[264] Fix | Delete

[265] Fix | Delete

return $defaults;

[266] Fix | Delete

}

[267] Fix | Delete

[268] Fix | Delete

/**

[269] Fix | Delete

* Returns the report data based on normalized parameters.

[270] Fix | Delete

* Will be called by `get_data` if there is no data in cache.

[271] Fix | Delete

*

[272] Fix | Delete

* @override ReportsDataStore::get_noncached_data()

[273] Fix | Delete

*

[274] Fix | Delete

* @see get_data

[275] Fix | Delete

* @param array $query_args Query parameters.

[276] Fix | Delete

* @return stdClass|WP_Error Data object `{ totals: *, intervals: array, total: int, pages: int, page_no: int }`, or error.

[277] Fix | Delete

*/

[278] Fix | Delete

public function get_noncached_data( $query_args ) {

[279] Fix | Delete

global $wpdb;

[280] Fix | Delete

[281] Fix | Delete

$this->initialize_queries();

[282] Fix | Delete

[283] Fix | Delete

$data = (object) array(

[284] Fix | Delete

'data' => array(),

[285] Fix | Delete

'total' => 0,

[286] Fix | Delete

'pages' => 0,

[287] Fix | Delete

'page_no' => 0,

[288] Fix | Delete

);

[289] Fix | Delete

[290] Fix | Delete

$selections = $this->selected_columns( $query_args );

[291] Fix | Delete

$params = $this->get_limit_params( $query_args );

[292] Fix | Delete

$this->add_sql_query_params( $query_args );

[293] Fix | Delete

/* phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared */

[294] Fix | Delete

$db_records_count = (int) $wpdb->get_var(

[295] Fix | Delete

"SELECT COUNT( DISTINCT tt.order_id ) FROM (

[296] Fix | Delete

{$this->subquery->get_query_statement()}

[297] Fix | Delete

) AS tt"

[298] Fix | Delete

);

[299] Fix | Delete

/* phpcs:enable */

[300] Fix | Delete

[301] Fix | Delete

if ( 0 === $params['per_page'] ) {

[302] Fix | Delete

$total_pages = 0;

[303] Fix | Delete

} else {

[304] Fix | Delete

$total_pages = (int) ceil( $db_records_count / $params['per_page'] );

[305] Fix | Delete

}

[306] Fix | Delete

if ( $query_args['page'] < 1 || $query_args['page'] > $total_pages ) {

[307] Fix | Delete

$data = (object) array(

[308] Fix | Delete

'data' => array(),

[309] Fix | Delete

'total' => $db_records_count,

[310] Fix | Delete

'pages' => 0,

[311] Fix | Delete

'page_no' => 0,

[312] Fix | Delete

);

[313] Fix | Delete

return $data;

[314] Fix | Delete

}

[315] Fix | Delete

[316] Fix | Delete

$this->subquery->clear_sql_clause( 'select' );

[317] Fix | Delete

$this->subquery->add_sql_clause( 'select', $selections );

[318] Fix | Delete

$this->subquery->add_sql_clause( 'order_by', $this->get_sql_clause( 'order_by' ) );

[319] Fix | Delete

$this->subquery->add_sql_clause( 'limit', $this->get_sql_clause( 'limit' ) );

[320] Fix | Delete

/* phpcs:disable WordPress.DB.PreparedSQL.NotPrepared */

[321] Fix | Delete

$orders_data = $wpdb->get_results(

[322] Fix | Delete

$this->subquery->get_query_statement(),

[323] Fix | Delete

ARRAY_A

[324] Fix | Delete

);

[325] Fix | Delete

/* phpcs:enable */

[326] Fix | Delete

[327] Fix | Delete

if ( null === $orders_data ) {

[328] Fix | Delete

return $data;

[329] Fix | Delete

}

[330] Fix | Delete

[331] Fix | Delete

if ( $query_args['extended_info'] ) {

[332] Fix | Delete

$this->include_extended_info( $orders_data, $query_args );

[333] Fix | Delete

}

[334] Fix | Delete

[335] Fix | Delete

$orders_data = array_map( array( $this, 'cast_numbers' ), $orders_data );

[336] Fix | Delete

$data = (object) array(

[337] Fix | Delete

'data' => $orders_data,

[338] Fix | Delete

'total' => $db_records_count,

[339] Fix | Delete

'pages' => $total_pages,

[340] Fix | Delete

'page_no' => (int) $query_args['page'],

[341] Fix | Delete

);

[342] Fix | Delete

return $data;

[343] Fix | Delete

}

[344] Fix | Delete

[345] Fix | Delete

/**

[346] Fix | Delete

* Normalizes order_by clause to match to SQL query.

[347] Fix | Delete

*

[348] Fix | Delete

* @override ReportsDataStore::normalize_order_by()

[349] Fix | Delete

*

[350] Fix | Delete

* @param string $order_by Order by option requeste by user.

[351] Fix | Delete

* @return string

[352] Fix | Delete

*/

[353] Fix | Delete

protected function normalize_order_by( $order_by ) {

[354] Fix | Delete

if ( 'date' === $order_by ) {

[355] Fix | Delete

return $this->date_column_name;

[356] Fix | Delete

}

[357] Fix | Delete

[358] Fix | Delete

return $order_by;

[359] Fix | Delete

}

[360] Fix | Delete

[361] Fix | Delete

/**

[362] Fix | Delete

* Enriches the order data.

[363] Fix | Delete

*

[364] Fix | Delete

* @param array $orders_data Orders data.

[365] Fix | Delete

* @param array $query_args Query parameters.

[366] Fix | Delete

*/

[367] Fix | Delete

protected function include_extended_info( &$orders_data, $query_args ) {

[368] Fix | Delete

$mapped_orders = $this->map_array_by_key( $orders_data, 'order_id' );

[369] Fix | Delete

$related_orders = $this->get_orders_with_parent_id( $mapped_orders );

[370] Fix | Delete

$order_ids = array_merge( array_keys( $mapped_orders ), array_keys( $related_orders ) );

[371] Fix | Delete

$products = $this->get_products_by_order_ids( $order_ids );

[372] Fix | Delete

$coupons = $this->get_coupons_by_order_ids( array_keys( $mapped_orders ) );

[373] Fix | Delete

$order_attributions = $this->get_order_attributions_by_order_ids( array_keys( $mapped_orders ) );

[374] Fix | Delete

$customers = $this->get_customers_by_orders( $orders_data );

[375] Fix | Delete

$mapped_customers = $this->map_array_by_key( $customers, 'customer_id' );

[376] Fix | Delete

[377] Fix | Delete

$mapped_data = array();

[378] Fix | Delete

foreach ( $products as $product ) {

[379] Fix | Delete

if ( ! isset( $mapped_data[ $product['order_id'] ] ) ) {

[380] Fix | Delete

$mapped_data[ $product['order_id'] ]['products'] = array();

[381] Fix | Delete

}

[382] Fix | Delete

[383] Fix | Delete

$is_variation = '0' !== $product['variation_id'];

[384] Fix | Delete

$product_data = array(

[385] Fix | Delete

'id' => $is_variation ? $product['variation_id'] : $product['product_id'],

[386] Fix | Delete

'name' => $product['product_name'],

[387] Fix | Delete

'quantity' => $product['product_quantity'],

[388] Fix | Delete

);

[389] Fix | Delete

[390] Fix | Delete

if ( $is_variation ) {

[391] Fix | Delete

$variation = wc_get_product( $product_data['id'] );

[392] Fix | Delete

/**

[393] Fix | Delete

* Used to determine the separator for products and their variations titles.

[394] Fix | Delete

*

[395] Fix | Delete

* @since 4.0.0

[396] Fix | Delete

*/

[397] Fix | Delete

$separator = apply_filters( 'woocommerce_product_variation_title_attributes_separator', ' - ', $variation );

[398] Fix | Delete

[399] Fix | Delete

if ( false === strpos( $product_data['name'], $separator ) ) {

[400] Fix | Delete

$attributes = wc_get_formatted_variation( $variation, true, false );

[401] Fix | Delete

$product_data['name'] .= $separator . $attributes;

[402] Fix | Delete

}

[403] Fix | Delete

}

[404] Fix | Delete

[405] Fix | Delete

$mapped_data[ $product['order_id'] ]['products'][] = $product_data;

[406] Fix | Delete

[407] Fix | Delete

// If this product's order has another related order, it will be added to our mapped_data.

[408] Fix | Delete

if ( isset( $related_orders [ $product['order_id'] ] ) ) {

[409] Fix | Delete

$mapped_data[ $related_orders[ $product['order_id'] ]['order_id'] ] ['products'] [] = $product_data;

[410] Fix | Delete

}

[411] Fix | Delete

}

[412] Fix | Delete

[413] Fix | Delete

foreach ( $coupons as $coupon ) {

[414] Fix | Delete

if ( ! isset( $mapped_data[ $coupon['order_id'] ] ) ) {

[415] Fix | Delete

$mapped_data[ $coupon['order_id'] ]['coupons'] = array();

[416] Fix | Delete

}

[417] Fix | Delete

[418] Fix | Delete

$mapped_data[ $coupon['order_id'] ]['coupons'][] = array(

[419] Fix | Delete

'id' => $coupon['coupon_id'],

[420] Fix | Delete

'code' => wc_format_coupon_code( $coupon['coupon_code'] ),

[421] Fix | Delete

);

[422] Fix | Delete

}

[423] Fix | Delete

[424] Fix | Delete

foreach ( $orders_data as $key => $order_data ) {

[425] Fix | Delete

$defaults = array(

[426] Fix | Delete

'products' => array(),

[427] Fix | Delete

'coupons' => array(),

[428] Fix | Delete

'customer' => array(),

[429] Fix | Delete

'attribution' => array(),

[430] Fix | Delete

);

[431] Fix | Delete

$order_id = $order_data['order_id'];

[432] Fix | Delete

[433] Fix | Delete

$orders_data[ $key ]['extended_info'] = isset( $mapped_data[ $order_id ] ) ? array_merge( $defaults, $mapped_data[ $order_id ] ) : $defaults;

[434] Fix | Delete

if ( $order_data['customer_id'] && isset( $mapped_customers[ $order_data['customer_id'] ] ) ) {

[435] Fix | Delete

$orders_data[ $key ]['extended_info']['customer'] = $mapped_customers[ $order_data['customer_id'] ];

[436] Fix | Delete

}

[437] Fix | Delete

[438] Fix | Delete

$source_type = $order_attributions[ $order_id ]['_wc_order_attribution_source_type'] ?? '';

[439] Fix | Delete

$utm_source = $order_attributions[ $order_id ]['_wc_order_attribution_utm_source'] ?? '';

[440] Fix | Delete

$orders_data[ $key ]['extended_info']['attribution']['origin'] = $this->get_origin_label( $source_type, $utm_source );

[441] Fix | Delete

}

[442] Fix | Delete

}

[443] Fix | Delete

[444] Fix | Delete

/**

[445] Fix | Delete

* Returns oreders that have a parent id

[446] Fix | Delete

*

[447] Fix | Delete

* @param array $orders Orders array.

[448] Fix | Delete

* @return array

[449] Fix | Delete

*/

[450] Fix | Delete

protected function get_orders_with_parent_id( $orders ) {

[451] Fix | Delete

$related_orders = array();

[452] Fix | Delete

foreach ( $orders as $order ) {

[453] Fix | Delete

if ( '0' !== $order['parent_id'] ) {

[454] Fix | Delete

$related_orders[ $order['parent_id'] ] = $order;

[455] Fix | Delete

}

[456] Fix | Delete

}

[457] Fix | Delete

return $related_orders;

[458] Fix | Delete

}

[459] Fix | Delete

[460] Fix | Delete

/**

[461] Fix | Delete

* Returns the same array index by a given key

[462] Fix | Delete

*

[463] Fix | Delete

* @param array $array Array to be looped over.

[464] Fix | Delete

* @param string $key Key of values used for new array.

[465] Fix | Delete

* @return array

[466] Fix | Delete

*/

[467] Fix | Delete

protected function map_array_by_key( $array, $key ) {

[468] Fix | Delete

$mapped = array();

[469] Fix | Delete

foreach ( $array as $item ) {

[470] Fix | Delete

$mapped[ $item[ $key ] ] = $item;

[471] Fix | Delete

}

[472] Fix | Delete

return $mapped;

[473] Fix | Delete

}

[474] Fix | Delete

[475] Fix | Delete

/**

[476] Fix | Delete

* Get product IDs, names, and quantity from order IDs.

[477] Fix | Delete

*

[478] Fix | Delete

* @param array $order_ids Array of order IDs.

[479] Fix | Delete

* @return array

[480] Fix | Delete

*/

[481] Fix | Delete

protected function get_products_by_order_ids( $order_ids ) {

[482] Fix | Delete

global $wpdb;

[483] Fix | Delete

$order_product_lookup_table = $wpdb->prefix . 'wc_order_product_lookup';

[484] Fix | Delete

$included_order_ids = implode( ',', $order_ids );

[485] Fix | Delete

[486] Fix | Delete

/* phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared */

[487] Fix | Delete

$products = $wpdb->get_results(

[488] Fix | Delete

"SELECT

[489] Fix | Delete

order_id,

[490] Fix | Delete

product_id,

[491] Fix | Delete

variation_id,

[492] Fix | Delete

post_title as product_name,

[493] Fix | Delete

product_qty as product_quantity

[494] Fix | Delete

FROM {$wpdb->posts}

[495] Fix | Delete

JOIN

[496] Fix | Delete

{$order_product_lookup_table}

[497] Fix | Delete

ON {$wpdb->posts}.ID = (

[498] Fix | Delete

CASE WHEN variation_id > 0

[499] Fix | Delete