Merge pull request #7 from MaplePHP/develop

Add path modifier

Author: wazabii8

.github/workflows/php.yml

@@ -0,0 +1,34 @@
+name: PHP Unitary
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    branches: ["main"]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    env:
+      COMPOSER_ROOT_VERSION: 2.x-dev
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Cache Composer packages
+        uses: actions/cache@v3
+        with:
+          path: vendor
+          key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-php-
+
+      - name: Install dependencies
+        run: composer install --prefer-dist --no-progress
+
+      - name: Run test suite
+        run: php vendor/bin/unitary

composer.json

@@ -27,6 +27,9 @@
       "homepage": "https://wazabii.se"
     }
   ],
+  "scripts": {
+    "test": "php vendor/bin/unitary"
+  },
   "require": {
     "php": ">=8.2",
     "psr/http-message": "^2.0",
@@ -44,11 +47,10 @@
   },
   "extra": {
     "branch-alias": {
-      "dev-develop": "2.0.x-dev"
+      "dev-main": "2.x-dev",
+      "dev-develop": "2.x-dev"
     }
   },
   "minimum-stability": "dev",
-  "scripts": {
-    "unitary": "php vendor/bin/unitary"
-  }
+  "prefer-stable": true
 }

src/Interfaces/PathInterface.php

@@ -0,0 +1,113 @@
+<?php
+
+namespace MaplePHP\Http\Interfaces;
+
+
+use Psr\Http\Message\UriInterface;
+
+interface PathInterface
+{
+
+	/**
+	 * Get PSR URI instance with whitelisted path and
+	 * cleared, query and fragments
+	 *
+	 * @return UriInterface
+	 */
+	public function uri(): UriInterface;
+
+	/**
+	 * Get current full URL with whitelisted path
+	 *
+	 * @return string
+	 */
+	public function url(): string;
+
+	/**
+	 * With URI path type key
+	 *
+	 * @param null|string|array $type
+	 * @return static
+	 */
+	public function withType(null|string|array $type): self;
+
+	/**
+	 * Same as withType except that you Need to select a part
+	 *
+	 * @param string|array $type
+	 * @return static
+	 */
+	public function select(string|array $type): self;
+
+	/**
+	 * Same as withType except it will only reset
+	 *
+	 * @return static
+	 */
+	public function reset(): self;
+
+	/**
+	 * Append to URI path
+	 *
+	 * @param array|string $arr
+	 * @return static
+	 */
+	public function append(array|string $arr): self;
+
+	/**
+	 * Prepend to URI path
+	 *
+	 * @param array|string $arr
+	 * @return static
+	 */
+	public function prepend(array|string $arr): self;
+
+	/**
+	 * Get vars/path as array
+	 *
+	 * @return array
+	 */
+	public function vars(): array;
+
+	/**
+	 * Get vars/path as array
+	 *
+	 * @return array
+	 */
+	public function parts(): array;
+
+	/**
+	 * Get expected slug from path
+	 *
+	 * @return array
+	 */
+	public function get(): array;
+
+	/**
+	 * Get last path item
+	 *
+	 * @return string
+	 */
+	public function last(): string;
+
+	/**
+	 * Get first path item
+	 *
+	 * @return string
+	 */
+	public function first(): string;
+
+	/**
+	 * Get travers to prev path item
+	 *
+	 * @return string
+	 */
+	public function prev(): string;
+
+	/**
+	 * Get travers to next path item
+	 *
+	 * @return string
+	 */
+	public function next(): string;
+}