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