Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
81.82%
18 / 22
85.71%
6 / 7
 CRAP
0.00%
0 / 1
Average_Items_Per_Order_Controller
80.95%
17 / 21
85.71%
6 / 7
 9.56
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%
6 / 6
100.00%
1 / 1
 3
 get_default_values
100.00%
4 / 4
100.00%
1 / 1
 1
 get_fields
0.00%
0 / 4
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 0.1.0
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-pkg' );
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-pkg' ),
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        $has_orders = (int) ( $item['orders_no'] ?? $defaults['orders_no'] ) > 0 && isset( $item['avg_items'] );
76
77        return array(
78            'time_interval' => $this->format_time_interval( $item, $interval ),
79            'avg_items'     => $has_orders ? self::format_amount( $item['avg_items'] ) : '',
80        );
81    }
82
83    /**
84     * Get default values for missing data fields.
85     *
86     * @return array Array of field_name => default_value pairs.
87     */
88    public function get_default_values(): array {
89        return array(
90            'orders_no' => 0,
91            'avg_items' => 0,
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            'avg_items',
106        );
107    }
108}