420 lines
20 KiB
PHP
420 lines
20 KiB
PHP
<?php
|
|
/**
|
|
* Class for adding segmenting support without cluttering the data stores.
|
|
*
|
|
* @package WooCommerce Admin/Classes
|
|
*/
|
|
|
|
defined( 'ABSPATH' ) || exit;
|
|
|
|
/**
|
|
* Date & time interval and numeric range handling class for Reporting API.
|
|
*/
|
|
class WC_Admin_Reports_Orders_Stats_Segmenting extends WC_Admin_Reports_Segmenting {
|
|
|
|
/**
|
|
* Returns SELECT clause statements to be used for product-related product-level segmenting query (e.g. products sold, revenue from product X when segmenting by category).
|
|
*
|
|
* @param string $products_table Name of SQL table containing the product-level segmenting info.
|
|
*
|
|
* @return string SELECT clause statements.
|
|
*/
|
|
protected function get_segment_selections_product_level( $products_table ) {
|
|
$columns_mapping = array(
|
|
'num_items_sold' => "SUM($products_table.product_qty) as num_items_sold",
|
|
'gross_revenue' => "SUM($products_table.product_gross_revenue) AS gross_revenue",
|
|
'coupons' => "SUM($products_table.coupon_amount) AS coupons",
|
|
'refunds' => "SUM($products_table.refund_amount) AS refunds",
|
|
'taxes' => "SUM($products_table.tax_amount) AS taxes",
|
|
'shipping' => "SUM($products_table.shipping_amount) AS shipping",
|
|
// @todo: product_net_revenue should already have refunds subtracted, so it should not be here. Pls check.
|
|
'net_revenue' => "SUM($products_table.product_net_revenue) AS net_revenue",
|
|
);
|
|
|
|
return $this->prepare_selections( $columns_mapping );
|
|
}
|
|
|
|
/**
|
|
* Returns SELECT clause statements to be used for order-related product-level segmenting query (e.g. avg items per order when segmented by category).
|
|
*
|
|
* @param string $unique_orders_table Name of SQL table containing the order-level segmenting info.
|
|
*
|
|
* @return string SELECT clause statements.
|
|
*/
|
|
protected function get_segment_selections_order_level( $unique_orders_table ) {
|
|
$columns_mapping = array(
|
|
'orders_count' => "COUNT($unique_orders_table.order_id) AS orders_count",
|
|
'avg_items_per_order' => "AVG($unique_orders_table.num_items_sold) AS avg_items_per_order",
|
|
'avg_order_value' => "(SUM($unique_orders_table.net_total) - SUM($unique_orders_table.refund_total))/COUNT($unique_orders_table.order_id) AS avg_order_value",
|
|
'num_returning_customers' => "SUM($unique_orders_table.returning_customer) AS num_returning_customers",
|
|
'num_new_customers' => "COUNT($unique_orders_table.returning_customer) - SUM($unique_orders_table.returning_customer) AS num_new_customers",
|
|
);
|
|
|
|
return $this->prepare_selections( $columns_mapping );
|
|
}
|
|
|
|
/**
|
|
* Returns SELECT clause statements to be used for order-level segmenting query (e.g. avg items per order or net revenue when segmented by coupons).
|
|
*
|
|
* @param string $order_stats_table Name of SQL table containing the order-level info.
|
|
* @param array $overrides Array of overrides for default column calculations.
|
|
*
|
|
* @return string
|
|
*/
|
|
protected function segment_selections_orders( $order_stats_table, $overrides = array() ) {
|
|
$columns_mapping = array(
|
|
'num_items_sold' => "SUM($order_stats_table.num_items_sold) as num_items_sold",
|
|
'gross_revenue' => "SUM($order_stats_table.gross_total) AS gross_revenue",
|
|
'coupons' => "SUM($order_stats_table.coupon_total) AS coupons",
|
|
'refunds' => "SUM($order_stats_table.refund_total) AS refunds",
|
|
'taxes' => "SUM($order_stats_table.tax_total) AS taxes",
|
|
'shipping' => "SUM($order_stats_table.shipping_total) AS shipping",
|
|
'net_revenue' => "SUM($order_stats_table.net_total) - SUM($order_stats_table.refund_total) AS net_revenue",
|
|
'orders_count' => "COUNT($order_stats_table.order_id) AS orders_count",
|
|
'avg_items_per_order' => "AVG($order_stats_table.num_items_sold) AS avg_items_per_order",
|
|
'avg_order_value' => "(SUM($order_stats_table.net_total) - SUM($order_stats_table.refund_total))/COUNT($order_stats_table.order_id) AS avg_order_value",
|
|
'num_returning_customers' => "SUM($order_stats_table.returning_customer) AS num_returning_customers",
|
|
'num_new_customers' => "COUNT($order_stats_table.returning_customer) - SUM($order_stats_table.returning_customer) AS num_new_customers",
|
|
);
|
|
|
|
if ( $overrides ) {
|
|
$columns_mapping = array_merge( $columns_mapping, $overrides );
|
|
}
|
|
|
|
return $this->prepare_selections( $columns_mapping );
|
|
}
|
|
|
|
/**
|
|
* Calculate segments for totals where the segmenting property is bound to product (e.g. category, product_id, variation_id).
|
|
*
|
|
* @param array $segmenting_selections SELECT part of segmenting SQL query--one for 'product_level' and one for 'order_level'.
|
|
* @param string $segmenting_from FROM part of segmenting SQL query.
|
|
* @param string $segmenting_where WHERE part of segmenting SQL query.
|
|
* @param string $segmenting_groupby GROUP BY part of segmenting SQL query.
|
|
* @param string $segmenting_dimension_name Name of the segmenting dimension.
|
|
* @param string $table_name Name of SQL table which is the stats table for orders.
|
|
* @param array $totals_query Array of SQL clauses for totals query.
|
|
* @param string $unique_orders_table Name of temporary SQL table that holds unique orders.
|
|
*
|
|
* @return array
|
|
*/
|
|
protected function get_product_related_totals_segments( $segmenting_selections, $segmenting_from, $segmenting_where, $segmenting_groupby, $segmenting_dimension_name, $table_name, $totals_query, $unique_orders_table ) {
|
|
global $wpdb;
|
|
|
|
$product_segmenting_table = $wpdb->prefix . 'wc_order_product_lookup';
|
|
|
|
// Can't get all the numbers from one query, so split it into one query for product-level numbers and one for order-level numbers (which first need to have orders uniqued).
|
|
// Product-level numbers.
|
|
$segments_products = $wpdb->get_results(
|
|
"SELECT
|
|
$segmenting_groupby AS $segmenting_dimension_name
|
|
{$segmenting_selections['product_level']}
|
|
FROM
|
|
$table_name
|
|
$segmenting_from
|
|
{$totals_query['from_clause']}
|
|
WHERE
|
|
1=1
|
|
{$totals_query['where_time_clause']}
|
|
{$totals_query['where_clause']}
|
|
$segmenting_where
|
|
GROUP BY
|
|
$segmenting_groupby",
|
|
ARRAY_A
|
|
); // WPCS: cache ok, DB call ok, unprepared SQL ok.
|
|
|
|
// Order level numbers.
|
|
// As there can be 2 same product ids (or variation ids) per one order, the orders first need to be uniqued before calculating averages, customer counts, etc.
|
|
$segments_orders = $wpdb->get_results(
|
|
"SELECT
|
|
$unique_orders_table.$segmenting_dimension_name AS $segmenting_dimension_name
|
|
{$segmenting_selections['order_level']}
|
|
FROM
|
|
(
|
|
SELECT
|
|
$table_name.order_id,
|
|
$segmenting_groupby AS $segmenting_dimension_name,
|
|
MAX( num_items_sold ) AS num_items_sold,
|
|
MAX( net_total ) as net_total,
|
|
MAX( refund_total ) as refund_total,
|
|
MAX( returning_customer ) AS returning_customer
|
|
FROM
|
|
$table_name
|
|
$segmenting_from
|
|
{$totals_query['from_clause']}
|
|
WHERE
|
|
1=1
|
|
{$totals_query['where_time_clause']}
|
|
{$totals_query['where_clause']}
|
|
$segmenting_where
|
|
GROUP BY
|
|
$product_segmenting_table.order_id, $segmenting_groupby
|
|
) AS $unique_orders_table
|
|
GROUP BY
|
|
$unique_orders_table.$segmenting_dimension_name",
|
|
ARRAY_A
|
|
); // WPCS: cache ok, DB call ok, unprepared SQL ok.
|
|
|
|
$totals_segments = $this->merge_segment_totals_results( $segmenting_dimension_name, $segments_products, $segments_orders );
|
|
return $totals_segments;
|
|
}
|
|
|
|
/**
|
|
* Calculate segments for intervals where the segmenting property is bound to product (e.g. category, product_id, variation_id).
|
|
*
|
|
* @param array $segmenting_selections SELECT part of segmenting SQL query--one for 'product_level' and one for 'order_level'.
|
|
* @param string $segmenting_from FROM part of segmenting SQL query.
|
|
* @param string $segmenting_where WHERE part of segmenting SQL query.
|
|
* @param string $segmenting_groupby GROUP BY part of segmenting SQL query.
|
|
* @param string $segmenting_dimension_name Name of the segmenting dimension.
|
|
* @param string $table_name Name of SQL table which is the stats table for orders.
|
|
* @param array $intervals_query Array of SQL clauses for intervals query.
|
|
* @param string $unique_orders_table Name of temporary SQL table that holds unique orders.
|
|
*
|
|
* @return array
|
|
*/
|
|
protected function get_product_related_intervals_segments( $segmenting_selections, $segmenting_from, $segmenting_where, $segmenting_groupby, $segmenting_dimension_name, $table_name, $intervals_query, $unique_orders_table ) {
|
|
global $wpdb;
|
|
|
|
$product_segmenting_table = $wpdb->prefix . 'wc_order_product_lookup';
|
|
|
|
// LIMIT offset, rowcount needs to be updated to LIMIT offset, rowcount * max number of segments.
|
|
$limit_parts = explode( ',', $intervals_query['limit'] );
|
|
$orig_rowcount = intval( $limit_parts[1] );
|
|
$segmenting_limit = $limit_parts[0] . ',' . $orig_rowcount * count( $this->get_all_segments() );
|
|
|
|
// Can't get all the numbers from one query, so split it into one query for product-level numbers and one for order-level numbers (which first need to have orders uniqued).
|
|
// Product-level numbers.
|
|
$segments_products = $wpdb->get_results(
|
|
"SELECT
|
|
{$intervals_query['select_clause']} AS time_interval,
|
|
$segmenting_groupby AS $segmenting_dimension_name
|
|
{$segmenting_selections['product_level']}
|
|
FROM
|
|
$table_name
|
|
$segmenting_from
|
|
{$intervals_query['from_clause']}
|
|
WHERE
|
|
1=1
|
|
{$intervals_query['where_time_clause']}
|
|
{$intervals_query['where_clause']}
|
|
$segmenting_where
|
|
GROUP BY
|
|
time_interval, $segmenting_groupby
|
|
$segmenting_limit",
|
|
ARRAY_A
|
|
); // WPCS: cache ok, DB call ok, unprepared SQL ok.
|
|
|
|
// Order level numbers.
|
|
// As there can be 2 same product ids (or variation ids) per one order, the orders first need to be uniqued before calculating averages, customer counts, etc.
|
|
$segments_orders = $wpdb->get_results(
|
|
"SELECT
|
|
$unique_orders_table.time_interval AS time_interval,
|
|
$unique_orders_table.$segmenting_dimension_name AS $segmenting_dimension_name
|
|
{$segmenting_selections['order_level']}
|
|
FROM
|
|
(
|
|
SELECT
|
|
MAX( $table_name.date_created ) AS datetime_anchor,
|
|
{$intervals_query['select_clause']} AS time_interval,
|
|
$table_name.order_id,
|
|
$segmenting_groupby AS $segmenting_dimension_name,
|
|
MAX( num_items_sold ) AS num_items_sold,
|
|
MAX( net_total ) as net_total,
|
|
MAX( refund_total ) as refund_total,
|
|
MAX( returning_customer ) AS returning_customer
|
|
FROM
|
|
$table_name
|
|
$segmenting_from
|
|
{$intervals_query['from_clause']}
|
|
WHERE
|
|
1=1
|
|
{$intervals_query['where_time_clause']}
|
|
{$intervals_query['where_clause']}
|
|
$segmenting_where
|
|
GROUP BY
|
|
time_interval, $product_segmenting_table.order_id, $segmenting_groupby
|
|
) AS $unique_orders_table
|
|
GROUP BY
|
|
time_interval, $unique_orders_table.$segmenting_dimension_name
|
|
$segmenting_limit",
|
|
ARRAY_A
|
|
); // WPCS: cache ok, DB call ok, unprepared SQL ok.
|
|
|
|
$intervals_segments = $this->merge_segment_intervals_results( $segmenting_dimension_name, $segments_products, $segments_orders );
|
|
return $intervals_segments;
|
|
}
|
|
|
|
/**
|
|
* Calculate segments for totals query where the segmenting property is bound to order (e.g. coupon or customer type).
|
|
*
|
|
* @param string $segmenting_select SELECT part of segmenting SQL query.
|
|
* @param string $segmenting_from FROM part of segmenting SQL query.
|
|
* @param string $segmenting_where WHERE part of segmenting SQL query.
|
|
* @param string $segmenting_groupby GROUP BY part of segmenting SQL query.
|
|
* @param string $table_name Name of SQL table which is the stats table for orders.
|
|
* @param array $totals_query Array of SQL clauses for intervals query.
|
|
*
|
|
* @return array
|
|
*/
|
|
protected function get_order_related_totals_segments( $segmenting_select, $segmenting_from, $segmenting_where, $segmenting_groupby, $table_name, $totals_query ) {
|
|
global $wpdb;
|
|
|
|
$totals_segments = $wpdb->get_results(
|
|
"SELECT
|
|
$segmenting_groupby
|
|
$segmenting_select
|
|
FROM
|
|
$table_name
|
|
$segmenting_from
|
|
{$totals_query['from_clause']}
|
|
WHERE
|
|
1=1
|
|
{$totals_query['where_time_clause']}
|
|
{$totals_query['where_clause']}
|
|
$segmenting_where
|
|
GROUP BY
|
|
$segmenting_groupby",
|
|
ARRAY_A
|
|
); // WPCS: cache ok, DB call ok, unprepared SQL ok.
|
|
|
|
// Reformat result.
|
|
$totals_segments = $this->reformat_totals_segments( $totals_segments, $segmenting_groupby );
|
|
return $totals_segments;
|
|
}
|
|
|
|
/**
|
|
* Calculate segments for intervals query where the segmenting property is bound to order (e.g. coupon or customer type).
|
|
*
|
|
* @param string $segmenting_select SELECT part of segmenting SQL query.
|
|
* @param string $segmenting_from FROM part of segmenting SQL query.
|
|
* @param string $segmenting_where WHERE part of segmenting SQL query.
|
|
* @param string $segmenting_groupby GROUP BY part of segmenting SQL query.
|
|
* @param string $table_name Name of SQL table which is the stats table for orders.
|
|
* @param array $intervals_query Array of SQL clauses for intervals query.
|
|
*
|
|
* @return array
|
|
*/
|
|
protected function get_order_related_intervals_segments( $segmenting_select, $segmenting_from, $segmenting_where, $segmenting_groupby, $table_name, $intervals_query ) {
|
|
global $wpdb;
|
|
$segmenting_limit = '';
|
|
$limit_parts = explode( ',', $intervals_query['limit'] );
|
|
if ( 2 === count( $limit_parts ) ) {
|
|
$orig_rowcount = intval( $limit_parts[1] );
|
|
$segmenting_limit = $limit_parts[0] . ',' . $orig_rowcount * count( $this->get_all_segments() );
|
|
}
|
|
|
|
$intervals_segments = $wpdb->get_results(
|
|
"SELECT
|
|
MAX($table_name.date_created) AS datetime_anchor,
|
|
{$intervals_query['select_clause']} AS time_interval,
|
|
$segmenting_groupby
|
|
$segmenting_select
|
|
FROM
|
|
$table_name
|
|
$segmenting_from
|
|
{$intervals_query['from_clause']}
|
|
WHERE
|
|
1=1
|
|
{$intervals_query['where_time_clause']}
|
|
{$intervals_query['where_clause']}
|
|
$segmenting_where
|
|
GROUP BY
|
|
time_interval, $segmenting_groupby
|
|
$segmenting_limit",
|
|
ARRAY_A
|
|
); // WPCS: cache ok, DB call ok, unprepared SQL ok.
|
|
|
|
// Reformat result.
|
|
$intervals_segments = $this->reformat_intervals_segments( $intervals_segments, $segmenting_groupby );
|
|
return $intervals_segments;
|
|
}
|
|
|
|
/**
|
|
* Return array of segments formatted for REST response.
|
|
*
|
|
* @param string $type Type of segments to return--'totals' or 'intervals'.
|
|
* @param array $query_params SQL query parameter array.
|
|
* @param string $table_name Name of main SQL table for the data store (used as basis for JOINS).
|
|
*
|
|
* @return array
|
|
* @throws WC_Admin_Reports_Parameter_Exception In case of segmenting by variations, when no parent product is specified.
|
|
*/
|
|
protected function get_segments( $type, $query_params, $table_name ) {
|
|
global $wpdb;
|
|
if ( ! isset( $this->query_args['segmentby'] ) || '' === $this->query_args['segmentby'] ) {
|
|
return array();
|
|
}
|
|
|
|
$product_segmenting_table = $wpdb->prefix . 'wc_order_product_lookup';
|
|
$unique_orders_table = 'uniq_orders';
|
|
$segmenting_where = '';
|
|
|
|
// Product, variation, and category are bound to product, so here product segmenting table is required,
|
|
// while coupon and customer are bound to order, so we don't need the extra JOIN for those.
|
|
// This also means that segment selections need to be calculated differently.
|
|
if ( 'product' === $this->query_args['segmentby'] ) {
|
|
// @todo: how to handle shipping taxes when grouped by product?
|
|
$segmenting_selections = array(
|
|
'product_level' => $this->get_segment_selections_product_level( $product_segmenting_table ),
|
|
'order_level' => $this->get_segment_selections_order_level( $unique_orders_table ),
|
|
);
|
|
$segmenting_from = "INNER JOIN $product_segmenting_table ON ($table_name.order_id = $product_segmenting_table.order_id)";
|
|
$segmenting_groupby = $product_segmenting_table . '.product_id';
|
|
$segmenting_dimension_name = 'product_id';
|
|
|
|
$segments = $this->get_product_related_segments( $type, $segmenting_selections, $segmenting_from, $segmenting_where, $segmenting_groupby, $segmenting_dimension_name, $table_name, $query_params, $unique_orders_table );
|
|
} elseif ( 'variation' === $this->query_args['segmentby'] ) {
|
|
if ( ! isset( $this->query_args['product_includes'] ) || count( $this->query_args['product_includes'] ) !== 1 ) {
|
|
throw new WC_Admin_Reports_Parameter_Exception( 'wc_admin_reports_invalid_segmenting_variation', __( 'product_includes parameter need to specify exactly one product when segmenting by variation.', 'wc-admin' ) );
|
|
}
|
|
|
|
$segmenting_selections = array(
|
|
'product_level' => $this->get_segment_selections_product_level( $product_segmenting_table ),
|
|
'order_level' => $this->get_segment_selections_order_level( $unique_orders_table ),
|
|
);
|
|
$segmenting_from = "INNER JOIN $product_segmenting_table ON ($table_name.order_id = $product_segmenting_table.order_id)";
|
|
$segmenting_where = "AND $product_segmenting_table.product_id = {$this->query_args['product_includes'][0]}";
|
|
$segmenting_groupby = $product_segmenting_table . '.variation_id';
|
|
$segmenting_dimension_name = 'variation_id';
|
|
|
|
$segments = $this->get_product_related_segments( $type, $segmenting_selections, $segmenting_from, $segmenting_where, $segmenting_groupby, $segmenting_dimension_name, $table_name, $query_params, $unique_orders_table );
|
|
} elseif ( 'category' === $this->query_args['segmentby'] ) {
|
|
$segmenting_selections = array(
|
|
'product_level' => $this->get_segment_selections_product_level( $product_segmenting_table ),
|
|
'order_level' => $this->get_segment_selections_order_level( $unique_orders_table ),
|
|
);
|
|
$segmenting_from = "
|
|
INNER JOIN $product_segmenting_table ON ($table_name.order_id = $product_segmenting_table.order_id)
|
|
LEFT JOIN {$wpdb->prefix}term_relationships ON {$product_segmenting_table}.product_id = {$wpdb->prefix}term_relationships.object_id
|
|
RIGHT JOIN {$wpdb->prefix}term_taxonomy ON {$wpdb->prefix}term_relationships.term_taxonomy_id = {$wpdb->prefix}term_taxonomy.term_taxonomy_id
|
|
";
|
|
$segmenting_where = " AND taxonomy = 'product_cat'";
|
|
$segmenting_groupby = 'wp_term_taxonomy.term_taxonomy_id';
|
|
$segmenting_dimension_name = 'category_id';
|
|
|
|
$segments = $this->get_product_related_segments( $type, $segmenting_selections, $segmenting_from, $segmenting_where, $segmenting_groupby, $segmenting_dimension_name, $table_name, $query_params, $unique_orders_table );
|
|
} elseif ( 'coupon' === $this->query_args['segmentby'] ) {
|
|
// As there can be 2 or more coupons applied per one order, coupon amount needs to be split.
|
|
$coupon_override = array(
|
|
'coupons' => 'SUM(coupon_lookup.discount_amount) AS coupons',
|
|
);
|
|
$segmenting_selections = $this->segment_selections_orders( $table_name, $coupon_override );
|
|
$segmenting_from = "
|
|
INNER JOIN {$wpdb->prefix}wc_order_coupon_lookup AS coupon_lookup ON ($table_name.order_id = coupon_lookup.order_id)
|
|
";
|
|
$segmenting_groupby = 'coupon_lookup.coupon_id';
|
|
|
|
$segments = $this->get_order_related_segments( $type, $segmenting_selections, $segmenting_from, $segmenting_where, $segmenting_groupby, $table_name, $query_params );
|
|
} elseif ( 'customer_type' === $this->query_args['segmentby'] ) {
|
|
$segmenting_selections = $this->segment_selections_orders( $table_name );
|
|
$segmenting_from = '';
|
|
$segmenting_groupby = "$table_name.returning_customer";
|
|
|
|
$segments = $this->get_order_related_segments( $type, $segmenting_selections, $segmenting_from, $segmenting_where, $segmenting_groupby, $table_name, $query_params );
|
|
}
|
|
|
|
return $segments;
|
|
}
|
|
}
|