AJAX
2 years ago
Date_Range
2 years ago
Interval
2 years ago
Menu_Bar_Stats
2 years ago
Migrations
2 years ago
Models
2 years ago
Public_API
2 years ago
Rows
2 years ago
Statistics
2 years ago
Tables
2 years ago
Utils
2 years ago
Campaign_Builder.php
2 years ago
Capability_Manager.php
2 years ago
Chart.php
2 years ago
Chart_Geo.php
2 years ago
Cron_Manager.php
2 years ago
Current_Traffic_Finder.php
2 years ago
Dashboard_Options.php
2 years ago
Dashboard_Widget.php
2 years ago
Database_Manager.php
2 years ago
Email_Chart.php
2 years ago
Email_Reports.php
2 years ago
Empty_Report_Option.php
2 years ago
Env.php
2 years ago
Filters.php
2 years ago
Geo_Database_Background_Job.php
2 years ago
Geo_Database_Manager.php
2 years ago
Geoposition.php
2 years ago
Icon_Directory.php
2 years ago
Icon_Directory_Factory.php
2 years ago
Illuminate_Builder.php
2 years ago
Independent_Analytics.php
2 years ago
Interrupt.php
2 years ago
Known_Referrers.php
2 years ago
Plugin_Conflict_Detector.php
2 years ago
Query.php
2 years ago
Quick_Stats.php
2 years ago
REST_API.php
2 years ago
Real_Time.php
2 years ago
Report.php
2 years ago
Report_Finder.php
2 years ago
Report_Options_Parser.php
2 years ago
Resource_Identifier.php
2 years ago
Settings.php
2 years ago
Sort_Configuration.php
2 years ago
Track_Resource_Changes.php
2 years ago
View.php
2 years ago
View_Counter.php
2 years ago
Visitors_Over_Time_Finder.php
2 years ago
WP_Option_Cache_Bust.php
2 years ago
WooCommerce_Order.php
2 years ago
WooCommerce_Referrer_Meta_Box.php
2 years ago
Dashboard_Options.php
153 lines
| 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 | * @internal |
| 19 | */ |
| 20 | class Dashboard_Options |
| 21 | { |
| 22 | private $report_id; |
| 23 | private $report; |
| 24 | public function __construct() |
| 25 | { |
| 26 | $this->report_id = \array_key_exists('report', $_GET) ? \sanitize_text_field($_GET['report']) : null; |
| 27 | $this->report = $this->fetch_report_by_id($this->report_id); |
| 28 | } |
| 29 | public function columns() : ?array |
| 30 | { |
| 31 | if (\is_null($this->report->columns ?? null)) { |
| 32 | return null; |
| 33 | } |
| 34 | return \json_decode($this->report->columns, \true); |
| 35 | } |
| 36 | public function visible_datasets() : array |
| 37 | { |
| 38 | if (\is_null($this->report->visible_datasets ?? null)) { |
| 39 | return ['visitors', 'views']; |
| 40 | } |
| 41 | return \json_decode($this->report->visible_datasets, \true); |
| 42 | } |
| 43 | public function filters() : array |
| 44 | { |
| 45 | if (\is_null($this->report->filters ?? null)) { |
| 46 | return []; |
| 47 | } |
| 48 | return \json_decode($this->report->filters, \true); |
| 49 | } |
| 50 | public function sort_column() : string |
| 51 | { |
| 52 | return $this->report->sort_column ?? 'visitors'; |
| 53 | } |
| 54 | public function sort_direction() : string |
| 55 | { |
| 56 | return $this->report->sort_direction ?? 'desc'; |
| 57 | } |
| 58 | public function group() : ?string |
| 59 | { |
| 60 | return $this->report->group_name ?? null; |
| 61 | } |
| 62 | public function chart_interval() : ?Interval |
| 63 | { |
| 64 | if (\is_null($this->report->chart_interval ?? null)) { |
| 65 | return Intervals::default_for($this->get_date_range()->number_of_days()); |
| 66 | } |
| 67 | return Intervals::find_by_id($this->report->chart_interval); |
| 68 | } |
| 69 | /** |
| 70 | * @return Date_Range |
| 71 | */ |
| 72 | public function get_date_range() : Date_Range |
| 73 | { |
| 74 | if ($this->has_exact_range()) { |
| 75 | try { |
| 76 | $start = new DateTime($this->start(), Timezone::site_timezone()); |
| 77 | $end = new DateTime($this->end(), Timezone::site_timezone()); |
| 78 | return new Exact_Date_Range($start, $end); |
| 79 | } catch (Throwable $e) { |
| 80 | // Do nothing and fall back to default relative date range |
| 81 | } |
| 82 | } |
| 83 | return new Relative_Date_Range($this->relative_range_id()); |
| 84 | } |
| 85 | public function start() : ?string |
| 86 | { |
| 87 | if (!$this->has_exact_range()) { |
| 88 | return null; |
| 89 | } |
| 90 | return $this->report->exact_start; |
| 91 | } |
| 92 | public function end() : ?string |
| 93 | { |
| 94 | if (!$this->has_exact_range()) { |
| 95 | return null; |
| 96 | } |
| 97 | return $this->report->exact_end; |
| 98 | } |
| 99 | /** |
| 100 | * Prefer exact range to relative range if both are provided |
| 101 | */ |
| 102 | public function relative_range_id() : ?string |
| 103 | { |
| 104 | $relative_range_id = $this->report->relative_range_id ?? null; |
| 105 | if (!$this->has_exact_range() && $relative_range_id === null) { |
| 106 | return 'LAST_THIRTY'; |
| 107 | } elseif ($this->has_exact_range()) { |
| 108 | return null; |
| 109 | } elseif (Relative_Date_Range::is_valid_range($relative_range_id) === \false) { |
| 110 | return 'LAST_THIRTY'; |
| 111 | } |
| 112 | return $relative_range_id; |
| 113 | } |
| 114 | public function maybe_redirect() : void |
| 115 | { |
| 116 | $page = $_GET['page'] ?? null; |
| 117 | if (\is_admin() && $page === 'independent-analytics' && empty($_GET['report']) && empty($_GET['tab'])) { |
| 118 | $favorite_report = Report_Finder::get_favorite(); |
| 119 | if (!\is_null($favorite_report)) { |
| 120 | \wp_safe_redirect($favorite_report->url()); |
| 121 | exit; |
| 122 | } |
| 123 | } |
| 124 | $is_invalid_report_id = !\is_null($this->report_id) && \is_null($this->report); |
| 125 | if (\is_admin() && $page === 'independent-analytics' && $is_invalid_report_id) { |
| 126 | \wp_safe_redirect(\IAWP_SCOPED\iawp_dashboard_url(['tab' => \IAWP_SCOPED\iawp()->get_current_tab()])); |
| 127 | exit; |
| 128 | } |
| 129 | $is_incorrect_tab = !\is_null($this->report) && \IAWP_SCOPED\iawp()->get_current_tab() !== $this->report->type; |
| 130 | if (\is_admin() && $page === 'independent-analytics' && $is_incorrect_tab) { |
| 131 | \wp_safe_redirect(\IAWP_SCOPED\iawp_dashboard_url(['tab' => $this->report->type, 'report' => $this->report->report_id])); |
| 132 | exit; |
| 133 | } |
| 134 | } |
| 135 | public function is_sidebar_collapsed() : bool |
| 136 | { |
| 137 | $is_sidebar_collapsed = \get_user_meta(\get_current_user_id(), 'iawp_is_sidebar_collapsed', \true) === '1'; |
| 138 | return $is_sidebar_collapsed; |
| 139 | } |
| 140 | private function fetch_report_by_id($report_id) : ?object |
| 141 | { |
| 142 | $reports_table = Query::get_table_name(Query::REPORTS); |
| 143 | if (\is_null($report_id)) { |
| 144 | return null; |
| 145 | } |
| 146 | return Illuminate_Builder::get_builder()->from($reports_table)->where('report_id', '=', $report_id)->first(); |
| 147 | } |
| 148 | private function has_exact_range() : bool |
| 149 | { |
| 150 | return !\is_null($this->report->exact_start ?? null) && !\is_null($this->report->exact_end ?? null); |
| 151 | } |
| 152 | } |
| 153 |