[8.x] Add a string helper to swap multiple keywords in a string. (#40831)

* Add a string helper to swap multiple keywords in a string.

* styleci fixes.

* styleci fixes.

* Update Str.php

* add to stringable

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

Author: amitmerchant1990

src/Illuminate/Support/Str.php

@@ -908,6 +908,18 @@ public static function substrReplace($string, $replace, $offset = 0, $length = n
         return substr_replace($string, $replace, $offset, $length);
     }
 
+    /**
+     * Swap multiple keywords in a string with other keywords.
+     *
+     * @param  array  $map
+     * @param  string  $subject
+     * @return string
+     */
+    public static function swap(array $map, $subject)
+    {
+        return str_replace(array_keys($map), array_values($map), $subject);
+    }
+
     /**
      * Make a string's first character uppercase.
      *

src/Illuminate/Support/Stringable.php

@@ -726,13 +726,24 @@ public function substrCount($needle, $offset = null, $length = null)
      * @param  string|array  $replace
      * @param  array|int  $offset
      * @param  array|int|null  $length
-     * @return string|array
+     * @return static
      */
     public function substrReplace($replace, $offset = 0, $length = null)
     {
         return new static(Str::substrReplace($this->value, $replace, $offset, $length));
     }
 
+    /**
+     * Swap multiple keywords in a string with other keywords.
+     *
+     * @param  array  $map
+     * @return static
+     */
+    public function swap(array $map)
+    {
+        return new static(str_replace(array_keys($map), array_values($map), $this->value));
+    }
+
     /**
      * Trim the string of the given characters.
      *

tests/Support/SupportStrTest.php

@@ -623,6 +623,24 @@ public function testPadRight()
         $this->assertSame('Alien     ', Str::padRight('Alien', 10));
     }
 
+    public function testSwapKeywords(): void
+    {
+        $this->assertSame(
+            'PHP 8 is fantastic',
+            Str::swap([
+                'PHP' => 'PHP 8',
+                'awesome' => 'fantastic',
+            ], 'PHP is awesome')
+        );
+
+        $this->assertSame(
+            'foo bar baz',
+            Str::swap([
+                'ⓐⓑ' => 'baz',
+            ], 'foo bar ⓐⓑ')
+        );
+    }
+
     public function testWordCount()
     {
         $this->assertEquals(2, Str::wordCount('Hello, world!'));

tests/Support/SupportStringableTest.php

@@ -795,6 +795,14 @@ public function testSubstr()
         $this->assertSame('', (string) $this->stringable('Б')->substr(2));
     }
 
+    public function testSwap()
+    {
+        $this->assertSame('PHP 8 is fantastic', (string) $this->stringable('PHP is awesome')->swap([
+            'PHP' => 'PHP 8',
+            'awesome' => 'fantastic',
+        ]));
+    }
+
     public function testSubstrCount()
     {
         $this->assertSame(3, $this->stringable('laravelPHPFramework')->substrCount('a'));