Dashboard_Options.php — Independent Analytics – WordPress Analytics Plugin 2.12.0

independent-analytics / IAWP / Dashboard_Options.php

independent-analytics / IAWP Last commit date

AJAX 1 year ago Admin_Page 1 year ago Click_Tracking 1 year ago Custom_WordPress_Columns 1 year ago Data_Pruning 1 year ago Date_Picker 1 year ago Date_Range 1 year ago Ecommerce 1 year ago Email_Reports 1 year ago Examiner 1 year ago Filter_Lists 1 year ago Form_Submissions 1 year ago Integrations 1 year ago Interval 1 year ago Menu_Bar_Stats 1 year ago Migrations 1 year ago Models 1 year ago Overview 1 year ago Public_API 1 year ago Rows 1 year ago Statistics 1 year ago Tables 1 year ago Utils 1 year ago Appearance.php 1 year ago Campaign_Builder.php 1 year ago Capability_Manager.php 1 year ago Chart.php 1 year ago Chart_Data.php 1 year ago Click_Tracking.php 1 year ago Cron_Job.php 1 year ago Cron_Manager.php 1 year ago Current_Traffic_Finder.php 1 year ago Dashboard_Options.php 1 year ago Dashboard_Widget.php 2 years ago Database.php 1 year ago Database_Manager.php 1 year ago Empty_Report_Option.php 2 years ago Env.php 1 year ago Examiner_Config.php 1 year ago Filters.php 1 year ago Geo_Database_Background_Job.php 1 year ago Geo_Database_Manager.php 1 year ago Geoposition.php 1 year ago Icon_Directory.php 2 years ago Icon_Directory_Factory.php 2 years ago Illuminate_Builder.php 1 year ago Independent_Analytics.php 1 year ago Interrupt.php 1 year ago Known_Referrers.php 1 year ago MainWP.php 1 year ago Map.php 1 year ago Map_Data.php 1 year ago Migration_Fixer_Job.php 1 year ago Patch.php 1 year ago Payload_Validator.php 1 year ago Plugin_Conflict_Detector.php 1 year ago Plugin_Group.php 1 year ago Plugin_Group_Option.php 2 years ago Query.php 1 year ago Query_Taps.php 1 year ago Quick_Stats.php 1 year ago REST_API.php 1 year ago Real_Time.php 1 year ago Report.php 1 year ago Report_Finder.php 1 year ago Report_Options_Parser.php 2 years ago Resource_Identifier.php 1 year ago Settings.php 1 year ago Sort_Configuration.php 1 year ago Tables.php 1 year ago Track_Resource_Changes.php 1 year ago View.php 1 year ago View_Counter.php 1 year ago Views_Over_Time_Finder.php 1 year ago WP_Option_Cache_Bust.php 2 years ago

Dashboard_Options.php

218 lines

