Steve-Dee-Designs
/
woocommerce
mirror of https://github.com/woocommerce/woocommerce.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Derive orders_count, total_spend, avg_order_value, and date_late_order for customer reports from the order stats report table.

This commit is contained in:
Jeff Stieler 2019-01-07 20:54:17 -07:00
parent 8105ddb38a
commit 154482acc9
2 changed files with 95 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
plugins/woocommerce-admin/includes/class-wc-admin-api-init.php
View File

@ -529,11 +529,7 @@ class WC_Admin_Api_Init {
first_name varchar(255) NOT NULL, first_name varchar(255) NOT NULL,
last_name varchar(255) NOT NULL, last_name varchar(255) NOT NULL,
email varchar(100) NOT NULL, email varchar(100) NOT NULL,
orders_count BIGINT UNSIGNED NOT NULL,
total_spend double DEFAULT 0 NOT NULL,
avg_order_value double DEFAULT 0 NOT NULL,
date_last_active timestamp DEFAULT '0000-00-00 00:00:00' NOT NULL, date_last_active timestamp DEFAULT '0000-00-00 00:00:00' NOT NULL,
date_last_order timestamp DEFAULT '0000-00-00 00:00:00' NOT NULL,
date_registered timestamp NULL default null, date_registered timestamp NULL default null,
country char(2) DEFAULT '' NOT NULL, country char(2) DEFAULT '' NOT NULL,
postcode varchar(20) DEFAULT '' NOT NULL, postcode varchar(20) DEFAULT '' NOT NULL,

137
plugins/woocommerce-admin/includes/data-stores/class-wc-admin-reports-customers-data-store.php
View File

@ -50,11 +50,22 @@ class WC_Admin_Reports_Customers_Data_Store extends WC_Admin_Reports_Data_Store
'postcode' => 'postcode', 'postcode' => 'postcode',
'date_registered' => 'date_registered', 'date_registered' => 'date_registered',
'date_last_active' => 'date_last_active', 'date_last_active' => 'date_last_active',
'orders_count' => 'orders_count', 'orders_count' => 'COUNT( order_id ) as orders_count',
'total_spend' => 'total_spend', 'total_spend' => 'SUM( gross_total ) as total_spend',
'avg_order_value' => 'avg_order_value', 'avg_order_value' => '( SUM( gross_total ) / COUNT( order_id ) ) as avg_order_value',
); );
/**
* Constructor.
*/
public function __construct() {
global $wpdb;
// Initialize some report columns that need disambiguation.
$this->report_columns['customer_id'] = $wpdb->prefix . self::TABLE_NAME . '.customer_id';
$this->report_columns['date_last_order'] = "MAX( {$wpdb->prefix}wc_order_stats.date_created ) as date_last_order";
}
/** /**
* Maps ordering specified by the user to columns in the database/fields in the data. * Maps ordering specified by the user to columns in the database/fields in the data.
* *
@ -99,45 +110,66 @@ class WC_Admin_Reports_Customers_Data_Store extends WC_Admin_Reports_Data_Store
* @return array * @return array
*/ */
protected function get_time_period_sql_params( $query_args, $table_name ) { protected function get_time_period_sql_params( $query_args, $table_name ) {
global $wpdb;
$sql_query = array( $sql_query = array(
'from_clause' => '',
'where_time_clause' => '', 'where_time_clause' => '',
'where_clause' => '', 'where_clause' => '',
'having_clause' => '',
); );
$date_param_mapping = array( $date_param_mapping = array(
'registered' => 'date_registered', 'registered' => array(
'last_active' => 'date_last_active', 'clause' => 'where',
'last_order' => 'date_last_order', 'column' => $table_name . '.date_registered',
),
'last_active' => array(
'clause' => 'where',
'column' => $table_name . '.date_last_active',
),
'last_order' => array(
'clause' => 'having',
'column' => "MAX( {$wpdb->prefix}wc_order_stats.date_created )",
),
); );
$match_operator = $this->get_match_operator( $query_args ); $match_operator = $this->get_match_operator( $query_args );
$where_time_clauses = array(); $where_time_clauses = array();
$having_time_clauses = array();
foreach ( $date_param_mapping as $query_param => $column_name ) { foreach ( $date_param_mapping as $query_param => $param_info ) {
$subclauses = array(); $subclauses = array();
$before_arg = $query_param . '_before'; $before_arg = $query_param . '_before';
$after_arg = $query_param . '_after'; $after_arg = $query_param . '_after';
$column_name = $param_info['column'];
if ( ! empty( $query_args[ $before_arg ] ) ) { if ( ! empty( $query_args[ $before_arg ] ) ) {
$datetime = new DateTime( $query_args[ $before_arg ] ); $datetime = new DateTime( $query_args[ $before_arg ] );
$datetime_str = $datetime->format( WC_Admin_Reports_Interval::$sql_datetime_format ); $datetime_str = $datetime->format( WC_Admin_Reports_Interval::$sql_datetime_format );
$subclauses[] = "{$table_name}.{$column_name} <= '$datetime_str'"; $subclauses[] = "{$column_name} <= '$datetime_str'";
} }
if ( ! empty( $query_args[ $after_arg ] ) ) { if ( ! empty( $query_args[ $after_arg ] ) ) {
$datetime = new DateTime( $query_args[ $after_arg ] ); $datetime = new DateTime( $query_args[ $after_arg ] );
$datetime_str = $datetime->format( WC_Admin_Reports_Interval::$sql_datetime_format ); $datetime_str = $datetime->format( WC_Admin_Reports_Interval::$sql_datetime_format );
$subclauses[] = "{$table_name}.{$column_name} >= '$datetime_str'"; $subclauses[] = "{$column_name} >= '$datetime_str'";
} }
if ( $subclauses ) { if ( $subclauses && ( 'where' === $param_info['clause'] ) ) {
$where_time_clauses[] = '(' . implode( ' AND ', $subclauses ) . ')'; $where_time_clauses[] = '(' . implode( ' AND ', $subclauses ) . ')';
} }
if ( $subclauses && ( 'having' === $param_info['clause'] ) ) {
$having_time_clauses[] = '(' . implode( ' AND ', $subclauses ) . ')';
}
} }
if ( $where_time_clauses ) { if ( $where_time_clauses ) {
$sql_query['where_time_clause'] = ' AND ' . implode( " {$match_operator} ", $where_time_clauses ); $sql_query['where_time_clause'] = ' AND ' . implode( " {$match_operator} ", $where_time_clauses );
} }
if ( $having_time_clauses ) {
$sql_query['having_clause'] = ' AND ' . implode( " {$match_operator} ", $having_time_clauses );
}
return $sql_query; return $sql_query;
} }
@ -149,14 +181,15 @@ class WC_Admin_Reports_Customers_Data_Store extends WC_Admin_Reports_Data_Store
*/ */
protected function get_sql_query_params( $query_args ) { protected function get_sql_query_params( $query_args ) {
global $wpdb; global $wpdb;
$order_product_lookup_table = $wpdb->prefix . self::TABLE_NAME; $customer_lookup_table = $wpdb->prefix . self::TABLE_NAME;
$sql_query_params = $this->get_time_period_sql_params( $query_args, $order_product_lookup_table ); $sql_query_params = $this->get_time_period_sql_params( $query_args, $customer_lookup_table );
$sql_query_params = array_merge( $sql_query_params, $this->get_limit_sql_params( $query_args ) ); $sql_query_params = array_merge( $sql_query_params, $this->get_limit_sql_params( $query_args ) );
$sql_query_params = array_merge( $sql_query_params, $this->get_order_by_sql_params( $query_args ) ); $sql_query_params = array_merge( $sql_query_params, $this->get_order_by_sql_params( $query_args ) );
$match_operator = $this->get_match_operator( $query_args ); $match_operator = $this->get_match_operator( $query_args );
$where_clauses = array(); $where_clauses = array();
$having_clauses = array();
$exact_match_params = array( $exact_match_params = array(
'username', 'username',
@ -167,7 +200,7 @@ class WC_Admin_Reports_Customers_Data_Store extends WC_Admin_Reports_Data_Store
foreach ( $exact_match_params as $exact_match_param ) { foreach ( $exact_match_params as $exact_match_param ) {
if ( ! empty( $query_args[ $exact_match_param ] ) ) { if ( ! empty( $query_args[ $exact_match_param ] ) ) {
$where_clauses[] = $wpdb->prepare( $where_clauses[] = $wpdb->prepare(
"{$order_product_lookup_table}.{$exact_match_param} = %s", "{$customer_lookup_table}.{$exact_match_param} = %s",
$query_args[ $exact_match_param ] $query_args[ $exact_match_param ]
); // WPCS: unprepared SQL ok. ); // WPCS: unprepared SQL ok.
} }
@ -178,32 +211,41 @@ class WC_Admin_Reports_Customers_Data_Store extends WC_Admin_Reports_Data_Store
} }
$numeric_params = array( $numeric_params = array(
'orders_count' => '%d', 'orders_count' => array(
'total_spend' => '%f', 'column' => 'COUNT( order_id )',
'avg_order_value' => '%f', 'format' => '%d',
),
'total_spend' => array(
'column' => 'SUM( gross_total )',
'format' => '%f',
),
'avg_order_value' => array(
'column' => '( SUM( gross_total ) / COUNT( order_id ) )',
'format' => '%f',
),
); );
foreach ( $numeric_params as $numeric_param => $sql_format ) { foreach ( $numeric_params as $numeric_param => $param_info ) {
$subclauses = array(); $subclauses = array();
$min_param = $numeric_param . '_min'; $min_param = $numeric_param . '_min';
$max_param = $numeric_param . '_max'; $max_param = $numeric_param . '_max';
if ( isset( $query_args[ $min_param ] ) ) { if ( isset( $query_args[ $min_param ] ) ) {
$subclauses[] = $wpdb->prepare( $subclauses[] = $wpdb->prepare(
"{$order_product_lookup_table}.{$numeric_param} >= {$sql_format}", "{$param_info['column']} >= {$param_info['format']}",
$query_args[ $min_param ] $query_args[ $min_param ]
); // WPCS: unprepared SQL ok. ); // WPCS: unprepared SQL ok.
} }
if ( isset( $query_args[ $max_param ] ) ) { if ( isset( $query_args[ $max_param ] ) ) {
$subclauses[] = $wpdb->prepare( $subclauses[] = $wpdb->prepare(
"{$order_product_lookup_table}.{$numeric_param} <= {$sql_format}", "{$param_info['column']} <= {$param_info['format']}",
$query_args[ $max_param ] $query_args[ $max_param ]
); // WPCS: unprepared SQL ok. ); // WPCS: unprepared SQL ok.
} }
if ( $subclauses ) { if ( $subclauses ) {
$where_clauses[] = '(' . implode( ' AND ', $subclauses ) . ')'; $having_clauses[] = '(' . implode( ' AND ', $subclauses ) . ')';
} }
} }
@ -212,6 +254,11 @@ class WC_Admin_Reports_Customers_Data_Store extends WC_Admin_Reports_Data_Store
$sql_query_params['where_clause'] = $preceding_match . implode( " {$match_operator} ", $where_clauses ); $sql_query_params['where_clause'] = $preceding_match . implode( " {$match_operator} ", $where_clauses );
} }
if ( $having_clauses ) {
$preceding_match = empty( $sql_query_params['having_clause'] ) ? ' AND ' : " {$match_operator} ";
$sql_query_params['having_clause'] .= $preceding_match . implode( " {$match_operator} ", $having_clauses );
}
return $sql_query_params; return $sql_query_params;
} }
@ -224,7 +271,8 @@ class WC_Admin_Reports_Customers_Data_Store extends WC_Admin_Reports_Data_Store
public function get_data( $query_args ) { public function get_data( $query_args ) {
global $wpdb; global $wpdb;
$table_name = $wpdb->prefix . self::TABLE_NAME; $customers_table_name = $wpdb->prefix . self::TABLE_NAME;
$order_stats_table_name = $wpdb->prefix . 'wc_order_stats';
// These defaults are only partially applied when used via REST API, as that has its own defaults. // These defaults are only partially applied when used via REST API, as that has its own defaults.
$defaults = array( $defaults = array(
@ -251,14 +299,24 @@ class WC_Admin_Reports_Customers_Data_Store extends WC_Admin_Reports_Data_Store
$sql_query_params = $this->get_sql_query_params( $query_args ); $sql_query_params = $this->get_sql_query_params( $query_args );
$db_records_count = (int) $wpdb->get_var( $db_records_count = (int) $wpdb->get_var(
"SELECT COUNT(*) "SELECT COUNT(*) FROM (
SELECT {$customers_table_name}.customer_id
FROM FROM
{$table_name} {$customers_table_name}
{$sql_query_params['from_clause']} JOIN
{$order_stats_table_name}
ON
{$customers_table_name}.customer_id = {$order_stats_table_name}.customer_id
WHERE WHERE
1=1 1=1
{$sql_query_params['where_time_clause']} {$sql_query_params['where_time_clause']}
{$sql_query_params['where_clause']} {$sql_query_params['where_clause']}
GROUP BY
{$customers_table_name}.customer_id
HAVING
1=1
{$sql_query_params['having_clause']}
) as tt
" "
); // WPCS: cache ok, DB call ok, unprepared SQL ok. ); // WPCS: cache ok, DB call ok, unprepared SQL ok.
@ -271,14 +329,20 @@ class WC_Admin_Reports_Customers_Data_Store extends WC_Admin_Reports_Data_Store
"SELECT "SELECT
{$selections} {$selections}
FROM FROM
{$table_name} {$customers_table_name}
{$sql_query_params['from_clause']} JOIN
{$order_stats_table_name}
ON
{$customers_table_name}.customer_id = {$order_stats_table_name}.customer_id
WHERE WHERE
1=1 1=1
{$sql_query_params['where_time_clause']} {$sql_query_params['where_time_clause']}
{$sql_query_params['where_clause']} {$sql_query_params['where_clause']}
GROUP BY GROUP BY
customer_id {$customers_table_name}.customer_id
HAVING
1=1
{$sql_query_params['having_clause']}
ORDER BY ORDER BY
{$sql_query_params['order_by_clause']} {$sql_query_params['order_by_clause']}
{$sql_query_params['limit']} {$sql_query_params['limit']}
@ -416,9 +480,6 @@ class WC_Admin_Reports_Customers_Data_Store extends WC_Admin_Reports_Data_Store
return false; return false;
} }
$order_count = $customer->get_order_count( 'edit' );
$total_spend = $customer->get_total_spent( 'edit' );
$last_order = $customer->get_last_order();
$last_active = $customer->get_meta( 'wc_last_active', true, 'edit' ); $last_active = $customer->get_meta( 'wc_last_active', true, 'edit' );
// TODO: try to preserve customer_id for existing user_id? // TODO: try to preserve customer_id for existing user_id?
@ -433,10 +494,6 @@ class WC_Admin_Reports_Customers_Data_Store extends WC_Admin_Reports_Data_Store
'city' => $customer->get_billing_city( 'edit' ), 'city' => $customer->get_billing_city( 'edit' ),
'postcode' => $customer->get_billing_postcode( 'edit' ), 'postcode' => $customer->get_billing_postcode( 'edit' ),
'country' => $customer->get_billing_country( 'edit' ), 'country' => $customer->get_billing_country( 'edit' ),
'orders_count' => $order_count,
'total_spend' => $total_spend,
'avg_order_value' => $order_count ? ( $total_spend / $order_count ) : 0,
'date_last_order' => $last_order ? date( 'Y-m-d H:i:s', $last_order->get_date_created( 'edit' )->getTimestamp() ) : '',
'date_registered' => date( 'Y-m-d H:i:s', $customer->get_date_created( 'edit' )->getTimestamp() ), 'date_registered' => date( 'Y-m-d H:i:s', $customer->get_date_created( 'edit' )->getTimestamp() ),
'date_last_active' => $last_active ? date( 'Y-m-d H:i:s', $last_active ) : '', 'date_last_active' => $last_active ? date( 'Y-m-d H:i:s', $last_active ) : '',
), ),
@ -449,10 +506,6 @@ class WC_Admin_Reports_Customers_Data_Store extends WC_Admin_Reports_Data_Store
'%s', '%s',
'%s', '%s',
'%s', '%s',
'%d',
'%f',
'%f',
'%s',
'%s', '%s',
'%s', '%s',
) )