feat: add path modifier

Author: wazabii8

src/Interfaces/PathInterface.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace MaplePHP\Http\Interfaces;
+
+use Psr\Http\Message\UriInterface;
+
+interface PathInterface
+{
+}

src/Interfaces/UrlInterface.php

@@ -0,0 +1,214 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MaplePHP\Http;
+
+use MaplePHP\Http\Interfaces\PathInterface;
+
+class Path implements PathInterface
+{
+    private $parts;
+    private $vars;
+
+    public function __construct(array $parts)
+    {
+        $this->parts = $parts;
+        $this->vars = $this->partsToVars($parts);
+    }
+
+    /**
+     * With URI path type key
+     *
+     * @param null|string|array $type
+     * @return static
+     */
+    public function withType(null|string|array $type): self
+    {
+        if (is_string($type)) {
+            $type = [$type];
+        }
+        if ($type === null) {
+            $type = [];
+        }
+
+        $inst = clone $this;
+        $parts = [];
+        $vars = $this->partsToVars($inst->parts, $type, function ($key, $item) use (&$parts, $type) {
+            $parts[$key] = $item;
+        });
+        $inst->parts = $parts;
+        $inst->vars = $vars;
+        return $inst;
+    }
+
+    /**
+     * Same as withType except that you Need to select a part
+     * @param string|array $type
+     * @return static
+     */
+    public function select(string|array $type): self
+    {
+        return $this->withType($type);
+    }
+
+    /**
+     * Same as withType except it will only reset
+     * @return static
+     */
+    public function reset(): self
+    {
+        return $this->withType(null);
+    }
+
+    /**
+     * Append to URI path
+     *
+     * @param array|string $arr
+     * @return static
+     */
+    public function append(array|string $arr): self
+    {
+        $inst = clone $this;
+        if (is_string($arr)) {
+            $arr = [$arr];
+        }
+
+        $inst->vars = array_merge($inst->vars, $arr);
+        return $inst;
+    }
+
+    /**
+     * Prepend to URI path
+     *
+     * @param array|string $arr
+     * @return static
+     */
+    public function prepend(array|string $arr): self
+    {
+        $inst = clone $this;
+        if (is_string($arr)) {
+            $arr = [$arr];
+        }
+
+        $inst->vars = array_merge($arr, $inst->vars);
+        return $inst;
+    }
+
+    /**
+     * Get vars/path as array
+     * @return array
+     */
+    public function vars(): array
+    {
+        return $this->vars;
+    }
+
+    /**
+     * Get vars/path as array
+     * @return array
+     */
+    public function parts(): array
+    {
+        return $this->parts;
+    }
+
+    /**
+     * Get expected slug from path
+     * @return string
+     */
+    public function get(): string
+    {
+        return $this->last();
+    }
+
+    /**
+     * Get expected slug from path
+     * @return string
+     */
+    public function current(): string
+    {
+        return $this->last();
+    }
+
+    /**
+     * Get last path item
+     *
+     * @return string
+     */
+    public function last(): string
+    {
+        if ($this->vars === null) {
+            $this->vars = $this->getVars();
+        }
+        return end($this->vars);
+    }
+
+    /**
+     * Get first path item
+     *
+     * @return string
+     */
+    public function first(): string
+    {
+        if ($this->vars === null) {
+            $this->vars = $this->getVars();
+        }
+        return reset($this->vars);
+    }
+
+    /**
+     * Get travers to prev path item
+     *
+     * @return string
+     */
+    public function prev(): string
+    {
+        if ($this->vars === null) {
+            $this->end();
+        }
+        return prev($this->vars);
+    }
+
+    /**
+     * Get travers to next path item
+     *
+     * @return string
+     */
+    public function next(): string
+    {
+        if ($this->vars === null) {
+            $this->reset();
+        }
+        return next($this->vars);
+    }
+
+    /**
+     * Break parts down
+     *
+     * @param array $parts
+     * @param array|null $type
+     * @param callable|null $call
+     * @return array
+     */
+    protected function partsToVars(array $parts, ?array $type = null, ?callable $call = null): array
+    {
+        $vars = [];
+        foreach ($parts as $key => $item) {
+
+            if ($type === null || in_array($key, $type)) {
+
+                if (is_array($item)) {
+                    $vars = array_merge($vars, $item);
+                } else {
+                    $vars[] = $item;
+                }
+                if ($call !== null) {
+                    $call($key, $item);
+                }
+
+            }
+        }
+        return $vars;
+    }
+}