1	<?php
2
3	namespace IAWP;
4
5	use DateTime;
6	use IAWP\Date_Range\Date_Range;
7	use IAWP\Date_Range\Exact_Date_Range;
8	use IAWP\Date_Range\Relative_Date_Range;
9	use IAWP\Statistics\Intervals\Interval;
10	use IAWP\Statistics\Intervals\Intervals;
11	use IAWP\Utils\Request;
12	use IAWP\Utils\Singleton;
13	use IAWP\Utils\Timezone;
14	use Throwable;
15	/**
16	* Dashboards support various options via the search query string portion of the URL.
17	*
18	* The Dashboard_Options class give you an interface for fetching any set values or falling back
19	* to a default value as needed.
20	* @internal
21	*/
22	class Dashboard_Options
23	{
24	use Singleton;
25	private $report;
26	private static $default_visible_quick_stats = ['visitors', 'views', 'sessions', 'average_session_duration', 'bounce_rate', 'views_per_session', 'wc_orders', 'wc_net_sales'];
27	private function __construct()
28	{
29	$this->report = $this->get_report();
30	}
31	public function report_name() : ?string
32	{
33	if (\is_null($this->report->name ?? null)) {
34	return 'Report';
35	}
36	return $this->report->name;
37	}
38	public function visible_columns() : ?array
39	{
40	if (Request::get_post_array('columns')) {
41	return Request::get_post_array('columns');
42	}
43	if (\is_null($this->report) \|\| \is_null($this->report->columns)) {
44	return null;
45	}
46	return \json_decode($this->report->columns, \true);
47	}
48	public function visible_quick_stats() : array
49	{
50	if (Request::get_post_array('quick_stats')) {
51	return Request::get_post_array('quick_stats');
52	}
53	$decoded_value = \json_decode($this->report->quick_stats ?? 'null', \true);
54	if (\is_array($decoded_value)) {
55	return $decoded_value;
56	}
57	if (\IAWP\Env::get_tab() === 'clicks') {
58	return ['clicks'];
59	}
60	return self::$default_visible_quick_stats;
61	}
62	public function primary_chart_metric_id() : string
63	{
64	if (Request::get_post_string('primary_chart_metric_id')) {
65	return Request::get_post_string('primary_chart_metric_id');
66	}
67	if (\is_null($this->report->primary_chart_metric_id ?? null)) {
68	return 'visitors';
69	}
70	return $this->report->primary_chart_metric_id;
71	}
72	public function secondary_chart_metric_id() : ?string
73	{
74	if (Request::get_post_string('secondary_chart_metric_id')) {
75	return Request::get_post_string('secondary_chart_metric_id');
76	}
77	if (\is_null($this->report->secondary_chart_metric_id ?? null)) {
78	return 'views';
79	}
80	return $this->report->secondary_chart_metric_id;
81	}
82	public function filters() : array
83	{
84	if (\is_null($this->report) \|\| \is_null($this->report->filters)) {
85	return [];
86	}
87	$table_class = \IAWP\Env::get_table($this->report->type);
88	$table = new $table_class($this->report->group_name ?? null);
89	$filters = \json_decode($this->report->filters, \true);
90	return \is_null($filters) ? [] : $table->sanitize_filters($filters);
91	}
92	public function sort_column() : ?string
93	{
94	return $this->report->sort_column ?? null;
95	}
96	public function sort_direction() : ?string
97	{
98	return $this->report->sort_direction ?? null;
99	}
100	public function group() : ?string
101	{
102	return $this->report->group_name ?? null;
103	}
104	public function chart_interval() : ?Interval
105	{
106	if (\is_null($this->report->chart_interval ?? null)) {
107	return Intervals::default_for($this->get_date_range()->number_of_days());
108	}
109	return Intervals::find_by_id($this->report->chart_interval);
110	}
111	/**
112	* @return Date_Range
113	*/
114	public function get_date_range() : Date_Range
115	{
116	if ($this->has_exact_range()) {
117	try {
118	$start = new DateTime($this->start(), Timezone::site_timezone());
119	$end = new DateTime($this->end(), Timezone::site_timezone());
120	return new Exact_Date_Range($start, $end);
121	} catch (Throwable $e) {
122	// Do nothing and fall back to default relative date range
123	}
124	}
125	return new Relative_Date_Range($this->relative_range_id());
126	}
127	public function start() : ?string
128	{
129	if (!$this->has_exact_range()) {
130	return null;
131	}
132	return $this->report->exact_start;
133	}
134	public function end() : ?string
135	{
136	if (!$this->has_exact_range()) {
137	return null;
138	}
139	return $this->report->exact_end;
140	}
141	/**
142	* Prefer exact range to relative range if both are provided
143	*/
144	public function relative_range_id() : ?string
145	{
146	$relative_range_id = $this->report->relative_range_id ?? null;
147	if (!$this->has_exact_range() && $relative_range_id === null) {
148	return 'LAST_THIRTY';
149	} elseif ($this->has_exact_range()) {
150	return null;
151	} elseif (Relative_Date_Range::is_valid_range($relative_range_id) === \false) {
152	return 'LAST_THIRTY';
153	}
154	return $relative_range_id;
155	}
156	public function maybe_redirect() : void
157	{
158	if (\IAWP\Env::get_page() !== 'independent-analytics') {
159	return;
160	}
161	if (isset($_GET['examiner'])) {
162	return;
163	}
164	if (empty($_GET['report']) && empty($_GET['tab'])) {
165	$favorite_report = \IAWP\Report_Finder::new()->get_favorited_report();
166	if (\is_null($favorite_report)) {
167	return;
168	}
169	\wp_safe_redirect($favorite_report->url());
170	exit;
171	}
172	if (!empty($_GET['report']) && \is_null($this->report)) {
173	\wp_safe_redirect(\IAWPSCOPED\iawp_dashboard_url(['tab' => \IAWP\Env::get_tab()]));
174	exit;
175	}
176	if (!\is_null($this->report) && \IAWP\Env::get_tab() !== $this->report->type) {
177	\wp_safe_redirect(\IAWPSCOPED\iawp_dashboard_url(['tab' => $this->report->type, 'report' => $this->report->report_id]));
178	exit;
179	}
180	}
181	public function is_sidebar_collapsed() : bool
182	{
183	$is_sidebar_collapsed = \get_user_meta(\get_current_user_id(), 'iawp_is_sidebar_collapsed', \true) === '1';
184	return $is_sidebar_collapsed;
185	}
186	public function is_examiner() : bool
187	{
188	if (!\IAWPSCOPED\iawp_is_pro()) {
189	return \false;
190	}
191	return \array_key_exists('examiner', $_GET);
192	}
193	private function has_exact_range() : bool
194	{
195	return !\is_null($this->report->exact_start ?? null) && !\is_null($this->report->exact_end ?? null);
196	}
197	private function get_report() : ?object
198	{
199	if ($this->is_examiner()) {
200	return $this->build_examiner_report();
201	}
202	$id = \filter_input(\INPUT_GET, 'report', \FILTER_VALIDATE_INT);
203	if (\is_int($id)) {
204	return $this->fetch_saved_report($id);
205	}
206	return null;
207	}
208	private function build_examiner_report() : object
209	{
210	return (object) ['exact_start' => Request::query('exact_start'), 'exact_end' => Request::query('exact_end'), 'relative_range_id' => Request::query('relative_range_id'), 'quick_stats' => \json_encode(Request::query_array('quick_stats')), 'primary_chart_metric_id' => Request::query('primary_chart_metric_id'), 'secondary_chart_metric_id' => Request::query('secondary_chart_metric_id'), 'chart_interval' => Request::query('chart_interval'), 'group_name' => Request::query('group'), 'filters' => null, 'columns' => null, 'type' => Request::query('tab')];
211	}
212	private function fetch_saved_report(int $id) : ?object
213	{
214	$reports_table = \IAWP\Query::get_table_name(\IAWP\Query::REPORTS);
215	return \IAWP\Illuminate_Builder::new()->from($reports_table)->where('report_id', '=', $id)->first();
216	}
217	}
218