geo.php
3 years ago
page.php
3 years ago
page_author_archive.php
3 years ago
page_date_archive.php
3 years ago
page_home.php
3 years ago
page_not_found.php
3 years ago
page_post_type_archive.php
3 years ago
page_search.php
3 years ago
page_singular.php
3 years ago
page_term_archive.php
3 years ago
referrer.php
3 years ago
visitor.php
3 years ago
referrer.php
135 lines
| 1 | <?php |
| 2 | |
| 3 | namespace IAWP; |
| 4 | |
| 5 | class Referrer |
| 6 | { |
| 7 | private $is_direct; |
| 8 | private $referrer_ids; |
| 9 | private $group_name; |
| 10 | private $domain; |
| 11 | private $type; |
| 12 | private $views; |
| 13 | private $visitors; |
| 14 | |
| 15 | public function __construct(?array $ids, ?string $group_name, ?string $domain, ?string $type, int $views, int $visitors) |
| 16 | { |
| 17 | $this->is_direct = is_null($ids); |
| 18 | $this->referrer_ids = $ids; |
| 19 | $this->group_name = $group_name; |
| 20 | $this->domain = $domain; |
| 21 | $this->type = $type; |
| 22 | $this->views = $views; |
| 23 | $this->visitors = $visitors; |
| 24 | } |
| 25 | |
| 26 | /** |
| 27 | * Returns an array of all ids for a referrer group. |
| 28 | * Direct traffic has an empty array. |
| 29 | * Referrer traffic has an array with a single id. |
| 30 | * Grouped referrer traffic has an array of multiple grouped referrer ids. |
| 31 | * |
| 32 | * @return array Associated ids |
| 33 | */ |
| 34 | protected function ids(): array |
| 35 | { |
| 36 | if ($this->is_direct) { |
| 37 | return []; |
| 38 | } |
| 39 | |
| 40 | return $this->referrer_ids; |
| 41 | } |
| 42 | |
| 43 | /** |
| 44 | * Returns label text used for referral traffic link. |
| 45 | * |
| 46 | * @return string Referrer label text |
| 47 | */ |
| 48 | public function referrer_label(): string |
| 49 | { |
| 50 | if ($this->is_direct) { |
| 51 | return 'Direct'; |
| 52 | } |
| 53 | |
| 54 | // For ungrouped referrers, strip any potential www. prefix |
| 55 | if (str_starts_with($this->group_name, 'www.')) { |
| 56 | return substr($this->group_name, 4); |
| 57 | } |
| 58 | |
| 59 | return $this->group_name; |
| 60 | } |
| 61 | |
| 62 | /** |
| 63 | * Return group name, referrer url, or direct. |
| 64 | * |
| 65 | * @return string Referrer |
| 66 | */ |
| 67 | public function referrer(): string |
| 68 | { |
| 69 | if ($this->is_direct) { |
| 70 | return 'Direct'; |
| 71 | } |
| 72 | |
| 73 | return $this->domain; |
| 74 | } |
| 75 | |
| 76 | /** |
| 77 | * Return group referrer type, referrer, or direct. |
| 78 | * |
| 79 | * @return string Referrer type |
| 80 | */ |
| 81 | public function referrer_type(): string |
| 82 | { |
| 83 | if ($this->is_direct) { |
| 84 | return 'Direct'; |
| 85 | } |
| 86 | |
| 87 | if (is_null($this->type)) { |
| 88 | return 'Referrer'; |
| 89 | } |
| 90 | |
| 91 | return $this->type; |
| 92 | } |
| 93 | |
| 94 | /** |
| 95 | * @return int |
| 96 | */ |
| 97 | public function views(): int |
| 98 | { |
| 99 | return $this->views; |
| 100 | } |
| 101 | |
| 102 | /** |
| 103 | * @return int |
| 104 | */ |
| 105 | public function visitors(): int |
| 106 | { |
| 107 | return $this->visitors; |
| 108 | } |
| 109 | |
| 110 | /** |
| 111 | * @return bool |
| 112 | */ |
| 113 | public function is_direct(): bool |
| 114 | { |
| 115 | return $this->is_direct; |
| 116 | } |
| 117 | |
| 118 | public static function referrer_ids(array $referrers): array |
| 119 | { |
| 120 | if (count($referrers) === 0) { |
| 121 | return []; |
| 122 | } |
| 123 | |
| 124 | $array_of_arrays = array_map(function ($referrer) { |
| 125 | if ($referrer->is_direct()) { |
| 126 | return [null]; |
| 127 | } |
| 128 | |
| 129 | return $referrer->ids(); |
| 130 | }, $referrers); |
| 131 | |
| 132 | return array_merge(...$array_of_arrays); |
| 133 | } |
| 134 | } |
| 135 |