Added support for wild cards to Remove.

Resolves #41
dschoenbauer · Dec 13, 2016 · 6912a49 · 6912a49
1 parent 61a606d
commit 6912a49
Show file tree

Hide file tree

Showing 2 changed files with 76 additions and 1 deletion.
diff --git a/src/DotNotation/ArrayDotNotation.php b/src/DotNotation/ArrayDotNotation.php
@@ -265,7 +265,9 @@ public function remove($dotNotation) {
      */
     protected function recursiveRemove(array &$data, array $keys) {
         $key = array_shift($keys);
-        if (!array_key_exists($key, $data)) {
+        if (is_array($data) && $key === static::WILD_CARD_CHARACTER) {
+            $this->wildCardRemove($keys, $data);
+        } elseif (!array_key_exists($key, $data)) {
             throw new PathNotFoundException($key);
         } elseif ($key && count($keys) == 0) { //Last Key
             unset($data[$key]);
@@ -276,6 +278,26 @@ protected function recursiveRemove(array &$data, array $keys) {
         }
     }
 
+    /**
+     * Parses each key when a wild card  key is met
+     * @since 1.3.0
+     * @param array $keys the remaining keys of focus for the data array
+     * @param array $data data to be traversed
+     */
+    protected function wildCardRemove(array $keys, &$data) {
+        $keysNotFound = [];
+        foreach (array_keys($data) as $key) {
+            try {
+                $this->recursiveRemove($data, $this->unshiftKeys($keys, $key));
+            } catch (PathNotFoundException $exc) {
+                $keysNotFound[] = implode($this->getNotationType(), $this->unshiftKeys($keys, $key));
+            }
+        }
+        if(count($keysNotFound) === count($data)){
+            throw new PathNotFoundException(implode(', ', $keysNotFound));
+        }
+    }
+
     /**
      * consistently parses notation keys
      * @since 1.2.0

diff --git a/tests/DotNotation/ArrayDotNotationTest.php b/tests/DotNotation/ArrayDotNotationTest.php
@@ -236,6 +236,59 @@ public function testRemove() {
         $this->assertEquals($data, $this->_object->remove('levelA.levelB')->getData());
     }
 
+    public function testRemoveWildCard() {
+        $data = ["level1" => ["level2" => ["level3" => [
+                            ["id" => 1, "email" => null, "name" => "one"],
+                            ["id" => 2, "email" => null, "name" => "two"],
+                            ["id" => 3, "email" => null, "name" => "three"],
+                            ["id" => 4, "email" => null, "name" => "four"],
+                            ["id" => 5, "email" => null, "name" => "five"],
+                    ]]]
+        ];
+        $results = ["level1" => ["level2" => ["level3" => [
+                            ["id" => 1, "name" => "one"],
+                            ["id" => 2, "name" => "two"],
+                            ["id" => 3, "name" => "three"],
+                            ["id" => 4, "name" => "four"],
+                            ["id" => 5, "name" => "five"],
+                    ]]]
+        ];
+        $this->assertEquals($results, $this->_object->setData($data)->remove('level1.level2.level3.*.email')->getData());
+    }
+
+    public function testRemoveWildCardNoException() {
+        $data = ["level1" => ["level2" => ["level3" => [
+                            ["id" => 1, "email" => null, "name" => "one"],
+                            ["id" => 2, "email" => null, "name" => "two"],
+                            ["id" => 3, "email" => null, "name" => "three"],
+                            ["id" => 4, "email" => null, "name" => "four"],
+                            ["id" => 5, "name" => "five"],
+                    ]]]
+        ];
+        $results = ["level1" => ["level2" => ["level3" => [
+                            ["id" => 1, "name" => "one"],
+                            ["id" => 2, "name" => "two"],
+                            ["id" => 3, "name" => "three"],
+                            ["id" => 4, "name" => "four"],
+                            ["id" => 5, "name" => "five"],
+                    ]]]
+        ];
+        $this->assertEquals($results, $this->_object->setData($data)->remove('level1.level2.level3.*.email')->getData());
+    }
+
+    public function testRemoveWildCardException() {
+        $data = ["level1" => ["level2" => ["level3" => [
+                            ["id" => 1, "name" => "one"],
+                            ["id" => 2, "name" => "two"],
+                            ["id" => 3, "name" => "three"],
+                            ["id" => 4, "name" => "four"],
+                            ["id" => 5, "name" => "five"],
+                    ]]]
+        ];
+        $this->expectException(PathNotFoundException::class);
+        $this->_object->setData($data)->remove('level1.level2.level3.*.email')->getData();
+    }
+
     public function testRemovePathNotFound() {
         $this->expectException(PathNotFoundException::class);
         $this->_object->remove('levelA.levelC');