vendor/symfony/string/Slugger/AsciiSlugger.php line 94

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\String\Slugger;
  14. use Symfony\Component\String\AbstractUnicodeString;
  15. use Symfony\Component\String\UnicodeString;
  16. use Symfony\Contracts\Translation\LocaleAwareInterface;
  18. if (!interface_exists(LocaleAwareInterface::class)) {
  19.     throw new \LogicException('You cannot use the "Symfony\Component\String\Slugger\AsciiSlugger" as the "symfony/translation-contracts" package is not installed. Try running "composer require symfony/translation-contracts".');
  20. }
  22. /**
  23.  * @author Titouan Galopin <galopintitouan@gmail.com>
  24.  */
  25. class AsciiSlugger implements SluggerInterface, LocaleAwareInterface
  26. {
  27.     private const LOCALE_TO_TRANSLITERATOR_ID = [
  28.         'am' => 'Amharic-Latin',
  29.         'ar' => 'Arabic-Latin',
  30.         'az' => 'Azerbaijani-Latin',
  31.         'be' => 'Belarusian-Latin',
  32.         'bg' => 'Bulgarian-Latin',
  33.         'bn' => 'Bengali-Latin',
  34.         'de' => 'de-ASCII',
  35.         'el' => 'Greek-Latin',
  36.         'fa' => 'Persian-Latin',
  37.         'he' => 'Hebrew-Latin',
  38.         'hy' => 'Armenian-Latin',
  39.         'ka' => 'Georgian-Latin',
  40.         'kk' => 'Kazakh-Latin',
  41.         'ky' => 'Kirghiz-Latin',
  42.         'ko' => 'Korean-Latin',
  43.         'mk' => 'Macedonian-Latin',
  44.         'mn' => 'Mongolian-Latin',
  45.         'or' => 'Oriya-Latin',
  46.         'ps' => 'Pashto-Latin',
  47.         'ru' => 'Russian-Latin',
  48.         'sr' => 'Serbian-Latin',
  49.         'sr_Cyrl' => 'Serbian-Latin',
  50.         'th' => 'Thai-Latin',
  51.         'tk' => 'Turkmen-Latin',
  52.         'uk' => 'Ukrainian-Latin',
  53.         'uz' => 'Uzbek-Latin',
  54.         'zh' => 'Han-Latin',
  55.     ];
  57.     private ?string $defaultLocale;
  58.     private \Closure|array $symbolsMap = [
  59.         'en' => ['@' => 'at', '&' => 'and'],
  60.     ];
  62.     /**
  63.      * Cache of transliterators per locale.
  64.      *
  65.      * @var \Transliterator[]
  66.      */
  67.     private array $transliterators = [];
  69.     public function __construct(string $defaultLocale = null, array|\Closure $symbolsMap = null)
  70.     {
  71.         $this->defaultLocale = $defaultLocale;
  72.         $this->symbolsMap = $symbolsMap ?? $this->symbolsMap;
  73.     }
  75.     /**
  76.      * {@inheritdoc}
  77.      */
  78.     public function setLocale(string $locale)
  79.     {
  80.         $this->defaultLocale = $locale;
  81.     }
  83.     /**
  84.      * {@inheritdoc}
  85.      */
  86.     public function getLocale(): string
  87.     {
  88.         return $this->defaultLocale;
  89.     }
  91.     /**
  92.      * {@inheritdoc}
  93.      */
  94.     public function slug(string $string, string $separator = '-', string $locale = null): AbstractUnicodeString
  95.     {
  96.         $locale ??= $this->defaultLocale;
  98.         $transliterator = [];
  99.         if ($locale && ('de' === $locale || str_starts_with($locale, 'de_'))) {
  100.             // Use the shortcut for German in UnicodeString::ascii() if possible (faster and no requirement on intl)
  101.             $transliterator = ['de-ASCII'];
  102.         } elseif (\function_exists('transliterator_transliterate') && $locale) {
  103.             $transliterator = (array) $this->createTransliterator($locale);
  104.         }
  106.         if ($this->symbolsMap instanceof \Closure) {
  107.             // If the symbols map is passed as a closure, there is no need to fallback to the parent locale
  108.             // as the closure can just provide substitutions for all locales of interest.
  109.             $symbolsMap = $this->symbolsMap;
  110.             array_unshift($transliterator, static function ($s) use ($symbolsMap, $locale) {
  111.                 return $symbolsMap($s, $locale);
  112.             });
  113.         }
  115.         $unicodeString = (new UnicodeString($string))->ascii($transliterator);
  117.         if (\is_array($this->symbolsMap)) {
  118.             $map = null;
  119.             if (isset($this->symbolsMap[$locale])) {
  120.                 $map = $this->symbolsMap[$locale];
  121.             } else {
  122.                 $parent = self::getParentLocale($locale);
  123.                 if ($parent && isset($this->symbolsMap[$parent])) {
  124.                     $map = $this->symbolsMap[$parent];
  125.                 }
  126.             }
  127.             if ($map) {
  128.                 foreach ($map as $char => $replace) {
  129.                     $unicodeString = $unicodeString->replace($char, ' '.$replace.' ');
  130.                 }
  131.             }
  132.         }
  134.         return $unicodeString
  135.             ->replaceMatches('/[^A-Za-z0-9]++/', $separator)
  136.             ->trim($separator)
  137.         ;
  138.     }
  140.     private function createTransliterator(string $locale): ?\Transliterator
  141.     {
  142.         if (\array_key_exists($locale, $this->transliterators)) {
  143.             return $this->transliterators[$locale];
  144.         }
  146.         // Exact locale supported, cache and return
  147.         if ($id = self::LOCALE_TO_TRANSLITERATOR_ID[$locale] ?? null) {
  148.             return $this->transliterators[$locale] = \Transliterator::create($id.'/BGN') ?? \Transliterator::create($id);
  149.         }
  151.         // Locale not supported and no parent, fallback to any-latin
  152.         if (!$parent = self::getParentLocale($locale)) {
  153.             return $this->transliterators[$locale] = null;
  154.         }
  156.         // Try to use the parent locale (ie. try "de" for "de_AT") and cache both locales
  157.         if ($id = self::LOCALE_TO_TRANSLITERATOR_ID[$parent] ?? null) {
  158.             $transliterator = \Transliterator::create($id.'/BGN') ?? \Transliterator::create($id);
  159.         }
  161.         return $this->transliterators[$locale] = $this->transliterators[$parent] = $transliterator ?? null;
  162.     }
  164.     private static function getParentLocale(?string $locale): ?string
  165.     {
  166.         if (!$locale) {
  167.             return null;
  168.         }
  169.         if (false === $str = strrchr($locale, '_')) {
  170.             // no parent locale
  171.             return null;
  172.         }
  174.         return substr($locale, 0, -\strlen($str));
  175.     }
  176. }