Moved global functions to handle array paths to a wrapper class

module/Common/functions/functions.php

@@ -4,11 +4,8 @@ declare(strict_types=1);
 namespace Shlinkio\Shlink\Common;
 
 use const JSON_ERROR_NONE;
-use function array_key_exists;
-use function array_shift;
 use function getenv;
 use function in_array;
-use function is_array;
 use function json_last_error;
 use function json_last_error_msg;
 use function strtolower;
@@ -62,39 +59,3 @@ function json_decode(string $json, int $depth = 512, int $options = 0): array
 
     return $data;
 }
-
-function array_path_exists(array $path, array $array): bool
-{
-    // As soon as a step is not found, the path does not exist
-    $step = array_shift($path);
-    if (! array_key_exists($step, $array)) {
-        return false;
-    }
-
-    // Once the path is empty, we have found all the parts in the path
-    if (empty($path)) {
-        return true;
-    }
-
-    // If current value is not an array, then we have not found the path
-    $newArray = $array[$step];
-    if (! is_array($newArray)) {
-        return false;
-    }
-
-    return array_path_exists($path, $newArray);
-}
-
-function array_get_path(array $path, array $array)
-{
-    do {
-        $step = array_shift($path);
-        if (! is_array($array) || ! array_key_exists($step, $array)) {
-            return null;
-        }
-
-        $array = $array[$step];
-    } while (! empty($path));
-
-    return $array;
-}

module/Common/src/Collection/PathCollection.php

@@ -0,0 +1,67 @@
+<?php
+declare(strict_types=1);
+
+namespace Shlinkio\Shlink\Common\Collection;
+
+use function array_key_exists;
+use function array_shift;
+use function is_array;
+
+final class PathCollection
+{
+    /**
+     * @var array
+     */
+    private $array;
+
+    public function __construct(array $array)
+    {
+        $this->array = $array;
+    }
+
+    public function pathExists(array $path): bool
+    {
+        return $this->checkPathExists($path, $this->array);
+    }
+
+    private function checkPathExists(array $path, array $array): bool
+    {
+        // As soon as a step is not found, the path does not exist
+        $step = array_shift($path);
+        if (! array_key_exists($step, $array)) {
+            return false;
+        }
+
+        // Once the path is empty, we have found all the parts in the path
+        if (empty($path)) {
+            return true;
+        }
+
+        // If current value is not an array, then we have not found the path
+        $newArray = $array[$step];
+        if (! is_array($newArray)) {
+            return false;
+        }
+
+        return $this->checkPathExists($path, $newArray);
+    }
+
+    /**
+     * @return mixed
+     */
+    public function getValueInPath(array $path)
+    {
+        $array = $this->array;
+
+        do {
+            $step = array_shift($path);
+            if (! is_array($array) || ! array_key_exists($step, $array)) {
+                return null;
+            }
+
+            $array = $array[$step];
+        } while (! empty($path));
+
+        return $array;
+    }
+}

module/Common/test/Collection/PathCollectionTest.php

@@ -0,0 +1,82 @@
+<?php
+declare(strict_types=1);
+
+namespace ShlinkioTest\Shlink\Common\Collection;
+
+use PHPUnit\Framework\TestCase;
+use Shlinkio\Shlink\Common\Collection\PathCollection;
+
+class PathCollectionTest extends TestCase
+{
+    /**
+     * @var PathCollection
+     */
+    private $collection;
+
+    public function setUp()
+    {
+        $this->collection = new PathCollection([
+            'foo' => [
+                'bar' => [
+                    'baz' => 'Hello world!',
+                ],
+            ],
+            'something' => [],
+            'another' => [
+                'one' => 'Shlink',
+            ],
+        ]);
+    }
+
+    /**
+     * @test
+     * @dataProvider providePaths
+     */
+    public function pathExistsReturnsExpectedValue(array $path, bool $expected)
+    {
+        $this->assertEquals($expected, $this->collection->pathExists($path));
+    }
+
+    public function providePaths(): array
+    {
+        return [
+            [[], false],
+            [['boo'], false],
+            [['foo', 'nop'], false],
+            [['another', 'one', 'nop'], false],
+            [['foo'], true],
+            [['foo', 'bar'], true],
+            [['foo', 'bar', 'baz'], true],
+            [['something'], true],
+        ];
+    }
+
+    /**
+     * @test
+     * @dataProvider providePathsWithValue
+     */
+    public function getValueInPathReturnsExpectedValue(array $path, $expected)
+    {
+        $this->assertEquals($expected, $this->collection->getValueInPath($path));
+    }
+
+    public function providePathsWithValue(): array
+    {
+        return [
+            [[], null],
+            [['boo'], null],
+            [['foo', 'nop'], null],
+            [['another', 'one', 'nop'], null],
+            [['foo'], [
+                'bar' => [
+                    'baz' => 'Hello world!',
+                ],
+            ]],
+            [['foo', 'bar'], [
+                'baz' => 'Hello world!',
+            ]],
+            [['foo', 'bar', 'baz'], 'Hello world!'],
+            [['something'], []],
+        ];
+    }
+}