Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
73.08%
19 / 26
75.00%
6 / 8
 CRAP
0.00%
0 / 1
Gross_Sales_Over_Time_Controller
72.00%
18 / 25
75.00%
6 / 8
 9.40
0.00%
0 / 1
 get_report_key
100.00%
1 / 1
100.00%
1 / 1
 1
 get_report_label
100.00%
1 / 1
100.00%
1 / 1
 1
 get_data_endpoint
100.00%
1 / 1
100.00%
1 / 1
 1
 get_column_headers
100.00%
5 / 5
100.00%
1 / 1
 1
 get_default_values
100.00%
4 / 4
100.00%
1 / 1
 1
 format_row_for_csv
100.00%
6 / 6
100.00%
1 / 1
 1
 get_fields
0.00%
0 / 4
0.00%
0 / 1
 2
 get_additional_params
0.00%
0 / 3
0.00%
0 / 1
 2
1<?php
2/**
3 * REST API Reports Gross Sales Over Time controller class.
4 *
5 * @package Automattic\Jetpack\PremiumAnalytics\Reports\Export\Exports
6 */
7
8declare( strict_types=1 );
9
10namespace Automattic\Jetpack\PremiumAnalytics\Reports\Export\Exports;
11
12defined( 'ABSPATH' ) || exit;
13
14use Automattic\Jetpack\PremiumAnalytics\Reports\Export\Abstract_Csv_Report_Controller;
15
16/**
17 * Gross Sales Over Time CSV Export Controller.
18 *
19 * Handles CSV exports for the Gross Sales Over Time report, supporting both
20 * single interval and comparison interval data.
21 *
22 * @since $$next-version$$
23 */
24class Gross_Sales_Over_Time_Controller extends Abstract_Csv_Report_Controller {
25
26    /**
27     * Get the report key for this controller.
28     *
29     * @return string The report key.
30     */
31    public function get_report_key(): string {
32        return 'grosssalesovertime';
33    }
34
35    /**
36     * Get the report label for this controller.
37     *
38     * @return string The report label.
39     */
40    public function get_report_label(): string {
41        return __( 'Gross Sales Over Time', 'jetpack-premium-analytics' );
42    }
43
44    /**
45     * Get the data endpoint for this controller.
46     *
47     * @return string The data endpoint.
48     */
49    public function get_data_endpoint(): string {
50        return 'reports/orders/by-date';
51    }
52
53    /**
54     * Get the column headers for this controller.
55     *
56     * @param string|null $interval Optional time interval for dynamic headers.
57     * @return array The column headers.
58     */
59    public function get_column_headers( ?string $interval = null ): array {
60        return array(
61            'time_interval' => $this->get_interval_label( $interval ),
62            'orders_no'     => __( 'Orders', 'jetpack-premium-analytics' ),
63            'gross_sales'   => __( 'Gross sales', 'jetpack-premium-analytics' ),
64        );
65    }
66
67    /**
68     * Get default values for missing data fields.
69     *
70     * @return array Array of field_name => default_value pairs.
71     */
72    public function get_default_values(): array {
73        return array(
74            'orders_no'   => 0,
75            'total_sales' => 0,
76        );
77    }
78
79    /**
80     * Format a row for CSV export.
81     *
82     * @param array       $item     The row data.
83     * @param string|null $interval Optional time interval for formatting.
84     * @return array The formatted row.
85     */
86    public function format_row_for_csv( array $item, ?string $interval = null ): array {
87        $defaults = $this->get_default_values();
88        return array(
89            'time_interval' => $this->format_time_interval( $item, $interval ),
90            'orders_no'     => $item['orders_no'] ?? $defaults['orders_no'],
91            'gross_sales'   => self::format_amount( $item['total_sales'] ?? $defaults['total_sales'] ),
92        );
93    }
94
95    /**
96     * Get the list of API fields needed for this report.
97     *
98     * @return array
99     */
100    public function get_fields(): array {
101        // time_interval, date_start, and date_end are always returned by the
102        // API for time-series endpoints and do not need to be requested.
103        return array(
104            'orders_no',
105            'total_sales',
106        );
107    }
108
109    /**
110     * Get additional request parameters for data fetching.
111     *
112     * @return array Additional parameters to include in data requests.
113     */
114    public function get_additional_params(): array {
115        return array(
116            'date_type' => self::DEFAULT_DATE_TYPE,
117        );
118    }
119}