feature #60188 [JsonPath] Add two utils methods to JsonPath builder (alexandre-daubois)

GromNaN · GromNaN · commit c16162fec1b3 · 2025-04-10T15:56:29.000+02:00
This PR was merged into the 7.3 branch. Discussion ---------- [JsonPath] Add two utils methods to `JsonPath` builder | Q | A | ------------- | --- | Branch? | 7.3 | Bug fix? | no | New feature? | yes | Deprecations? | no | Issues | - | License | MIT Small DX improvements that goes with #60105 and #60083. This PR adds two new methods, `first()` and `last()`, added to JsonPath builder. This voluntary reminds methods from the DomCrawler component. The goal is not to add every possible method, but I think `first()` and `last()` are common enough to be added. I also propose to rename `anyIndex()` to `all()`. ```php $path = new JsonPath(); // Get the first user of the collection $path = $path->key('users')->first(); ``` ```php $path = new JsonPath(); // Get the last user of the collection $path = $path->key('users')->last(); ``` ```php $path = new JsonPath(); // Get all users of the collection $path = $path->key('users')->all(); ``` Commits ------- 3bc3559 [JsonPath][DX] Add utils methods to `JsonPath` builder
diff --git a/src/Symfony/Component/JsonPath/JsonPath.php b/src/Symfony/Component/JsonPath/JsonPath.php
@@ -43,11 +43,21 @@ public function deepScan(): static
         return new self($this->path.'..');
     }
 
-    public function anyIndex(): static
+    public function all(): static
     {
         return new self($this->path.'[*]');
     }
 
+    public function first(): static
+    {
+        return new self($this->path.'[0]');
+    }
+
+    public function last(): static
+    {
+        return new self($this->path.'[-1]');
+    }
+
     public function slice(int $start, ?int $end = null, ?int $step = null): static
     {
         $slice = $start;
diff --git a/src/Symfony/Component/JsonPath/Tests/JsonPathTest.php b/src/Symfony/Component/JsonPath/Tests/JsonPathTest.php
@@ -35,4 +35,31 @@ public function testBuildWithFilter()
 
         $this->assertSame('$.users[?(@.age > 18)]', (string) $path);
     }
+
+    public function testAll()
+    {
+        $path = new JsonPath();
+        $path = $path->key('users')
+            ->all();
+
+        $this->assertSame('$.users[*]', (string) $path);
+    }
+
+    public function testFirst()
+    {
+        $path = new JsonPath();
+        $path = $path->key('users')
+            ->first();
+
+        $this->assertSame('$.users[0]', (string) $path);
+    }
+
+    public function testLast()
+    {
+        $path = new JsonPath();
+        $path = $path->key('users')
+            ->last();
+
+        $this->assertSame('$.users[-1]', (string) $path);
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -43,11 +43,21 @@ public function deepScan(): static`
`43`	`43`	`return new self($this->path.'..');`
`44`	`44`	`}`
`45`	`45`
`46`		`- public function anyIndex(): static`
	`46`	`+ public function all(): static`
`47`	`47`	`{`
`48`	`48`	`return new self($this->path.'[*]');`
`49`	`49`	`}`
`50`	`50`
	`51`	`+ public function first(): static`
	`52`	`+ {`
	`53`	`+ return new self($this->path.'[0]');`
	`54`	`+ }`
	`55`	`+`
	`56`	`+ public function last(): static`
	`57`	`+ {`
	`58`	`+ return new self($this->path.'[-1]');`
	`59`	`+ }`
	`60`	`+`
`51`	`61`	`public function slice(int $start, ?int $end = null, ?int $step = null): static`
`52`	`62`	`{`
`53`	`63`	`$slice = $start;`