nystudio107 /
craft-seomatic
| Total Complexity | 49 |
| Total Lines | 252 |
| Duplicated Lines | 0 % |
| Coverage | 9.9% |
| Changes | 4 | ||
| Bugs | 2 | Features | 0 |
Complex classes like UrlHelper often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use UrlHelper, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 25 | class UrlHelper extends CraftUrlHelper |
||
| 26 | { |
||
| 27 | // Public Static Properties |
||
| 28 | // ========================================================================= |
||
| 29 | |||
| 30 | // Public Static Methods |
||
| 31 | // ========================================================================= |
||
| 32 | |||
| 33 | /** |
||
| 34 | * @inheritDoc |
||
| 35 | */ |
||
| 36 | public static function siteUrl(string $path = '', $params = null, string $scheme = null, int $siteId = null): string |
||
| 62 | } |
||
| 63 | |||
| 64 | /** |
||
| 65 | * Merge the $url and $path together, combining any overlapping path segments |
||
| 66 | * |
||
| 67 | * @param string $url |
||
| 68 | * @param string $path |
||
| 69 | * @return string |
||
| 70 | */ |
||
| 71 | public static function mergeUrlWithPath(string $url, string $path): string |
||
| 72 | { |
||
| 73 | $overlap = 0; |
||
| 74 | $url = rtrim($url, '/'); |
||
| 75 | $path = ltrim($path, '/'); |
||
| 76 | $urlOffset = strlen($url); |
||
| 77 | $pathLength = strlen($path); |
||
| 78 | $pathOffset = 0; |
||
| 79 | while ($urlOffset > 0 && $pathOffset < $pathLength) { |
||
| 80 | $urlOffset--; |
||
| 81 | $pathOffset++; |
||
| 82 | if (str_starts_with($path, substr($url, $urlOffset, $pathOffset))) { |
||
| 83 | $overlap = $pathOffset; |
||
| 84 | } |
||
| 85 | } |
||
| 86 | |||
| 87 | return $url . '/' . ltrim(substr($path, $overlap), '/'); |
||
| 88 | } |
||
| 89 | |||
| 90 | /** |
||
| 91 | * Return the page trigger and the value of the page trigger (null if it doesn't exist) |
||
| 92 | * |
||
| 93 | * @return array |
||
| 94 | */ |
||
| 95 | public static function pageTriggerValue(): array |
||
| 96 | { |
||
| 97 | $pageTrigger = Craft::$app->getConfig()->getGeneral()->pageTrigger; |
||
| 98 | if (!\is_string($pageTrigger) || $pageTrigger === '') { |
||
| 99 | $pageTrigger = 'p'; |
||
| 100 | } |
||
| 101 | // Is this query string-based pagination? |
||
| 102 | if ($pageTrigger[0] === '?') { |
||
| 103 | $pageTrigger = trim($pageTrigger, '?='); |
||
| 104 | } |
||
| 105 | // Avoid conflict with the path param |
||
| 106 | $pathParam = Craft::$app->getConfig()->getGeneral()->pathParam; |
||
| 107 | if ($pageTrigger === $pathParam) { |
||
| 108 | $pageTrigger = $pathParam === 'p' ? 'pg' : 'p'; |
||
| 109 | } |
||
| 110 | $pageTriggerValue = Craft::$app->getRequest()->getParam($pageTrigger); |
||
| 111 | |||
| 112 | return [$pageTrigger, $pageTriggerValue]; |
||
| 113 | } |
||
| 114 | |||
| 115 | /** |
||
| 116 | * Return an absolute URL with protocol that curl will be happy with |
||
| 117 | * |
||
| 118 | * @param string $url |
||
| 119 | * |
||
| 120 | * @return string |
||
| 121 | */ |
||
| 122 | public static function absoluteUrlWithProtocol($url): string |
||
| 123 | { |
||
| 124 | // Make this a full URL |
||
| 125 | if (!self::isAbsoluteUrl($url)) { |
||
| 126 | $protocol = 'http'; |
||
| 127 | if (isset($_SERVER['HTTPS']) && (strcasecmp($_SERVER['HTTPS'], 'on') === 0 || $_SERVER['HTTPS'] == 1) |
||
|
introduced
by
|
|||
| 128 | || isset($_SERVER['HTTP_X_FORWARDED_PROTO']) && strcasecmp($_SERVER['HTTP_X_FORWARDED_PROTO'], 'https') === 0 |
||
| 129 | ) { |
||
| 130 | $protocol = 'https'; |
||
| 131 | } |
||
| 132 | if (self::isProtocolRelativeUrl($url)) { |
||
| 133 | try { |
||
| 134 | $url = self::urlWithScheme($url, $protocol); |
||
| 135 | } catch (SiteNotFoundException $e) { |
||
| 136 | Craft::error($e->getMessage(), __METHOD__); |
||
| 137 | } |
||
| 138 | } else { |
||
| 139 | try { |
||
| 140 | $url = self::siteUrl($url, null, $protocol); |
||
| 141 | if (self::isProtocolRelativeUrl($url)) { |
||
| 142 | $url = self::urlWithScheme($url, $protocol); |
||
| 143 | } |
||
| 144 | } catch (Exception $e) { |
||
| 145 | Craft::error($e->getMessage(), __METHOD__); |
||
| 146 | } |
||
| 147 | } |
||
| 148 | } |
||
| 149 | // Ensure that any spaces in the URL are encoded |
||
| 150 | $url = str_replace(' ', '%20', $url); |
||
| 151 | |||
| 152 | // Handle trailing slashes properly for generated URLs |
||
| 153 | $generalConfig = Craft::$app->getConfig()->getGeneral(); |
||
| 154 | if ($generalConfig->addTrailingSlashesToUrls && !preg_match('/\.[^\/]+$/', $url)) { |
||
| 155 | $url = rtrim($url, '/') . '/'; |
||
| 156 | } |
||
| 157 | if (!$generalConfig->addTrailingSlashesToUrls) { |
||
| 158 | $url = rtrim($url, '/'); |
||
| 159 | } |
||
| 160 | |||
| 161 | return DynamicMeta::sanitizeUrl($url, false, false); |
||
| 162 | } |
||
| 163 | |||
| 164 | /** |
||
| 165 | * urlencode() just the query parameters in the URL |
||
| 166 | * |
||
| 167 | * @param string $url |
||
| 168 | * @return string |
||
| 169 | */ |
||
| 170 | 2 | public static function encodeUrlQueryParams(string $url): string |
|
| 203 | } |
||
| 204 | |||
| 205 | /** |
||
| 206 | * Return whether this URL has a sub-directory as part of it |
||
| 207 | * |
||
| 208 | * @param string $url |
||
| 209 | * @return bool |
||
| 210 | */ |
||
| 211 | public static function urlHasSubDir(string $url): bool |
||
| 212 | { |
||
| 213 | return !empty(parse_url(trim($url, '/'), PHP_URL_PATH)); |
||
| 214 | } |
||
| 215 | |||
| 216 | /** |
||
| 217 | * Return the siteUrlOverride setting, which can be a string or an array of site URLs |
||
| 218 | * indexed by the site handle |
||
| 219 | * |
||
| 220 | * @param int|null $siteId |
||
| 221 | * @return string |
||
| 222 | * @throws Exception |
||
| 223 | * @throws SiteNotFoundException |
||
| 224 | */ |
||
| 225 | public static function getSiteUrlOverrideSetting(?int $siteId = null): string |
||
| 247 | } |
||
| 248 | |||
| 249 | // Protected Methods |
||
| 250 | // ========================================================================= |
||
| 251 | |||
| 252 | /** |
||
| 253 | * Decompose a url into a prefix, path, and suffix |
||
| 254 | * |
||
| 255 | * @param $pathOrUrl |
||
| 256 | * |
||
| 257 | * @return array |
||
| 258 | */ |
||
| 259 | protected static function decomposeUrl($pathOrUrl): array |
||
| 277 | } |
||
| 278 | } |
||
| 279 |
Loading history...