1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131

<?php
/**
 * API\Reports\Customers\Stats\DataStore class file.
 */

namespace Automattic\WooCommerce\Admin\API\Reports\Customers\Stats;

defined( 'ABSPATH' ) || exit;

use Automattic\WooCommerce\Admin\API\Reports\Customers\DataStore as CustomersDataStore;
use Automattic\WooCommerce\Admin\API\Reports\DataStore as ReportsDataStore;
use Automattic\WooCommerce\Admin\API\Reports\DataStoreInterface;

/**
 * API\Reports\Customers\Stats\DataStore.
 */
class DataStore extends CustomersDataStore implements DataStoreInterface {
    /**
     * Mapping columns to data type to return correct response types.
     *
     * @override CustomersDataStore::$column_types
     *
     * @var array
     */
    protected $column_types = array(
        'customers_count'     => 'intval',
        'avg_orders_count'    => 'floatval',
        'avg_total_spend'     => 'floatval',
        'avg_avg_order_value' => 'floatval',
    );

    /**
     * Cache identifier.
     *
     * @override CustomersDataStore::$cache_key
     *
     * @var string
     */
    protected $cache_key = 'customers_stats';

    /**
     * Data store context used to pass to filters.
     *
     * @override CustomersDataStore::$context
     *
     * @var string
     */
    protected $context = 'customers_stats';

    /**
     * Assign report columns once full table name has been assigned.
     *
     * @override CustomersDataStore::assign_report_columns()
     */
    protected function assign_report_columns() {
        $this->report_columns = array(
            'customers_count'     => 'COUNT( * ) as customers_count',
            'avg_orders_count'    => 'AVG( orders_count ) as avg_orders_count',
            'avg_total_spend'     => 'AVG( total_spend ) as avg_total_spend',
            'avg_avg_order_value' => 'AVG( avg_order_value ) as avg_avg_order_value',
        );
    }

    /**
     * Get the default query arguments to be used by get_data().
     * These defaults are only partially applied when used via REST API, as that has its own defaults.
     *
     * @override CustomersDataStore::get_default_query_vars()
     *
     * @return array Query parameters.
     */
    public function get_default_query_vars() {
        $defaults            = ReportsDataStore::get_default_query_vars();
        $defaults['orderby'] = 'date_registered';
        // Do not set `order_before` and `order_after` here, like in the parent class.
        return $defaults;
    }

    /**
     * Returns the report data based on normalized parameters.
     * Will be called by `get_data` if there is no data in cache.
     *
     * @override CustomersDataStore::get_noncached_data()
     *
     * @see get_data
     * @param array $query_args Query parameters.
     * @return stdClass|WP_Error Data object `{ totals: *, intervals: array, total: int, pages: int, page_no: int }`, or error.
     */
    public function get_noncached_data( $query_args ) {
        global $wpdb;
        $this->initialize_queries();

        $data = (object) array(
            'customers_count'     => 0,
            'avg_orders_count'    => 0,
            'avg_total_spend'     => 0.0,
            'avg_avg_order_value' => 0.0,
        );

        $selections = $this->selected_columns( $query_args );
        $this->add_sql_query_params( $query_args );
        // Clear SQL clauses set for parent class queries that are different here.
        $this->subquery->clear_sql_clause( 'select' );
        $this->subquery->add_sql_clause( 'select', 'SUM( total_sales ) AS total_spend,' );
        $this->subquery->add_sql_clause(
            'select',
            'SUM( CASE WHEN parent_id = 0 THEN 1 END ) as orders_count,'
        );
        $this->subquery->add_sql_clause(
            'select',
            'CASE WHEN SUM( CASE WHEN parent_id = 0 THEN 1 ELSE 0 END ) = 0 THEN NULL ELSE SUM( total_sales ) / SUM( CASE WHEN parent_id = 0 THEN 1 ELSE 0 END ) END AS avg_order_value'
        );

        $this->clear_sql_clause( array( 'order_by', 'limit' ) );
        $this->add_sql_clause( 'select', $selections );
        $this->add_sql_clause( 'from', "({$this->subquery->get_query_statement()}) AS tt" );

        $report_data = $wpdb->get_results(
            $this->get_query_statement(), // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
            ARRAY_A
        );

        if ( null === $report_data ) {
            return $data;
        }

        $data = (object) $this->cast_numbers( $report_data[0] );

        return $data;
    }
}