Merge pull request #402 from skipperbent/v4-development

Version 4.1.0.0

README.md

@@ -332,7 +332,7 @@ function request(): Request
  * @param string|null $index Parameter index name
  * @param string|null $defaultValue Default return value
  * @param array ...$methods Default methods
- * @return \Pecee\Http\Input\InputHandler|\Pecee\Http\Input\IInputItem|string
+ * @return \Pecee\Http\Input\InputHandler|string
  */
 function input($index = null, $defaultValue = null, ...$methods)
 {
@@ -1296,6 +1296,7 @@ All event callbacks will retrieve a `EventArgument` object as parameter. This ob
 | `EVENT_ALL`                 | - | Fires when a event is triggered. |
 | `EVENT_INIT`                | - | Fires when router is initializing and before routes are loaded. |
 | `EVENT_LOAD`                | `loadedRoutes` | Fires when all routes has been loaded and rendered, just before the output is returned. |
+| `EVENT_ADD_ROUTE`           | `route` | Fires when route is added to the router. |
 | `EVENT_REWRITE`             | `rewriteUrl`<br>`rewriteRoute` | Fires when a url-rewrite is and just before the routes are re-initialized. |
 | `EVENT_BOOT`                | `bootmanagers` | Fires when the router is booting. This happens just before boot-managers are rendered and before any routes has been loaded. |
 | `EVENT_RENDER_BOOTMANAGER`  | `bootmanagers`<br>`bootmanager` | Fires before a boot-manager is rendered. |

helpers.php

@@ -49,7 +49,7 @@ function request(): Request
  * @param string|null $index Parameter index name
  * @param string|null $defaultValue Default return value
  * @param array ...$methods Default methods
- * @return \Pecee\Http\Input\InputHandler|\Pecee\Http\Input\IInputItem|string
+ * @return \Pecee\Http\Input\InputHandler|string
  */
 function input($index = null, $defaultValue = null, ...$methods)
 {

src/Pecee/Http/Input/IInputItem.php

@@ -9,14 +9,14 @@ interface IInputItem
 
     public function setIndex(string $index): self;
 
-    public function getName(): string;
+    public function getName(): ?string;
 
     public function setName(string $name): self;
 
-    public function getValue(): string;
+    public function getValue(): ?string;
 
     public function setValue(string $value): self;
 
-    public function __toString();
+    public function __toString(): string;
 
 }

src/Pecee/Http/Input/InputFile.php

@@ -49,7 +49,7 @@ class InputFile implements IInputItem
 
         return (new static($values['index']))
             ->setSize((int)$values['size'])
-            ->setError($values['error'])
+            ->setError((int)$values['error'])
             ->setType($values['type'])
             ->setTmpName($values['tmp_name'])
             ->setFilename($values['name']);
@@ -140,7 +140,7 @@ class InputFile implements IInputItem
      *
      * @return string
      */
-    public function getName(): string
+    public function getName(): ?string
     {
         return $this->name;
     }
@@ -177,7 +177,7 @@ class InputFile implements IInputItem
      *
      * @return string mixed
      */
-    public function getFilename(): string
+    public function getFilename(): ?string
     {
         return $this->filename;
     }
@@ -216,11 +216,11 @@ class InputFile implements IInputItem
     /**
      * Get upload-error code.
      *
-     * @return string
+     * @return int
      */
-    public function getError(): string
+    public function getError(): int
     {
-        return $this->errors;
+        return (int)$this->errors;
     }
 
     /**
@@ -256,12 +256,12 @@ class InputFile implements IInputItem
         return $this;
     }
 
-    public function __toString()
+    public function __toString(): string
     {
         return $this->getTmpName();
     }
 
-    public function getValue(): string
+    public function getValue(): ?string
     {
         return $this->getFilename();
     }

src/Pecee/Http/Input/InputHandler.php

@@ -251,12 +251,12 @@ class InputHandler
      * Check if a input-item exist
      *
      * @param string $index
-     * @param array ...$method
+     * @param array ...$methods
      * @return bool
      */
-    public function exists(string $index, ...$method): bool
+    public function exists(string $index, ...$methods): bool
     {
-        return $this->get($index, $method) !== null;
+        return $this->get($index, ...$methods) !== null;
     }
 
     /**

src/Pecee/Http/Input/InputItem.php

@@ -35,7 +35,7 @@ class InputItem implements IInputItem
     /**
      * @return string
      */
-    public function getName(): string
+    public function getName(): ?string
     {
         return $this->name;
     }
@@ -55,7 +55,7 @@ class InputItem implements IInputItem
     /**
      * @return string
      */
-    public function getValue(): string
+    public function getValue(): ?string
     {
         return $this->value;
     }
@@ -72,7 +72,7 @@ class InputItem implements IInputItem
         return $this;
     }
 
