Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
84.21%
16 / 19
85.71%
6 / 7
 CRAP
0.00%
0 / 1
Visitors_Over_Time_Controller
83.33%
15 / 18
85.71%
6 / 7
 7.23
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
 get_default_values
100.00%
3 / 3
100.00%
1 / 1
 1
 format_row_for_csv
100.00%
5 / 5
100.00%
1 / 1
 1
 get_fields
0.00%
0 / 3
0.00%
0 / 1
 2
1<?php
2/**
3 * REST API Reports Visitors 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 * Visitors Over Time CSV Export Controller.
18 *
19 * Handles CSV exports for the Visitors Over Time report, supporting both
20 * single interval and comparison interval data.
21 *
22 * @since $$next-version$$
23 */
24class Visitors_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 'visitorsovertime';
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 __( 'Visitors 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/sessions/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            'visitors'      => __( 'Visitors', 'jetpack-premium-analytics' ),
63        );
64    }
65
66    /**
67     * Get default values for missing data fields.
68     *
69     * @return array Array of field_name => default_value pairs.
70     */
71    public function get_default_values(): array {
72        return array(
73            'visitors' => 0,
74        );
75    }
76
77    /**
78     * Format a row for CSV export.
79     *
80     * @param array       $item     The row data.
81     * @param string|null $interval Optional time interval for formatting.
82     * @return array The formatted row.
83     */
84    public function format_row_for_csv( array $item, ?string $interval = null ): array {
85        $defaults = $this->get_default_values();
86        return array(
87            'time_interval' => $this->format_time_interval( $item, $interval ),
88            'visitors'      => $item['visitors'] ?? $defaults['visitors'],
89        );
90    }
91
92    /**
93     * Get the list of API fields needed for this report.
94     *
95     * @return array
96     */
97    public function get_fields(): array {
98        // time_interval, date_start, and date_end are always returned by the
99        // API for time-series endpoints and do not need to be requested.
100        return array(
101            'visitors',
102        );
103    }
104}