Add collection traverse methods

Author: danielRConsid

Traits/ArrayUtilities.php

@@ -8,7 +8,6 @@
 
 trait ArrayUtilities
 {
-
     /**
      * Applies the callback to the elements of the given arrays
      * https://www.php.net/manual/en/function.array-map.php
@@ -140,6 +139,38 @@ public function prepend(array|TraverseInterface $combine): self
         return $this->merge($combine, true);
     }
 
+    /**
+     * Remove a portion of the array and replace it with something else
+     * https://www.php.net/manual/en/function.array-splice.php
+     *
+     * @param int $offset
+     * @param int|null $length
+     * @param mixed $replacement
+     * @param mixed|null $splicedResults
+     * @return ArrayUtilities|Traverse
+     */
+    public function splice(
+        int $offset, ?int $length, mixed $replacement = [], mixed &$splicedResults = null
+    ): self {
+        $splicedResults = array_splice($this->raw, $offset, $length, $replacement);
+        $splicedResults = new self($splicedResults);
+        return $this;
+    }
+
+    /**
+     * Extract a slice of the array
+     * https://www.php.net/manual/en/function.array-slice.php
+     *
+     * @param int $offset
+     * @param int|null $length
+     * @param bool $preserveKeys
+     * @return ArrayUtilities|Traverse
+     */
+    public function slice(int $offset, ?int $length, bool $preserveKeys = false): self {
+        $this->raw = array_slice($this->raw, $offset, $length, $preserveKeys);
+        return $this;
+    }
+
     /**
      * Computes the difference of arrays
      * https://www.php.net/manual/en/function.array-diff.php
@@ -551,14 +582,13 @@ public function keys(): self
      * A helper function to handle collect args
      *
      * @param array|TraverseInterface $collect
-     * @return array|TraverseInterface
+     * @return array
      */
-    protected function handleCollectArg(array|TraverseInterface $collect): array|TraverseInterface
+    protected function handleCollectArg(array|TraverseInterface $collect): array
     {
         if ($collect instanceof TraverseInterface) {
             $collect = $collect->toArray();
         }
         return $collect;
     }
-
 }

Traverse.php

@@ -220,14 +220,16 @@ public function validAndTravers(string $method, array $args, mixed $fallback = n
         return $this;
     }
 
+
     /**
-     * Json decode value
+     * Returns the JSON representation of a value
+     * https://www.php.net/manual/en/function.json-encode.php
+     *
      * @return self
      */
-    public function jsonDecode(): self
+    public function toJson(mixed $value, int $flags = 0, int $depth = 512): mixed
     {
-        $this->raw = json_decode($this->raw);
-        return $this::value($this->raw);
+        return json_encode($value, $flags, $depth);
     }
 
     /**

tests/unitary-dto-traverse.php

@@ -208,6 +208,18 @@
         'equal' => 'fish'
     ], 'Last returned wrong value');
 
+    $this->add($obj->shopList->splice(1, 2, splicedResults: $result)->count(), [
+        'equal' => 5
+    ], 'Splice returned wrong value');
+
+    $this->add($result->count(), [
+        'equal' => 2
+    ], 'Spliced Results returned wrong value');
+
+    $this->add($obj->shopList->slice(1, 2)->count(), [
+        'equal' => 2
+    ], 'Splice returned wrong value');
+
     $this->add($obj->shopList->prepend(['prepend'])->first(), [
         'equal' => 'prepend'
     ], 'Prepend returned wrong value');