-    public function __toString()
+    public function __toString(): string
     {
         return (string)$this->value;
     }

src/Pecee/Http/Url.php

@@ -4,7 +4,7 @@ namespace Pecee\Http;
 
 use Pecee\Http\Exceptions\MalformedUrlException;
 
-class Url
+class Url implements \JsonSerializable
 {
     private $originalUrl;
 
@@ -314,25 +314,36 @@ class Url
      */
     public function hasParam(string $name): bool
     {
-        return \in_array($name, $this->getParams(), true);
+        return array_key_exists($name, $this->getParams());
     }
 
     /**
-     * Removes parameter from query-string
+     * Removes multiple parameters from the query-string
+     *
+     * @param array ...$names
+     * @return static
+     */
+    public function removeParams(...$names): self
+    {
+        $params = array_diff_key($this->getParams(), array_flip($names));
+        $this->setParams($params);
+
+        return $this;
+    }
+
+    /**
+     * Removes parameter from the query-string
      *
      * @param string $name
+     * @return static
      */
-    public function removeParam(string $name): void
+    public function removeParam(string $name): self
     {
-        if ($this->hasParam($name) === true) {
-            $params = $this->getParams();
-            $key = \array_search($name, $params, true);
+        $params = $this->getParams();
+        unset($params[$name]);
+        $this->setParams($params);
 
-            if ($key === true) {
-                unset($params[$key]);
-                $this->setParams($params);
-            }
-        }
+        return $this;
     }
 
     /**
@@ -345,18 +356,7 @@ class Url
      */
     public function getParam(string $name, ?string $defaultValue = null): ?string
     {
-        $output = null;
-
-        if ($this->hasParam($name) === true) {
-            $params = $this->getParams();
-            $key = \array_search($name, $params, true);
-
-            if ($key === true) {
-                $output = $params[$key];
-            }
-        }
-
-        return $output ?? $defaultValue;
+        return isset($this->getParams()[$name]) ?? $defaultValue;
     }
 
     /**
@@ -441,7 +441,19 @@ class Url
         return $scheme . $user . $pass . $host . $port . $this->getRelativeUrl();
     }
 
-    public function __toString()
+    /**
+     * Specify data which should be serialized to JSON
+     * @link http://php.net/manual/en/jsonserializable.jsonserialize.php
+     * @return mixed data which can be serialized by <b>json_encode</b>,
+     * which is a value of any type other than a resource.
+     * @since 5.4.0
+     */
+    public function jsonSerialize(): string
+    {
+        return $this->getRelativeUrl();
+    }
+
+    public function __toString(): string
     {
         return $this->getRelativeUrl();
     }

src/Pecee/SimpleRouter/Handlers/EventHandler.php

@@ -22,6 +22,11 @@ class EventHandler implements IEventHandler
      */
     public const EVENT_LOAD = 'onLoad';
 
+    /**
+     * Fires when route is added to the router
+     */
+    public const EVENT_ADD_ROUTE = 'onAddRoute';
+
     /**
      * Fires when a url-rewrite is and just before the routes are re-initialized.
      */
@@ -95,6 +100,7 @@ class EventHandler implements IEventHandler
         self::EVENT_ALL,
         self::EVENT_INIT,
         self::EVENT_LOAD,
+        self::EVENT_ADD_ROUTE,
         self::EVENT_REWRITE,
         self::EVENT_BOOT,
         self::EVENT_RENDER_BOOTMANAGER,

src/Pecee/SimpleRouter/Route/ILoadableRoute.php

@@ -39,6 +39,13 @@ interface ILoadableRoute extends IRoute
      */
     public function setUrl(string $url): self;
 
+    /**
+     * Prepend url
+     * @param string $url
+     * @return ILoadableRoute
+     */
+    public function prependUrl(string $url): self;
+
     /**
      * Returns the provided name for the router.
      *

src/Pecee/SimpleRouter/Route/LoadableRoute.php

@@ -85,6 +85,17 @@ abstract class LoadableRoute extends Route implements ILoadableRoute
         return $this;
     }
 
+    /**
+     * Prepend url
+     *
+     * @param string $url
+     * @return ILoadableRoute
+     */
+    public function prependUrl(string $url): ILoadableRoute
+    {
+        return $this->setUrl(rtrim($url, '/') . $this->url);
+    }
+
     public function getUrl(): string
     {
         return $this->url;
@@ -154,7 +165,7 @@ abstract class LoadableRoute extends Route implements ILoadableRoute
      *
      * @return string
      */
-    public function getName(): string
+    public function getName(): ?string
     {
         return $this->name;
     }
@@ -240,7 +251,7 @@ abstract class LoadableRoute extends Route implements ILoadableRoute
         }
 
         if (isset($values['prefix']) === true) {
-            $this->setUrl($values['prefix'] . $this->getUrl());
+            $this->prependUrl($values['prefix']);
         }
 
         parent::setSettings($values, $merge);

src/Pecee/SimpleRouter/Route/Route.php

@@ -192,7 +192,7 @@ abstract class Route implements IRoute
             return $this->callback;
         }
 
