Lines: 81.82%
| Line | Hits | Source |
|---|---|---|
| 1 | <?php | |
| 2 | ||
| 3 | declare(strict_types=1); | |
| 4 | ||
| 5 | namespace Drupal\visitors\Helper; | |
| 6 | ||
| 7 | /** | |
| 8 | * Query-string helpers for site search detection. | |
| 9 | */ | |
| 10 | final class SiteSearchQuery { | |
| 11 | ||
| 12 | /** | |
| 13 | * Query keys added by Views AJAX, not by the visitor. | |
| 14 | */ | |
| 15 | private const AJAX_PARAMETERS = [ | |
| 16 | 'ajax_form', | |
| 17 | 'ajax_page_state', | |
| 18 | 'views_dom_id', | |
| 19 | '_drupal_ajax', | |
| 20 | '_wrapper_format', | |
| 21 | ]; | |
| 22 | ||
| 23 | /** | |
| 24 | * Reads the query string from a URL. | |
| 25 | * | |
| 26 | * @param string $url | |
| 27 | * A page or referrer URL. | |
| 28 | * | |
| 29 | * @return array | |
| 30 | * The query parameters. An empty array when there are none. | |
| 31 | */ | |
| 32 | public static function fromUrl(string $url): array { | |
| 33 | 11 | if ($url === '') { |
| 34 | 3 | return []; |
| 35 | } | |
| 36 | 11 | $parts = parse_url($url); |
| 37 | 11 | if (!is_array($parts) || empty($parts['query']) || !is_string($parts['query'])) { |
| 38 | 9 | return []; |
| 39 | } | |
| 40 | 4 | $query = []; |
| 41 | 4 | parse_str($parts['query'], $query); |
| 42 | 4 | return $query; |
| 43 | } | |
| 44 | ||
| 45 | /** | |
| 46 | * Path component of a URL. | |
| 47 | * | |
| 48 | * @param string $url | |
| 49 | * A page or referrer URL. | |
| 50 | * | |
| 51 | * @return string | |
| 52 | * The path, or an empty string. | |
| 53 | */ | |
| 54 | public static function pathFromUrl(string $url): string { | |
| 55 | 8 | if ($url === '') { |
| 56 | 3 | return ''; |
| 57 | } | |
| 58 | 5 | $parts = parse_url($url); |
| 59 | 5 | if (!is_array($parts)) { |
| 60 | 0 | return ''; |
| 61 | } | |
| 62 | 5 | return (string) ($parts['path'] ?? ''); |
| 63 | } | |
| 64 | ||
| 65 | /** | |
| 66 | * First non-empty string in a query value. | |
| 67 | * | |
| 68 | * @param mixed $value | |
| 69 | * A query value, which may be a list. | |
| 70 | * | |
| 71 | * @return string | |
| 72 | * The trimmed value, or an empty string. | |
| 73 | */ | |
| 74 | public static function scalar(mixed $value): string { | |
| 75 | 11 | if (is_array($value)) { |
| 76 | 0 | foreach ($value as $item) { |
| 77 | 0 | $scalar = self::scalar($item); |
| 78 | 0 | if ($scalar !== '') { |
| 79 | 0 | return $scalar; |
| 80 | } | |
| 81 | } | |
| 82 | 0 | return ''; |
| 83 | } | |
| 84 | 11 | if (!is_scalar($value)) { |
| 85 | 11 | return ''; |
| 86 | } | |
| 87 | 5 | return trim((string) $value); |
| 88 | } | |
| 89 | ||
| 90 | /** | |
| 91 | * Zero-based results page from the page query parameter. | |
| 92 | * | |
| 93 | * @param array $query | |
| 94 | * The query parameters. | |
| 95 | * | |
| 96 | * @return int | |
| 97 | * The page. Zero when the parameter is missing or not numeric. | |
| 98 | */ | |
| 99 | public static function page(array $query): int { | |
| 100 | 5 | $page = self::scalar($query['page'] ?? NULL); |
| 101 | 5 | if ($page === '') { |
| 102 | 5 | return 0; |
| 103 | } | |
| 104 | 2 | $first = explode(',', $page)[0]; |
| 105 | 2 | if (!is_numeric($first)) { |
| 106 | 0 | return 0; |
| 107 | } | |
| 108 | 2 | return max(0, (int) $first); |
| 109 | } | |
| 110 | ||
| 111 | /** | |
| 112 | * Canonical filter string. | |
| 113 | * | |
| 114 | * The keyword parameter, the page, and Views AJAX parameters are removed. | |
| 115 | * Remaining keys and list values are sorted so the same filters match in | |
| 116 | * any order. | |
| 117 | * | |
| 118 | * @param array $query | |
| 119 | * The query parameters. | |
| 120 | * @param string[] $drop | |
| 121 | * Parameter names to remove before sorting. | |
| 122 | * | |
| 123 | * @return string | |
| 124 | * The filter string. Empty when no filters remain. | |
| 125 | */ | |
| 126 | public static function canonical(array $query, array $drop): string { | |
| 127 | 5 | foreach (array_merge($drop, ['page'], self::AJAX_PARAMETERS) as $key) { |
| 128 | 5 | unset($query[$key]); |
| 129 | } | |
| 130 | 5 | $query = self::sort($query); |
| 131 | 5 | if ($query === []) { |
| 132 | 3 | return ''; |
| 133 | } | |
| 134 | 3 | return http_build_query($query); |
| 135 | } | |
| 136 | ||
| 137 | /** | |
| 138 | * Sorts query keys and list values. | |
| 139 | * | |
| 140 | * @param array $query | |
| 141 | * The query parameters. | |
| 142 | * | |
| 143 | * @return array | |
| 144 | * The sorted parameters. | |
| 145 | */ | |
| 146 | private static function sort(array $query): array { | |
| 147 | 5 | foreach ($query as $key => $value) { |
| 148 | 3 | if (is_array($value)) { |
| 149 | 0 | $query[$key] = self::sort($value); |
| 150 | } | |
| 151 | } | |
| 152 | 5 | if (array_is_list($query)) { |
| 153 | 3 | sort($query); |
| 154 | 3 | return $query; |
| 155 | } | |
| 156 | 3 | ksort($query); |
| 157 | 3 | return $query; |
| 158 | } | |
| 159 | ||
| 160 | } |