[String] Add support for emoji in AsciiSlugger

lyrixx · lyrixx · commit f78a0a4f2067 · 2022-08-13T10:40:31.000+02:00
diff --git a/src/Symfony/Component/String/CHANGELOG.md b/src/Symfony/Component/String/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+6.2
+---
+
+  * Add support for emoji in `AsciiSlugger`
+
 5.4
 ---
 
diff --git a/src/Symfony/Component/String/Slugger/AsciiSlugger.php b/src/Symfony/Component/String/Slugger/AsciiSlugger.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Component\String\Slugger;
 
+use Symfony\Component\Intl\Transliterator\EmojiTransliterator;
 use Symfony\Component\String\AbstractUnicodeString;
 use Symfony\Component\String\UnicodeString;
 use Symfony\Contracts\Translation\LocaleAwareInterface;
@@ -58,6 +59,7 @@ class AsciiSlugger implements SluggerInterface, LocaleAwareInterface
     private \Closure|array $symbolsMap = [
         'en' => ['@' => 'at', '&' => 'and'],
     ];
+    private bool $enableEmoji = false;
 
     /**
      * Cache of transliterators per locale.
@@ -88,6 +90,14 @@ public function getLocale(): string
         return $this->defaultLocale;
     }
 
+    public function enableEmoji(bool $enableEmoji = true): void
+    {
+        if (!class_exists(EmojiTransliterator::class)) {
+            throw new \LogicException(sprintf('You cannot use the "%s()" as the "symfony/intl" package is not installed. Try running "composer require symfony/intl".', __METHOD__));
+        }
+        $this->enableEmoji = $enableEmoji;
+    }
+
     /**
      * {@inheritdoc}
      */
@@ -103,6 +113,10 @@ public function slug(string $string, string $separator = '-', string $locale = n
             $transliterator = (array) $this->createTransliterator($locale);
         }
 
+        if ($this->enableEmoji) {
+            $transliterator[] = EmojiTransliterator::create($locale);
+        }
+
         if ($this->symbolsMap instanceof \Closure) {
             // If the symbols map is passed as a closure, there is no need to fallback to the parent locale
             // as the closure can just provide substitutions for all locales of interest.
diff --git a/src/Symfony/Component/String/Tests/Slugger/AsciiSluggerTest.php b/src/Symfony/Component/String/Tests/Slugger/AsciiSluggerTest.php
@@ -44,4 +44,27 @@ public function testSlug(string $expected, string $string, string $separator = '
 
         $this->assertSame($expected, (string) $slugger->slug($string, $separator, $locale));
     }
+
+    public function provideSlugEmojiTests(): iterable
+    {
+        yield [
+            'un-chat-qui-sourit-chat-noir-et-un-tete-de-lion-vont-au-parc-national',
+            'un 😺, 🐈‍⬛, et un 🦁 vont au 🏞️',
+            'fr',
+        ];
+        yield [
+            'a-grinning-cat-black-cat-and-a-lion-go-to-national-park-smiling-face-with-heart-eyes-party-popper-yellow-heart',
+            'a 😺, 🐈‍⬛, and a 🦁 go to 🏞️... 😍 🎉 💛',
+            'en',
+        ];
+    }
+
+    /** @dataProvider provideSlugEmojiTests */
+    public function testSlugEmoji(string $expected, string $string, string $locale)
+    {
+        $slugger = new AsciiSlugger();
+        $slugger->enableEmoji();
+
+        $this->assertSame($expected, (string) $slugger->slug($string, '-', $locale));
+    }
 }
