Query.php
71 lines
| 1 | <?php |
| 2 | /** |
| 3 | * Class for parameter-based Revenue Reports querying |
| 4 | * |
| 5 | * Example usage: |
| 6 | * $args = array( |
| 7 | * 'before' => '2018-07-19 00:00:00', |
| 8 | * 'after' => '2018-07-05 00:00:00', |
| 9 | * 'interval' => 'week', |
| 10 | * ); |
| 11 | * $report = new \Automattic\WooCommerce\Admin\API\Reports\Revenue\Query( $args ); |
| 12 | * $mydata = $report->get_data(); |
| 13 | */ |
| 14 | |
| 15 | namespace Automattic\WooCommerce\Admin\API\Reports\Revenue; |
| 16 | |
| 17 | defined( 'ABSPATH' ) || exit; |
| 18 | |
| 19 | /** |
| 20 | * API\Reports\Revenue\Query |
| 21 | * |
| 22 | * This query uses inconsistent names: |
| 23 | * - `report-revenue-stats` data store |
| 24 | * - `woocommerce_analytics_revenue_*` filters |
| 25 | * So, for backward compatibility, we cannot use GenericQuery. |
| 26 | */ |
| 27 | class Query extends \WC_Object_Query { |
| 28 | |
| 29 | /** |
| 30 | * Valid fields for Revenue report. |
| 31 | * |
| 32 | * @return array |
| 33 | */ |
| 34 | protected function get_default_query_vars() { |
| 35 | return array( |
| 36 | 'per_page' => get_option( 'posts_per_page' ), // not sure if this should be the default. |
| 37 | 'page' => 1, |
| 38 | 'order' => 'DESC', |
| 39 | 'orderby' => 'date', |
| 40 | 'before' => '', |
| 41 | 'after' => '', |
| 42 | 'interval' => 'week', |
| 43 | 'fields' => array( |
| 44 | 'orders_count', |
| 45 | 'num_items_sold', |
| 46 | 'total_sales', |
| 47 | 'coupons', |
| 48 | 'coupons_count', |
| 49 | 'refunds', |
| 50 | 'taxes', |
| 51 | 'shipping', |
| 52 | 'net_revenue', |
| 53 | 'gross_sales', |
| 54 | ), |
| 55 | ); |
| 56 | } |
| 57 | |
| 58 | /** |
| 59 | * Get revenue data based on the current query vars. |
| 60 | * |
| 61 | * @return array |
| 62 | */ |
| 63 | public function get_data() { |
| 64 | $args = apply_filters( 'woocommerce_analytics_revenue_query_args', $this->get_query_vars() ); |
| 65 | |
| 66 | $data_store = \WC_Data_Store::load( 'report-revenue-stats' ); |
| 67 | $results = $data_store->get_data( $args ); |
| 68 | return apply_filters( 'woocommerce_analytics_revenue_select_query', $results, $args ); |
| 69 | } |
| 70 | } |
| 71 |