* Added table of contents

* Renamed deleteValues() to deletePaths()

Author: ro-pi

README.md

@@ -11,6 +11,15 @@ This implementation passes all compliance tests of [JSONPath Compliance Test Sui
 * ext-intl
 * ext-mbstring
 
+## Table of contents
+* [Installation](#installation)
+* [Get values](#get-values)
+* [Get paths](#get-paths)
+* [Set values](#set-values)
+* [Set values and create non-existent paths](#set-values-and-create-non-existent-paths)
+* [Delete paths](#delete-paths)
+* [Custom function extensions](#custom-function-extensions)
+
 ## Installation
 The library can be installed from a command line interface by using [composer](https://getcomposer.org/).
 
@@ -493,8 +502,9 @@ array(1) {
 }
 
 ```
-## Delete values
-The following example shows how to delete/remove/unset values.
+## Delete paths
+The following example shows how to delete/remove/unset paths that match a JSONPath.
+
 ```php
 <?php
 $data = json_decode('{ "store": {
@@ -535,7 +545,7 @@ $evaluator = new \Ropi\JsonPathEvaluator\JsonPathEvaluator();
 
 echo "Delete all books that are more expensive than 9 euros:\n";
 
-$evaluator->deleteValues($data, '$.store.book[@.price > 9]');
+$evaluator->deletePaths($data, '$.store.book[@.price > 9]');
 
 echo json_encode($data, JSON_PRETTY_PRINT) . "\n";
 ```

src/JsonPathEvaluator.php

@@ -145,7 +145,7 @@ public function setValues(
      * @throws JsonPathEvaluatorException
      * @throws \ReflectionException
      */
-    public function deleteValues(array|\stdClass &$data, string $path): void
+    public function deletePaths(array|\stdClass &$data, string $path): void
     {
         $nodeList = $this->evaluate($data, $path, NonExistentPathBehavior::Skip);
 

src/JsonPathEvaluatorInterface.php

@@ -37,5 +37,5 @@ function setValues(
      * @param \stdClass|array<scalar, mixed> $data
      * @throws JsonPathEvaluatorException
      */
-    function deleteValues(array|\stdClass &$data, string $path): void;
+    function deletePaths(array|\stdClass &$data, string $path): void;
 }

tests/Functional/JsonPath/JsonPathEvaluatorTest.php

@@ -788,7 +788,7 @@ public function testSetValuesCreateNonExistent(): void
      * @throws JsonPathEvaluatorException
      * @throws \ReflectionException
      */
-    public function testDeleteValues(): void
+    public function testDeletePaths(): void
     {
         $evaluator = new \Ropi\JsonPathEvaluator\JsonPathEvaluator();
 
@@ -813,7 +813,7 @@ public function testDeleteValues(): void
              }
            }');
 
-        $evaluator->deleteValues($data, '$..price');
+        $evaluator->deletePaths($data, '$..price');
 
         $this->assertJsonStringEqualsJsonString(
             (string)json_encode($data),
@@ -837,7 +837,7 @@ public function testDeleteValues(): void
             'Delete all prices'
         );
 
-        $evaluator->deleteValues($data, '$.store.bicycle');
+        $evaluator->deletePaths($data, '$.store.bicycle');
 
         $this->assertJsonStringEqualsJsonString(
             (string)json_encode($data),
@@ -858,7 +858,7 @@ public function testDeleteValues(): void
             'Delete bicycle'
         );
 
-        $evaluator->deleteValues($data, '$.store.book[1:]');
+        $evaluator->deletePaths($data, '$.store.book[1:]');
 
         $this->assertJsonStringEqualsJsonString(
             (string)json_encode($data),
@@ -874,7 +874,7 @@ public function testDeleteValues(): void
             'Delete array slice'
         );
 
-        $evaluator->deleteValues($data, '$.store.book[*]');
+        $evaluator->deletePaths($data, '$.store.book[*]');
 
         $this->assertJsonStringEqualsJsonString(
             (string)json_encode($data),
@@ -885,7 +885,7 @@ public function testDeleteValues(): void
             'Delete wildcard'
         );
 
-        $evaluator->deleteValues($data, '$');
+        $evaluator->deletePaths($data, '$');
 
         $this->assertNull($data, 'Delete root');
     }