mcamara /
laravel-localization
Complex classes like LaravelLocalization 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. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
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 LaravelLocalization, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 15 | class LaravelLocalization |
||
| 16 | { |
||
| 17 | /** |
||
| 18 | * Config repository. |
||
| 19 | * |
||
| 20 | * @var \Illuminate\Config\Repository |
||
| 21 | */ |
||
| 22 | protected $configRepository; |
||
| 23 | |||
| 24 | /** |
||
| 25 | * Illuminate view Factory. |
||
| 26 | * |
||
| 27 | * @var \Illuminate\View\Factory |
||
| 28 | */ |
||
| 29 | protected $view; |
||
| 30 | |||
| 31 | /** |
||
| 32 | * Illuminate translator class. |
||
| 33 | * |
||
| 34 | * @var \Illuminate\Translation\Translator |
||
| 35 | */ |
||
| 36 | protected $translator; |
||
| 37 | |||
| 38 | /** |
||
| 39 | * Illuminate router class. |
||
| 40 | * |
||
| 41 | * @var \Illuminate\Routing\Router |
||
| 42 | */ |
||
| 43 | protected $router; |
||
| 44 | |||
| 45 | /** |
||
| 46 | * Illuminate request class. |
||
| 47 | * |
||
| 48 | * @var \Illuminate\Routing\Request |
||
| 49 | */ |
||
| 50 | protected $request; |
||
| 51 | |||
| 52 | /** |
||
| 53 | * Illuminate url class. |
||
| 54 | * |
||
| 55 | * @var \Illuminate\Routing\UrlGenerator |
||
| 56 | */ |
||
| 57 | protected $url; |
||
| 58 | |||
| 59 | /** |
||
| 60 | * Illuminate request class. |
||
| 61 | * |
||
| 62 | * @var Illuminate\Foundation\Application |
||
| 63 | */ |
||
| 64 | protected $app; |
||
| 65 | |||
| 66 | /** |
||
| 67 | * Illuminate request class. |
||
| 68 | * |
||
| 69 | * @var string |
||
| 70 | */ |
||
| 71 | protected $baseUrl; |
||
| 72 | |||
| 73 | /** |
||
| 74 | * Default locale. |
||
| 75 | * |
||
| 76 | * @var string |
||
| 77 | */ |
||
| 78 | protected $defaultLocale; |
||
| 79 | |||
| 80 | /** |
||
| 81 | * Supported Locales. |
||
| 82 | * |
||
| 83 | * @var array |
||
| 84 | */ |
||
| 85 | protected $supportedLocales; |
||
| 86 | |||
| 87 | /** |
||
| 88 | * Current locale. |
||
| 89 | * |
||
| 90 | * @var string |
||
| 91 | */ |
||
| 92 | protected $currentLocale = false; |
||
| 93 | |||
| 94 | /** |
||
| 95 | * An array that contains all routes that should be translated. |
||
| 96 | * |
||
| 97 | * @var array |
||
| 98 | */ |
||
| 99 | protected $translatedRoutes = []; |
||
| 100 | |||
| 101 | /** |
||
| 102 | * Name of the translation key of the current route, it is used for url translations. |
||
| 103 | * |
||
| 104 | * @var string |
||
| 105 | */ |
||
| 106 | protected $routeName; |
||
| 107 | |||
| 108 | /** |
||
| 109 | * Creates new instance. |
||
| 110 | * |
||
| 111 | * @throws UnsupportedLocaleException |
||
| 112 | */ |
||
| 113 | public function __construct() |
||
| 132 | |||
| 133 | /** |
||
| 134 | * Set and return current locale. |
||
| 135 | * |
||
| 136 | * @param string $locale Locale to set the App to (optional) |
||
| 137 | * |
||
| 138 | * @return string Returns locale (if route has any) or null (if route does not have a locale) |
||
| 139 | */ |
||
| 140 | public function setLocale($locale = null) |
||
| 181 | |||
| 182 | /** |
||
| 183 | * Set and return supported locales. |
||
| 184 | * |
||
| 185 | * @param array $locales Locales that the App supports |
||
| 186 | */ |
||
| 187 | public function setSupportedLocales($locales) |
||
| 191 | |||
| 192 | /** |
||
| 193 | * Returns an URL adapted to $locale or current locale. |
||
| 194 | * |
||
| 195 | * @param string $url URL to adapt. If not passed, the current url would be taken. |
||
| 196 | * @param string|bool $locale Locale to adapt, false to remove locale |
||
| 197 | * |
||
| 198 | * @throws UnsupportedLocaleException |
||
| 199 | * |
||
| 200 | * @return string URL translated |
||
| 201 | */ |
||
| 202 | public function localizeURL($url = null, $locale = null) |
||
| 206 | |||
| 207 | /** |
||
| 208 | * Returns an URL adapted to $locale. |
||
| 209 | * |
||
| 210 | * |
||
| 211 | * @param string|bool $locale Locale to adapt, false to remove locale |
||
| 212 | * @param string|false $url URL to adapt in the current language. If not passed, the current url would be taken. |
||
| 213 | * @param array $attributes Attributes to add to the route, if empty, the system would try to extract them from the url. |
||
| 214 | * @param bool $forceDefaultLocation Force to show default location even hideDefaultLocaleInURL set as TRUE |
||
| 215 | * |
||
| 216 | * @throws SupportedLocalesNotDefined |
||
| 217 | * @throws UnsupportedLocaleException |
||
| 218 | * |
||
| 219 | * @return string|false URL translated, False if url does not exist |
||
| 220 | */ |
||
| 221 | public function getLocalizedURL($locale = null, $url = null, $attributes = [], $forceDefaultLocation = false) |
||
| 222 | { |
||
| 223 | if ($locale === null) { |
||
| 224 | $locale = $this->getCurrentLocale(); |
||
| 225 | } |
||
| 226 | |||
| 227 | if (!$this->checkLocaleInSupportedLocales($locale)) { |
||
| 228 | throw new UnsupportedLocaleException('Locale \''.$locale.'\' is not in the list of supported locales.'); |
||
| 229 | } |
||
| 230 | |||
| 231 | if (empty($attributes)) { |
||
| 232 | $attributes = $this->extractAttributes($url, $locale); |
||
|
|
|||
| 233 | } |
||
| 234 | |||
| 235 | if (empty($url)) { |
||
| 236 | if (!empty($this->routeName)) { |
||
| 237 | return $this->getURLFromRouteNameTranslated($locale, $this->routeName, $attributes, $forceDefaultLocation); |
||
| 238 | } |
||
| 239 | |||
| 240 | $url = $this->request->fullUrl(); |
||
| 241 | } else { |
||
| 242 | $url = $this->url->to($url); |
||
| 243 | } |
||
| 244 | |||
| 245 | if ($locale && $translatedRoute = $this->findTranslatedRouteByUrl($url, $attributes, $this->currentLocale)) { |
||
| 246 | return $this->getURLFromRouteNameTranslated($locale, $translatedRoute, $attributes, $forceDefaultLocation); |
||
| 247 | } |
||
| 248 | |||
| 249 | $base_path = $this->request->getBaseUrl(); |
||
| 250 | $parsed_url = parse_url($url); |
||
| 251 | $url_locale = $this->getDefaultLocale(); |
||
| 252 | |||
| 253 | if (!$parsed_url || empty($parsed_url['path'])) { |
||
| 254 | $path = $parsed_url['path'] = ''; |
||
| 255 | } else { |
||
| 256 | $parsed_url['path'] = str_replace($base_path, '', '/'.ltrim($parsed_url['path'], '/')); |
||
| 257 | $path = $parsed_url['path']; |
||
| 258 | foreach ($this->getSupportedLocales() as $localeCode => $lang) { |
||
| 259 | $parsed_url['path'] = preg_replace('%^/?'.$localeCode.'/%', '$1', $parsed_url['path']); |
||
| 260 | if ($parsed_url['path'] !== $path) { |
||
| 261 | $url_locale = $localeCode; |
||
| 262 | break; |
||
| 263 | } |
||
| 264 | |||
| 265 | $parsed_url['path'] = preg_replace('%^/?'.$localeCode.'$%', '$1', $parsed_url['path']); |
||
| 266 | if ($parsed_url['path'] !== $path) { |
||
| 267 | $url_locale = $localeCode; |
||
| 268 | break; |
||
| 269 | } |
||
| 270 | } |
||
| 271 | } |
||
| 272 | |||
| 273 | $parsed_url['path'] = ltrim($parsed_url['path'], '/'); |
||
| 274 | |||
| 275 | if ($translatedRoute = $this->findTranslatedRouteByPath($parsed_url['path'], $url_locale)) { |
||
| 276 | return $this->getURLFromRouteNameTranslated($locale, $translatedRoute, $attributes, $forceDefaultLocation); |
||
| 277 | } |
||
| 278 | |||
| 279 | if (!empty($locale)) { |
||
| 280 | if ($locale != $this->getDefaultLocale() || !$this->hideDefaultLocaleInURL() || $forceDefaultLocation) { |
||
| 281 | $parsed_url['path'] = $locale.'/'.ltrim($parsed_url['path'], '/'); |
||
| 282 | } |
||
| 283 | } |
||
| 284 | $parsed_url['path'] = ltrim(ltrim($base_path, '/').'/'.$parsed_url['path'], '/'); |
||
| 285 | |||
| 286 | //Make sure that the pass path is returned with a leading slash only if it come in with one. |
||
| 287 | if (starts_with($path, '/') === true) { |
||
| 288 | $parsed_url['path'] = '/'.$parsed_url['path']; |
||
| 289 | } |
||
| 290 | $parsed_url['path'] = rtrim($parsed_url['path'], '/'); |
||
| 291 | |||
| 292 | $url = $this->unparseUrl($parsed_url); |
||
| 293 | |||
| 294 | if ($this->checkUrl($url)) { |
||
| 295 | return $url; |
||
| 296 | } |
||
| 297 | |||
| 298 | return $this->createUrlFromUri($url); |
||
| 299 | } |
||
| 300 | |||
| 301 | /** |
||
| 302 | * Returns an URL adapted to the route name and the locale given. |
||
| 303 | * |
||
| 304 | * |
||
| 305 | * @param string|bool $locale Locale to adapt |
||
| 306 | * @param string $transKeyName Translation key name of the url to adapt |
||
| 307 | * @param array $attributes Attributes for the route (only needed if transKeyName needs them) |
||
| 308 | * @param bool $forceDefaultLocation Force to show default location even hideDefaultLocaleInURL set as TRUE |
||
| 309 | * |
||
| 310 | * @throws SupportedLocalesNotDefined |
||
| 311 | * @throws UnsupportedLocaleException |
||
| 312 | * |
||
| 313 | * @return string|false URL translated |
||
| 314 | */ |
||
| 315 | public function getURLFromRouteNameTranslated($locale, $transKeyName, $attributes = [], $forceDefaultLocation = false) |
||
| 316 | { |
||
| 317 | if (!$this->checkLocaleInSupportedLocales($locale)) { |
||
| 318 | throw new UnsupportedLocaleException('Locale \''.$locale.'\' is not in the list of supported locales.'); |
||
| 319 | } |
||
| 320 | |||
| 321 | if (!is_string($locale)) { |
||
| 322 | $locale = $this->getDefaultLocale(); |
||
| 323 | } |
||
| 324 | |||
| 325 | $route = ''; |
||
| 326 | |||
| 327 | if ($forceDefaultLocation || !($locale === $this->defaultLocale && $this->hideDefaultLocaleInURL())) { |
||
| 328 | $route = '/'.$locale; |
||
| 329 | } |
||
| 330 | if (is_string($locale) && $this->translator->has($transKeyName, $locale)) { |
||
| 331 | $translation = $this->translator->trans($transKeyName, [], $locale); |
||
| 332 | $route .= '/'.$translation; |
||
| 333 | |||
| 334 | $route = $this->substituteAttributesInRoute($attributes, $route); |
||
| 335 | } |
||
| 336 | |||
| 337 | if (empty($route)) { |
||
| 338 | // This locale does not have any key for this route name |
||
| 339 | return false; |
||
| 340 | } |
||
| 341 | |||
| 342 | return rtrim($this->createUrlFromUri($route)); |
||
| 343 | } |
||
| 344 | |||
| 345 | /** |
||
| 346 | * It returns an URL without locale (if it has it) |
||
| 347 | * Convenience function wrapping getLocalizedURL(false). |
||
| 348 | * |
||
| 349 | * @param string|false $url URL to clean, if false, current url would be taken |
||
| 350 | * |
||
| 351 | * @return string URL with no locale in path |
||
| 352 | */ |
||
| 353 | public function getNonLocalizedURL($url = null) |
||
| 357 | |||
| 358 | /** |
||
| 359 | * Returns default locale. |
||
| 360 | * |
||
| 361 | * @return string |
||
| 362 | */ |
||
| 363 | public function getDefaultLocale() |
||
| 367 | |||
| 368 | /** |
||
| 369 | * Return an array of all supported Locales. |
||
| 370 | * |
||
| 371 | * @throws SupportedLocalesNotDefined |
||
| 372 | * |
||
| 373 | * @return array |
||
| 374 | */ |
||
| 375 | public function getSupportedLocales() |
||
| 391 | |||
| 392 | /** |
||
| 393 | * Return an array of all supported Locales but in the order the user |
||
| 394 | * has specified in the config file. Useful for the language selector. |
||
| 395 | * |
||
| 396 | * @return array |
||
| 397 | */ |
||
| 398 | public function getLocalesOrder() |
||
| 412 | |||
| 413 | /** |
||
| 414 | * Returns current locale name. |
||
| 415 | * |
||
| 416 | * @return string current locale name |
||
| 417 | */ |
||
| 418 | public function getCurrentLocaleName() |
||
| 422 | |||
| 423 | /** |
||
| 424 | * Returns current locale native name. |
||
| 425 | * |
||
| 426 | * @return string current locale native name |
||
| 427 | */ |
||
| 428 | public function getCurrentLocaleNative() |
||
| 432 | |||
| 433 | /** |
||
| 434 | * Returns current locale direction. |
||
| 435 | * |
||
| 436 | * @return string current locale direction |
||
| 437 | */ |
||
| 438 | public function getCurrentLocaleDirection() |
||
| 456 | |||
| 457 | /** |
||
| 458 | * Returns current locale script. |
||
| 459 | * |
||
| 460 | * @return string current locale script |
||
| 461 | */ |
||
| 462 | public function getCurrentLocaleScript() |
||
| 466 | |||
| 467 | /** |
||
| 468 | * Returns current language's native reading. |
||
| 469 | * |
||
| 470 | * @return string current language's native reading |
||
| 471 | */ |
||
| 472 | public function getCurrentLocaleNativeReading() |
||
| 476 | |||
| 477 | /** |
||
| 478 | * Returns current language. |
||
| 479 | * |
||
| 480 | * @return string current language |
||
| 481 | */ |
||
| 482 | public function getCurrentLocale() |
||
| 497 | |||
| 498 | /** |
||
| 499 | * Returns current regional. |
||
| 500 | * |
||
| 501 | * @return string current regional |
||
| 502 | */ |
||
| 503 | public function getCurrentLocaleRegional() |
||
| 513 | |||
| 514 | /** |
||
| 515 | * Returns supported languages language key. |
||
| 516 | * |
||
| 517 | * @return array keys of supported languages |
||
| 518 | */ |
||
| 519 | public function getSupportedLanguagesKeys() |
||
| 523 | |||
| 524 | /** |
||
| 525 | * Check if Locale exists on the supported locales array. |
||
| 526 | * |
||
| 527 | * @param string|bool $locale string|bool Locale to be checked |
||
| 528 | * |
||
| 529 | * @throws SupportedLocalesNotDefined |
||
| 530 | * |
||
| 531 | * @return bool is the locale supported? |
||
| 532 | */ |
||
| 533 | public function checkLocaleInSupportedLocales($locale) |
||
| 542 | |||
| 543 | /** |
||
| 544 | * Change route attributes for the ones in the $attributes array. |
||
| 545 | * |
||
| 546 | * @param $attributes array Array of attributes |
||
| 547 | * @param string $route string route to substitute |
||
| 548 | * |
||
| 549 | * @return string route with attributes changed |
||
| 550 | */ |
||
| 551 | protected function substituteAttributesInRoute($attributes, $route) |
||
| 563 | |||
| 564 | /** |
||
| 565 | * Returns translated routes. |
||
| 566 | * |
||
| 567 | * @return array translated routes |
||
| 568 | */ |
||
| 569 | protected function getTranslatedRoutes() |
||
| 573 | |||
| 574 | /** |
||
| 575 | * Set current route name. |
||
| 576 | * |
||
| 577 | * @param string $routeName current route name |
||
| 578 | */ |
||
| 579 | public function setRouteName($routeName) |
||
| 583 | |||
| 584 | /** |
||
| 585 | * Translate routes and save them to the translated routes array (used in the localize route filter). |
||
| 586 | * |
||
| 587 | * @param string $routeName Key of the translated string |
||
| 588 | * |
||
| 589 | * @return string Translated string |
||
| 590 | */ |
||
| 591 | public function transRoute($routeName) |
||
| 599 | |||
| 600 | /** |
||
| 601 | * Returns the translation key for a given path. |
||
| 602 | * |
||
| 603 | * @param string $path Path to get the key translated |
||
| 604 | * |
||
| 605 | * @return string|false Key for translation, false if not exist |
||
| 606 | */ |
||
| 607 | public function getRouteNameFromAPath($path) |
||
| 626 | |||
| 627 | /** |
||
| 628 | * Returns the translated route for the path and the url given. |
||
| 629 | * |
||
| 630 | * @param string $path Path to check if it is a translated route |
||
| 631 | * @param string $url_locale Language to check if the path exists |
||
| 632 | * |
||
| 633 | * @return string|false Key for translation, false if not exist |
||
| 634 | */ |
||
| 635 | protected function findTranslatedRouteByPath($path, $url_locale) |
||
| 646 | |||
| 647 | /** |
||
| 648 | * Returns the translated route for an url and the attributes given and a locale. |
||
| 649 | * |
||
| 650 | * |
||
| 651 | * @param string|false|null $url Url to check if it is a translated route |
||
| 652 | * @param array $attributes Attributes to check if the url exists in the translated routes array |
||
| 653 | * @param string $locale Language to check if the url exists |
||
| 654 | * |
||
| 655 | * @throws SupportedLocalesNotDefined |
||
| 656 | * @throws UnsupportedLocaleException |
||
| 657 | * |
||
| 658 | * @return string|false Key for translation, false if not exist |
||
| 659 | */ |
||
| 660 | protected function findTranslatedRouteByUrl($url, $attributes, $locale) |
||
| 677 | |||
| 678 | /** |
||
| 679 | * Returns true if the string given is a valid url. |
||
| 680 | * |
||
| 681 | * @param string $url String to check if it is a valid url |
||
| 682 | * |
||
| 683 | * @return bool Is the string given a valid url? |
||
| 684 | */ |
||
| 685 | protected function checkUrl($url) |
||
| 689 | |||
| 690 | /** |
||
| 691 | * Returns the config repository for this instance. |
||
| 692 | * |
||
| 693 | * @return Repository Configuration repository |
||
| 694 | */ |
||
| 695 | public function getConfigRepository() |
||
| 699 | |||
| 700 | /** |
||
| 701 | * Returns the translation key for a given path. |
||
| 702 | * |
||
| 703 | * @return bool Returns value of useAcceptLanguageHeader in config. |
||
| 704 | */ |
||
| 705 | protected function useAcceptLanguageHeader() |
||
| 709 | |||
| 710 | /** |
||
| 711 | * Returns the translation key for a given path. |
||
| 712 | * |
||
| 713 | * @return bool Returns value of hideDefaultLocaleInURL in config. |
||
| 714 | */ |
||
| 715 | public function hideDefaultLocaleInURL() |
||
| 719 | |||
| 720 | /** |
||
| 721 | * Create an url from the uri. |
||
| 722 | * |
||
| 723 | * @param string $uri Uri |
||
| 724 | * |
||
| 725 | * @return string Url for the given uri |
||
| 726 | */ |
||
| 727 | public function createUrlFromUri($uri) |
||
| 737 | |||
| 738 | /** |
||
| 739 | * Sets the base url for the site. |
||
| 740 | * |
||
| 741 | * @param string $url Base url for the site |
||
| 742 | */ |
||
| 743 | public function setBaseUrl($url) |
||
| 751 | |||
| 752 | /** |
||
| 753 | * Extract attributes for current url. |
||
| 754 | * |
||
| 755 | * @param bool|false|null|string $url to extract attributes, if not present, the system will look for attributes in the current call |
||
| 756 | * @param string $locale |
||
| 757 | * |
||
| 758 | * @return array Array with attributes |
||
| 759 | */ |
||
| 760 | protected function extractAttributes($url = false, $locale = '') |
||
| 846 | |||
| 847 | /** |
||
| 848 | * Build URL using array data from parse_url. |
||
| 849 | * |
||
| 850 | * @param array|false $parsed_url Array of data from parse_url function |
||
| 851 | * |
||
| 852 | * @return string Returns URL as string. |
||
| 853 | */ |
||
| 854 | protected function unparseUrl($parsed_url) |
||
| 879 | |||
| 880 | /** |
||
| 881 | * Normalize attributes gotten from request parameters. |
||
| 882 | * |
||
| 883 | * @param array $attributes The attributes |
||
| 884 | * @return array The normalized attributes |
||
| 885 | */ |
||
| 886 | protected function normalizeAttributes($attributes) |
||
| 894 | } |
||
| 895 |
Loading history...
This check looks at variables that have been passed in as parameters and are passed out again to other methods.
If the outgoing method call has stricter type requirements than the method itself, an issue is raised.
An additional type check may prevent trouble.