Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
72.73%
16 / 22
75.00%
6 / 8
 CRAP
0.00%
0 / 1
Average_Items_Per_Order_Controller
71.43%
15 / 21
75.00%
6 / 8
 9.49
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%
4 / 4
100.00%
1 / 1
 1
 format_row_for_csv
100.00%
5 / 5
100.00%
1 / 1
 1
 get_default_values
100.00%
3 / 3
100.00%
1 / 1
 1
 get_fields
0.00%
0 / 3
0.00%
0 / 1
 2
 get_additional_params
0.00%
0 / 3
0.00%
0 / 1
 2
1<?php
2/**
3 * REST API Reports Average Items Per Order 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 * Average Items Per Order CSV Export Controller.
18 *
19 * Handles CSV exports for the Average Items Per Order report, supporting both
20 * single interval and comparison interval data.
21 *
22 * @since $$next-version$$
23 */
24class Average_Items_Per_Order_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 'averageitemsperorder';
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 __( 'Average Items Per Order', '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            'avg_items'     => __( 'Avg items per order', 'jetpack-premium-analytics' ),
63        );
64    }
65
66    /**
67     * Format a row for CSV export.
68     *
69     * @param array       $item     The row data.
70     * @param string|null $interval Optional time interval for formatting.
71     * @return array The formatted row.
72     */
73    public function format_row_for_csv( array $item, ?string $interval = null ): array {
74        $defaults = $this->get_default_values();
75
76        return array(
77            'time_interval' => $this->format_time_interval( $item, $interval ),
78            'avg_items'     => self::format_amount( $item['avg_items'] ?? $defaults['avg_items'] ),
79        );
80    }
81
82    /**
83     * Get default values for missing data fields.
84     *
85     * @return array Array of field_name => default_value pairs.
86     */
87    public function get_default_values(): array {
88        return array(
89            'avg_items' => 0,
90        );
91    }
92
93    /**
94     * Get the list of API fields needed for this report.
95     *
96     * @return array
97     */
98    public function get_fields(): array {
99        // time_interval, date_start, and date_end are always returned by the
100        // API for time-series endpoints and do not need to be requested.
101        return array(
102            'avg_items',
103        );
104    }
105
106    /**
107     * Get additional request parameters for data fetching.
108     *
109     * @return array Additional parameters to include in data requests.
110     */
111    public function get_additional_params(): array {
112        return array(
113            'date_type' => self::DEFAULT_DATE_TYPE,
114        );
115    }
116}