[8.x] Add Transliterate shortcut to the Str helper (#40681)

* Add Transliterate shortcut to the Str helper

* Remove whitespace

* Fix variable typo

* formatting

Co-authored-by: Liam Hackett <[email protected]>
Co-authored-by: Taylor Otwell <[email protected]>

Author: 3 people

src/Illuminate/Support/Str.php

@@ -99,6 +99,19 @@ public static function ascii($value, $language = 'en')
         return ASCII::to_ascii((string) $value, $language);
     }
 
+    /**
+     * Transliterate a string to its closest ASCII representation.
+     *
+     * @param  string  $string
+     * @param  string|null  $unknown
+     * @param  bool|null  $strict
+     * @return string
+     */
+    public static function transliterate($string, $unknown = '?', $strict = false)
+    {
+        return ASCII::to_transliterate($string, $unknown, $strict);
+    }
+
     /**
      * Get the portion of a string before the first occurrence of a given value.
      *

tests/Support/SupportStrTest.php

@@ -672,6 +672,42 @@ public function testRepeat()
         $this->assertSame('aaaaa', Str::repeat('a', 5));
         $this->assertSame('', Str::repeat('', 5));
     }
+
+    /**
+     * @dataProvider specialCharacterProvider
+     */
+    public function testTransliterate(string $value, string $expected): void
+    {
+        $this->assertSame($expected, Str::transliterate($value));
+    }
+
+    public function specialCharacterProvider(): array
+    {
+        return [
+            ['ⓐⓑⓒⓓⓔⓕⓖⓗⓘⓙⓚⓛⓜⓝⓞⓟⓠⓡⓢⓣⓤⓥⓦⓧⓨⓩ', 'abcdefghijklmnopqrstuvwxyz'],
+            ['⓪①②③④⑤⑥⑦⑧⑨⑩⑪⑫⑬⑭⑮⑯⑰⑱⑲⑳', '01234567891011121314151617181920'],
+            ['⓵⓶⓷⓸⓹⓺⓻⓼⓽⓾', '12345678910'],
+            ['⓿⓫⓬⓭⓮⓯⓰⓱⓲⓳⓴', '011121314151617181920'],
+            ['ⓣⓔⓢⓣ@ⓛⓐⓡⓐⓥⓔⓛ.ⓒⓞⓜ', '[email protected]'],
+            ['🎂', '?'],
+            ['abcdefghijklmnopqrstuvwxyz', 'abcdefghijklmnopqrstuvwxyz'],
+            ['0123456789', '0123456789'],
+        ];
+    }
+
+    public function testTransliterateOverrideUnknown(): void
+    {
+        $this->assertSame('HHH', Str::transliterate('🎂🚧🏆', 'H'));
+        $this->assertSame('Hello', Str::transliterate('🎂', 'Hello'));
+    }
+
+    /**
+     * @dataProvider specialCharacterProvider
+     */
+    public function testTransliterateStrict(string $value, string $expected): void
+    {
+        $this->assertSame($expected, Str::transliterate($value, '?', true));
+    }
 }
 
 class StringableObjectStub