Dashboard_Options.php at 2.1.4 · Independent Analytics – WordPress Analytics Plugin

independent-analytics / IAWP / Dashboard_Options.php

Dashboard_Options.php

152 lines 5.3 KB

Raw Download Zip

1	<?php
2
3	namespace IAWP_SCOPED\IAWP;
4
5	use DateTime;
6	use IAWP_SCOPED\IAWP\Date_Range\Date_Range;
7	use IAWP_SCOPED\IAWP\Date_Range\Exact_Date_Range;
8	use IAWP_SCOPED\IAWP\Date_Range\Relative_Date_Range;
9	use IAWP_SCOPED\IAWP\Statistics\Intervals\Interval;
10	use IAWP_SCOPED\IAWP\Statistics\Intervals\Intervals;
11	use IAWP_SCOPED\Proper\Timezone;
12	use Throwable;
13	/**
14	* Dashboards support various options via the search query string portion of the URL.
15	*
16	* The Dashboard_Options class give you an interface for fetching any set values or falling back
17	* to a default value as needed.
18	*/
19	class Dashboard_Options
20	{
21	private $report_id;
22	private $report;
23	public function __construct()
24	{
25	$this->report_id = \array_key_exists('report', $_GET) ? \sanitize_text_field($_GET['report']) : null;
26	$this->report = $this->fetch_report_by_id($this->report_id);
27	}
28	public function columns() : ?array
29	{
30	if (\is_null($this->report->columns ?? null)) {
31	return null;
32	}
33	return \json_decode($this->report->columns, \true);
34	}
35	public function visible_datasets() : array
36	{
37	if (\is_null($this->report->visible_datasets ?? null)) {
38	return ['visitors', 'views'];
39	}
40	return \json_decode($this->report->visible_datasets, \true);
41	}
42	public function filters() : array
43	{
44	if (\is_null($this->report->filters ?? null)) {
45	return [];
46	}
47	return \json_decode($this->report->filters, \true);
48	}
49	public function sort_column() : string
50	{
51	return $this->report->sort_column ?? 'visitors';
52	}
53	public function sort_direction() : string
54	{
55	return $this->report->sort_direction ?? 'desc';
56	}
57	public function group() : ?string
58	{
59	return $this->report->group_name ?? null;
60	}
61	public function chart_interval() : ?Interval
62	{
63	if (\is_null($this->report->chart_interval ?? null)) {
64	return Intervals::default_for($this->get_date_range()->number_of_days());
65	}
66	return Intervals::find_by_id($this->report->chart_interval);
67	}
68	/**
69	* @return Date_Range
70	*/
71	public function get_date_range() : Date_Range
72	{
73	if ($this->has_exact_range()) {
74	try {
75	$start = new DateTime($this->start(), Timezone::site_timezone());
76	$end = new DateTime($this->end(), Timezone::site_timezone());
77	return new Exact_Date_Range($start, $end);
78	} catch (Throwable $e) {
79	// Do nothing and fall back to default relative date range
80	}
81	}
82	return new Relative_Date_Range($this->relative_range_id());
83	}
84	public function start() : ?string
85	{
86	if (!$this->has_exact_range()) {
87	return null;
88	}
89	return $this->report->exact_start;
90	}
91	public function end() : ?string
92	{
93	if (!$this->has_exact_range()) {
94	return null;
95	}
96	return $this->report->exact_end;
97	}
98	/**
99	* Prefer exact range to relative range if both are provided
100	*/
101	public function relative_range_id() : ?string
102	{
103	$relative_range_id = $this->report->relative_range_id ?? null;
104	if (!$this->has_exact_range() && $relative_range_id === null) {
105	return 'LAST_THIRTY';
106	} elseif ($this->has_exact_range()) {
107	return null;
108	} elseif (Relative_Date_Range::is_valid_range($relative_range_id) === \false) {
109	return 'LAST_THIRTY';
110	}
111	return $relative_range_id;
112	}
113	public function maybe_redirect() : void
114	{
115	$page = $_GET['page'] ?? null;
116	if (\is_admin() && $page === 'independent-analytics' && empty($_GET['report']) && empty($_GET['tab'])) {
117	$favorite_report = Report_Finder::get_favorite();
118	if (!\is_null($favorite_report)) {
119	\wp_safe_redirect($favorite_report->url());
120	exit;
121	}
122	}
123	$is_invalid_report_id = !\is_null($this->report_id) && \is_null($this->report);
124	if (\is_admin() && $page === 'independent-analytics' && $is_invalid_report_id) {
125	\wp_safe_redirect(\IAWP_SCOPED\iawp_dashboard_url(['tab' => \IAWP_SCOPED\iawp()->get_current_tab()]));
126	exit;
127	}
128	$is_incorrect_tab = !\is_null($this->report) && \IAWP_SCOPED\iawp()->get_current_tab() !== $this->report->type;
129	if (\is_admin() && $page === 'independent-analytics' && $is_incorrect_tab) {
130	\wp_safe_redirect(\IAWP_SCOPED\iawp_dashboard_url(['tab' => $this->report->type, 'report' => $this->report->report_id]));
131	exit;
132	}
133	}
134	public function is_sidebar_collapsed() : bool
135	{
136	$is_sidebar_collapsed = \get_user_meta(\get_current_user_id(), 'iawp_is_sidebar_collapsed', \true) === '1';
137	return $is_sidebar_collapsed;
138	}
139	private function fetch_report_by_id($report_id) : ?object
140	{
141	$reports_table = Query::get_table_name(Query::REPORTS);
142	if (\is_null($report_id)) {
143	return null;
144	}
145	return Illuminate_Builder::get_builder()->from($reports_table)->where('report_id', '=', $report_id)->first();
146	}
147	private function has_exact_range() : bool
148	{
149	return !\is_null($this->report->exact_start ?? null) && !\is_null($this->report->exact_end ?? null);
150	}
151	}
152