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