New: Uri pathSegments() helper method (#55250)

* Added `pathSegments` helper function on the `Uri` class

* Added doc block

* pint

* Refactored to return the segments as a collection instead of just an array

* add more tests

* dont use helper

---------

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

Author: chester-sykes

src/Illuminate/Support/Uri.php

@@ -152,6 +152,18 @@ public function path(): ?string
         return $path === '' ? '/' : $path;
     }
 
+    /**
+     * Get the URI's path segments.
+     *
+     * Empty or missing paths are returned as an empty collection.
+     */
+    public function pathSegments(): Collection
+    {
+        $path = $this->path();
+
+        return $path === '/' ? new Collection : new Collection(explode('/', $path));
+    }
+
     /**
      * Get the URI's query string.
      */

tests/Support/SupportUriTest.php

@@ -196,4 +196,28 @@ public function test_with_query_prevents_empty_query_string()
         $this->assertEquals('https://laravel.com', (string) $uri);
         $this->assertEquals('https://laravel.com', (string) $uri->withQuery([]));
     }
+
+    public function test_path_segments()
+    {
+        $uri = Uri::of('https://laravel.com');
+
+        $this->assertEquals([], $uri->pathSegments()->toArray());
+
+        $uri = Uri::of('https://laravel.com/one/two/three');
+
+        $this->assertEquals(['one', 'two', 'three'], $uri->pathSegments()->toArray());
+        $this->assertEquals('one', $uri->pathSegments()->first());
+
+        $uri = Uri::of('https://laravel.com/one/two/three?foo=bar');
+
+        $this->assertEquals(3, $uri->pathSegments()->count());
+
+        $uri = Uri::of('https://laravel.com/one/two/three/?foo=bar');
+
+        $this->assertEquals(3, $uri->pathSegments()->count());
+
+        $uri = Uri::of('https://laravel.com/one/two/three/#foo=bar');
+
+        $this->assertEquals(3, $uri->pathSegments()->count());
+    }
 }