Adds Str::take() and Stringable->take() (#344)

Co-authored-by: Deeka Wong <[email protected]>

output/Hyperf/Stringable/Str.php

@@ -231,6 +231,15 @@ public static function swap(array $map, $subject)
     {
     }
 
+    /**
+     * Take the first or last {$limit} characters of a string.
+     *
+     * @param string $string
+     */
+    public static function take($string, int $limit): string
+    {
+    }
+
     /**
      * Transliterate a string to its closest ASCII representation.
      *

output/Hyperf/Stringable/Stringable.php

@@ -191,6 +191,15 @@ public function swap(array $map)
     {
     }
 
+    /**
+     * Take the first or last {$limit} characters.
+     *
+     * @return static
+     */
+    public function take(int $limit)
+    {
+    }
+
     /**
      * Determine if the string matches the given pattern.
      *

src/StrMixin.php

@@ -264,6 +264,17 @@ public function swap()
         return fn (array $map, $subject) => str_replace(array_keys($map), array_values($map), $subject);
     }
 
+    public static function take()
+    {
+        return function ($string, int $limit) {
+            if ($limit < 0) {
+                return static::substr($string, $limit);
+            }
+
+            return static::substr($string, 0, $limit);
+        };
+    }
+
     public function transliterate()
     {
         return fn ($string, $unknown = '?', $strict = false) => ASCII::to_transliterate($string, $unknown, $strict);

src/StringableMixin.php

@@ -136,6 +136,17 @@ public function swap()
         return fn (array $map) => new static(strtr($this->value, $map));
     }
 
+    /**
+     * Take the first or last {$limit} characters.
+     *
+     * @return static
+     */
+    public function take()
+    {
+        /* @phpstan-ignore-next-line */
+        return fn (int $limit) => new static(Str::take($this->value, $limit));
+    }
+
     public function test()
     {
         return fn ($pattern) => $this->match($pattern)->isNotEmpty();