Dashboard_Options.php — Independent Analytics – WordPress Analytics Plugin 1.19.0

independent-analytics / IAWP / Dashboard_Options.php

independent-analytics / IAWP Last commit date

AJAX 3 years ago Migrations 3 years ago Models 3 years ago Queries 3 years ago Tables 3 years ago Utils 3 years ago Campaign_Builder.php 3 years ago Capability_Manager.php 3 years ago Chart.php 3 years ago Chart_Geo.php 3 years ago Chart_SVG.php 3 years ago Current_Resource.php 3 years ago Dashboard_Options.php 3 years ago Dashboard_Widget.php 3 years ago Email_Reports.php 3 years ago Filters.php 3 years ago Geo_Database.php 3 years ago Geo_Database_Download_Job.php 3 years ago Health_Check.php 3 years ago Independent_Analytics.php 3 years ago Known_Referrers.php 3 years ago PDF.php 3 years ago Query.php 3 years ago Quick_Stats.php 3 years ago REST_API.php 3 years ago Real_Time.php 3 years ago Settings.php 3 years ago Track_Resource_Changes.php 3 years ago View_Counter.php 3 years ago WP_Option_Cache_Bust.php 3 years ago

Dashboard_Options.php

152 lines

1	<?php
2
3	namespace IAWP;
4
5	use IAWP\Utils\Date_Format;
6	use IAWP\Utils\Exact_Range;
7	use IAWP\Utils\Relative_Range;
8	use IAWP\Utils\Timezone;
9
10	/**
11	* Dashboards support various options via the search query string portion of the URL.
12	*
13	* The Dashboard_Options class give you an interface for fetching any set values or falling back
14	* to a default value as needed.
15	*/
16	class Dashboard_Options
17	{
18	public function __construct()
19	{
20	}
21
22	private function get_query_value($key)
23	{
24	$value = $_GET[$key] ?? null;
25
26	if ($value === null) {
27	return null;
28	}
29
30	return sanitize_text_field($value);
31	}
32
33	private function has_exact_range()
34	{
35	return $this->get_query_value('start') !== null && $this->get_query_value('end') !== null;
36	}
37
38	public function start()
39	{
40	$start = $this->get_query_value('start');
41
42	if (!$this->has_exact_range()) {
43	return null;
44	}
45
46	return $start;
47	}
48
49	public function end()
50	{
51	$end = $this->get_query_value('end');
52
53	if (!$this->has_exact_range()) {
54	return null;
55	}
56
57	return $end;
58	}
59
60	/**
61	* Prefer exact range over relative range if both are provided
62	*/
63	public function relative_range()
64	{
65	$range = $this->get_query_value('relative_range');
66
67	if (!$this->has_exact_range() && $range === null) {
68	return 'LAST_THIRTY';
69	} elseif ($this->has_exact_range()) {
70	return null;
71	} elseif (Relative_Range::range($range) === null) {
72	return 'LAST_THIRTY';
73	}
74
75	return $range;
76	}
77
78	public function date_label()
79	{
80	if ($this->has_exact_range()) {
81	$tz = Timezone::local_timezone();
82	$format = Date_Format::php();
83	$formatted_start = (new \DateTime($this->start(), $tz))->format($format);
84	$formatted_end = (new \DateTime($this->end(), $tz))->format($format);
85
86	return $formatted_start . ' - ' . $formatted_end;
87	} else {
88	return Relative_Range::range($this->relative_range())->label;
89	}
90	}
91
92	public function date_range()
93	{
94	if ($this->has_exact_range()) {
95	return new Exact_Range($this->start(), $this->end());
96	} else {
97	return Relative_Range::range($this->relative_range());
98	}
99	}
100
101	public function columns()
102	{
103	$value = $_GET['cols'] ?? null;
104
105	if ($value === null) {
106	return null;
107	}
108
109	$columns = explode(',', $value);
110
111	array_map(function ($column) {
112	return sanitize_text_field($column);
113	}, $columns);
114
115	return $columns;
116	}
117
118	public function filters()
119	{
120	$value = $_GET['filters'] ?? null;
121
122	if ($value === null) {
123	return [];
124	} else {
125	$value = base64_decode($value);
126	$filters = json_decode($value);
127
128	$sanitized_filters = [];
129
130	foreach ($filters as $filter) {
131	$sanitized_filter = [];
132	foreach ($filter as $key => $value) {
133	$sanitized_filter[$key] = sanitize_text_field($value);
134	}
135	$sanitized_filters[] = $sanitized_filter;
136	}
137	}
138
139	return $sanitized_filters;
140	}
141
142	public function sort_by()
143	{
144	return $this->get_query_value('sort_by') ?? 'visitors';
145	}
146
147	public function sort_direction()
148	{
149	return $this->get_query_value('sort_direction') ?? 'desc';
150	}
151	}
152