-        return 'function_' . md5($this->callback);
+        return 'function:' . md5($this->callback);
     }
 
     /**

src/Pecee/SimpleRouter/Router.php

@@ -151,18 +151,20 @@ class Router
      */
     public function addRoute(IRoute $route): IRoute
     {
+        $this->fireEvents(EventHandler::EVENT_ADD_ROUTE, [
+            'route' => $route,
+        ]);
+
         /*
          * If a route is currently being processed, that means that the route being added are rendered from the parent
          * routes callback, so we add them to the stack instead.
          */
         if ($this->isProcessingRoute === true) {
             $this->routeStack[] = $route;
-
-            return $route;
+        } else {
+            $this->routes[] = $route;
         }
 
-        $this->routes[] = $route;
-
         return $route;
     }
 

src/Pecee/SimpleRouter/SimpleRouter.php

@@ -447,7 +447,7 @@ class SimpleRouter
      * @param array|null $getParams
      * @return Url
      */
-    public static function getUrl(?string $name = null, $parameters = null, $getParams = null): Url
+    public static function getUrl(?string $name = null, $parameters = null, ?array $getParams = null): Url
     {
         try {
             return static::router()->getUrl($name, $parameters, $getParams);

tests/Pecee/SimpleRouter/EventHandlerTest.php

@@ -6,8 +6,8 @@ require_once 'Dummy/Handler/ExceptionHandler.php';
 require_once 'Dummy/Security/SilentTokenProvider.php';
 require_once 'Dummy/Managers/TestBootManager.php';
 
-use \Pecee\SimpleRouter\Handlers\EventHandler;
-use \Pecee\SimpleRouter\Event\EventArgument;
+use Pecee\SimpleRouter\Event\EventArgument;
+use Pecee\SimpleRouter\Handlers\EventHandler;
 
 class EventHandlerTest extends \PHPUnit\Framework\TestCase
 {
@@ -78,4 +78,30 @@ class EventHandlerTest extends \PHPUnit\Framework\TestCase
         $this->assertEquals(true, $status);
     }
 
+    public function testPrefixEvent()
+    {
+
+        $eventHandler = new EventHandler();
+        $eventHandler->register(EventHandler::EVENT_ADD_ROUTE, function (EventArgument $arg) use (&$status) {
+
+            if ($arg->route instanceof \Pecee\SimpleRouter\Route\LoadableRoute) {
+                $arg->route->prependUrl('/local-path');
+            }
+
+        });
+
+        TestRouter::addEventHandler($eventHandler);
+
+        $status = false;
+
+        TestRouter::get('/', function () use (&$status) {
+            $status = true;
+        });
+
+        TestRouter::debug('/local-path');
+
+        $this->assertTrue($status);
+
+    }
+
 }