From 2256340f468601a95a63fc1c1b61e3762e9b97e1 Mon Sep 17 00:00:00 2001
From: Tim MacDonald <hello@timacdonald.me>
Date: Wed, 3 Jul 2024 04:04:37 +1000
Subject: [PATCH] [11.x] Document Str::chop* methods (#9726)

* Document Str::chop* methods

* formatting

---------

Co-authored-by: Taylor Otwell <taylor@laravel.com>
---
 strings.md | 80 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 80 insertions(+)

diff --git a/strings.md b/strings.md
index 43551e42bb8..ff3566a28ce 100644
--- a/strings.md
+++ b/strings.md
@@ -43,6 +43,8 @@ Laravel includes a variety of functions for manipulating string values. Many of
 [Str::betweenFirst](#method-str-between-first)
 [Str::camel](#method-camel-case)
 [Str::charAt](#method-char-at)
+[Str::chopStart](#method-str-chop-start)
+[Str::chopEnd](#method-str-chop-end)
 [Str::contains](#method-str-contains)
 [Str::containsAll](#method-str-contains-all)
 [Str::endsWith](#method-ends-with)
@@ -134,6 +136,8 @@ Laravel includes a variety of functions for manipulating string values. Many of
 [camel](#method-fluent-str-camel)
 [charAt](#method-fluent-str-char-at)
 [classBasename](#method-fluent-str-class-basename)
+[chopStart](#method-fluent-str-chop-start)
+[chopEnd](#method-fluent-str-chop-end)
 [contains](#method-fluent-str-contains)
 [containsAll](#method-fluent-str-contains-all)
 [dirname](#method-fluent-str-dirname)
@@ -377,6 +381,44 @@ The `Str::charAt` method returns the character at the specified index. If the in
 
     // 's'
 
+<a name="method-str-chop-start"></a>
+#### `Str::chopStart()` {.collection-method}
+
+The `Str::chopStart` method removes the first occurrence of the given value only if the value appears at the start of the string:
+
+    use Illuminate\Support\Str;
+
+    $url = Str::chopStart('https://laravel.com', 'https://');
+
+    // 'laravel.com'
+
+You may also pass an array as the second argument. If the string starts with any of the values in the array then that value will be removed from string:
+
+    use Illuminate\Support\Str;
+
+    $url = Str::chopStart('http://laravel.com', ['https://', 'http://']);
+
+    // 'laravel.com'
+
+<a name="method-str-chop-end"></a>
+#### `Str::chopEnd()` {.collection-method}
+
+The `Str::chopEnd` method removes the last occurrence of the given value only if the value appears at the end of the string:
+
+    use Illuminate\Support\Str;
+
+    $url = Str::chopEnd('app/Models/Photograph.php', '.php');
+
+    // 'app/Models/Photograph'
+
+You may also pass an array as the second argument. If the string ends with any of the values in the array then that value will be removed from string:
+
+    use Illuminate\Support\Str;
+
+    $url = Str::chopEnd('laravel.com/index.php', ['/index.html', '/index.php']);
+
+    // 'laravel.com'
+
 <a name="method-str-contains"></a>
 #### `Str::contains()` {.collection-method}
 
@@ -1587,6 +1629,44 @@ The `classBasename` method returns the class name of the given class with the cl
 
     // 'Baz'
 
+<a name="method-fluent-str-chop-start"></a>
+#### `chopStart` {.collection-method}
+
+The `chopStart` method removes the first occurrence of the given value only if the value appears at the start of the string:
+
+    use Illuminate\Support\Str;
+
+    $url = Str::of('https://laravel.com')->chopStart('https://');
+
+    // 'laravel.com'
+
+You may also pass an array. If the string starts with any of the values in the array then that value will be removed from string:
+
+    use Illuminate\Support\Str;
+
+    $url = Str::of('http://laravel.com')->chopStart(['https://', 'http://']);
+
+    // 'laravel.com'
+
+<a name="method-fluent-str-chop-end"></a>
+#### `chopEnd` {.collection-method}
+
+The `chopEnd` method removes the last occurrence of the given value only if the value appears at the end of the string:
+
+    use Illuminate\Support\Str;
+
+    $url = Str::of('https://laravel.com')->chopEnd('https://');
+
+    // 'laravel.com'
+
+You may also pass an array. If the string ends with any of the values in the array then that value will be removed from string:
+
+    use Illuminate\Support\Str;
+
+    $url = Str::of('http://laravel.com')->chopEnd(['https://', 'http://']);
+
+    // 'laravel.com'
+
 <a name="method-fluent-str-contains"></a>
 #### `contains` {.collection-method}