[10.x] Add wordWrap to Str (#48012)

* add wordWrap method

* use "\n" instead of EOL constant

* formatting

* styleci

* add tests

* Update Str.php

* Update Stringable.php

---------

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

Author: joshbonnick

src/Illuminate/Support/Str.php

@@ -1345,6 +1345,20 @@ public static function wordCount($string, $characters = null)
         return str_word_count($string, 0, $characters);
     }
 
+    /**
+     * Wrap a string to a given number of characters.
+     *
+     * @param  string  $string
+     * @param  int  $characters
+     * @param  string  $break
+     * @param  bool  $cutLongWords
+     * @return string
+     */
+    public static function wordWrap($string, $characters = 75, $break = "\n", $cutLongWords = false)
+    {
+        return wordwrap($string, $characters, $break, $cutLongWords);
+    }
+
     /**
      * Generate a UUID (version 4).
      *

src/Illuminate/Support/Stringable.php

@@ -1113,6 +1113,19 @@ public function wordCount($characters = null)
         return Str::wordCount($this->value, $characters);
     }
 
+    /**
+     * Wrap a string to a given number of characters.
+     *
+     * @param  int  $characters
+     * @param  string  $break
+     * @param  bool  $cutLongWords
+     * @return static
+     */
+    public function wordWrap($characters = 75, $break = "\n", $cutLongWords = false)
+    {
+        return new static(Str::wordWrap($this->value, $characters, $break, $cutLongWords));
+    }
+
     /**
      * Wrap the string with the given strings.
      *

tests/Support/SupportStrTest.php

@@ -901,6 +901,14 @@ public function testWordCount()
         $this->assertEquals(3, Str::wordCount('МАМА МЫЛА РАМУ', 'абвгдеёжзийклмнопрстуфхцчшщъыьэюяАБВГДЕЁЖЗИЙКЛМНОПРСТУФХЦЧШЩЪЫЬЭЮЯ'));
     }
 
+    public function testWordWrap()
+    {
+        $this->assertEquals('Hello<br />World', Str::wordWrap('Hello World', 3, '<br />'));
+        $this->assertEquals('Hel<br />lo<br />Wor<br />ld', Str::wordWrap('Hello World', 3, '<br />', true));
+
+        $this->assertEquals('❤Multi<br />Byte☆❤☆❤☆❤', Str::wordWrap('❤Multi Byte☆❤☆❤☆❤', 3, '<br />'));
+    }
+
     public static function validUuidList()
     {
         return [