Merge pull request #559 from skipperbent/v4-development

Version 4.3.5.0

README.md

@@ -77,6 +77,7 @@ You can donate any amount of your choice by [clicking here](https://www.paypal.c
 	    - [Get parameter object](#get-parameter-object)
 	    - [Managing files](#managing-files)
 	    - [Get all parameters](#get-all-parameters)
+	    - [Check if parameters exists](#check-if-parameters-exists)
 - [Events](#events)
     - [Available events](#available-events)
     - [Registering new event](#registering-new-event)
@@ -1236,8 +1237,11 @@ $values = input()->all([
 All object implements the `IInputItem` interface and will always contain these methods:
 
 - `getIndex()` - returns the index/key of the input.
+- `setIndex()` - set the index/key of the input.
 - `getName()` - returns a human friendly name for the input (company_name will be Company Name etc).
+- `setName()` - sets a human friendly name for the input (company_name will be Company Name etc).
 - `getValue()` - returns the value of the input.
+- `setValue()` - sets the value of the input.
 
 `InputFile` has the same methods as above along with some other file-specific methods like:
 
@@ -1253,6 +1257,24 @@ All object implements the `IInputItem` interface and will always contain these m
 
 ---
 
+### Check if parameters exists
+
+You can easily if multiple items exists by using the `exists` method. It's simular to `value` as it can be used 
+to filter on request-methods and supports both `string` and `array` as parameter value.
+
+**Example:**
+
+```php
+if(input()->exists(['name', 'lastname'])) {
+	// Do stuff
+}
+
+/* Similar to code above */
+if(input()->exists('name') && input()->exists('lastname')) {
+	// Do stuff
+}
+```
+
 # Events
 
 This section will help you understand how to register your own callbacks to events in the router.

src/Pecee/Http/Input/InputFile.php

@@ -216,11 +216,11 @@ class InputFile implements IInputItem
     /**
      * Get upload-error code.
      *
-     * @return int
+     * @return int|null
      */
-    public function getError(): int
+    public function getError(): ?int
     {
-        return (int)$this->errors;
+        return $this->errors;
     }
 
     /**

src/Pecee/Http/Input/InputHandler.php

@@ -293,14 +293,26 @@ class InputHandler
     }
 
     /**
-     * Check if a input-item exist
+     * Check if a input-item exist.
+     * If an array is as $index parameter the method returns true if all elements exist.
      *
-     * @param string $index
+     * @param string|array $index
      * @param array ...$methods
      * @return bool
      */
-    public function exists(string $index, ...$methods): bool
+    public function exists($index, ...$methods): bool
     {
+        // Check array
+        if(is_array($index) === true) {
+            foreach($index as $key) {
+                if($this->value($key, null, ...$methods) === null) {
+                    return false;
+                }
+            }
+
+            return true;
+        }
+
         return $this->value($index, null, ...$methods) !== null;
     }
 
@@ -308,10 +320,10 @@ class InputHandler
      * Find post-value by index or return default value.
      *
      * @param string $index
-     * @param string|null $defaultValue
+     * @param mixed|null $defaultValue
      * @return InputItem|array|string|null
      */
-    public function post(string $index, ?string $defaultValue = null)
+    public function post(string $index, $defaultValue = null)
     {
         return $this->post[$index] ?? $defaultValue;
     }
@@ -320,10 +332,10 @@ class InputHandler
      * Find file by index or return default value.
      *
      * @param string $index
-     * @param string|null $defaultValue
+     * @param mixed|null $defaultValue
      * @return InputFile|array|string|null
      */
-    public function file(string $index, ?string $defaultValue = null)
+    public function file(string $index, $defaultValue = null)
     {
         return $this->file[$index] ?? $defaultValue;
     }
@@ -332,10 +344,10 @@ class InputHandler
      * Find parameter/query-string by index or return default value.
      *
      * @param string $index
-     * @param string|null $defaultValue
+     * @param mixed|null $defaultValue
      * @return InputItem|array|string|null
      */
-    public function get(string $index, ?string $defaultValue = null)
+    public function get(string $index, $defaultValue = null)
     {
         return $this->get[$index] ?? $defaultValue;
     }

src/Pecee/Http/Input/InputItem.php

@@ -2,10 +2,11 @@
 
 namespace Pecee\Http\Input;
 
+use ArrayAccess;
 use ArrayIterator;
 use IteratorAggregate;
 
-class InputItem implements IInputItem, IteratorAggregate
+class InputItem implements ArrayAccess, IInputItem, IteratorAggregate
 {
     public $index;
     public $name;
@@ -75,9 +76,34 @@ class InputItem implements IInputItem, IteratorAggregate
         return $this;
     }
 
+    public function offsetExists($offset): bool
+    {
+        return isset($this->value[$offset]);
+    }
+
+    public function offsetGet($offset)
+    {
+        if ($this->offsetExists($offset) === true) {
+            return $this->value[$offset];
+        }
+
+        return null;
+    }
+
+    public function offsetSet($offset, $value): void
+    {
+        $this->value[$offset] = $value;
+    }
+
+    public function offsetUnset($offset): void
+    {
+        unset($this->value[$offset]);
+    }
+
     public function __toString(): string
     {
         $value = $this->getValue();
+
         return (is_array($value) === true) ? json_encode($value) : $value;
     }
 

src/Pecee/Http/Request.php

@@ -264,12 +264,12 @@ class Request
      * Get header value by name
      *
      * @param string $name Name of the header.
-     * @param string|null $defaultValue Value to be returned if header is not found.
+     * @param string|mixed|null $defaultValue Value to be returned if header is not found.
      * @param bool $tryParse When enabled the method will try to find the header from both from client (http) and server-side variants, if the header is not found.
      *
      * @return string|null
      */
-    public function getHeader(string $name, $defaultValue = null, $tryParse = true): ?string
+    public function getHeader(string $name, $defaultValue = null, bool $tryParse = true): ?string
     {
         $name = strtolower($name);
         $header = $this->headers[$name] ?? null;

src/Pecee/Http/Url.php

@@ -248,8 +248,9 @@ class Url implements JsonSerializable
     public function setQueryString(string $queryString): self
     {
         $params = [];
+        parse_str($queryString, $params);
 
-        if(parse_str($queryString, $params) !== false) {
+        if(count($params) > 0) {
             return $this->setParams($params);
         }
 
@@ -341,7 +342,7 @@ class Url implements JsonSerializable
      */
     public function removeParams(...$names): self
     {
-        $params = array_diff_key($this->getParams(), array_flip($names));
+        $params = array_diff_key($this->getParams(), array_flip(...$names));
         $this->setParams($params);
 
         return $this;
@@ -430,7 +431,7 @@ class Url implements JsonSerializable
      * @param bool $includeParams
      * @return string
      */
-    public function getRelativeUrl($includeParams = true): string
+    public function getRelativeUrl(bool $includeParams = true): string
     {
         $path = $this->path ?? '/';
 
@@ -450,7 +451,7 @@ class Url implements JsonSerializable
      * @param bool $includeParams
      * @return string
      */
-    public function getAbsoluteUrl($includeParams = true): string
+    public function getAbsoluteUrl(bool $includeParams = true): string
     {
         $scheme = $this->scheme !== null ? $this->scheme . '://' : '';
         $host = $this->host ?? '';

src/Pecee/SimpleRouter/Route/LoadableRoute.php

@@ -100,6 +100,18 @@ abstract class LoadableRoute extends Route implements ILoadableRoute
         return $this->url;
     }
 
+    /**
+     * Returns true if group is defined and matches the given url.
+     *
+     * @param string $url
+     * @param Request $request
+     * @return bool
+     */
+    protected function matchGroup(string $url, Request $request): bool
+    {
+        return ($this->getGroup() === null || $this->getGroup()->matchRoute($url, $request) === true);
+    }
+
     /**
      * Find url that matches method, parameters or name.
      * Used when calling the url() helper.
@@ -203,9 +215,9 @@ abstract class LoadableRoute extends Route implements ILoadableRoute
      * Sets the router name, which makes it easier to obtain the url or router at a later point.
      * Alias for LoadableRoute::setName().
      *
-     * @see LoadableRoute::setName()
      * @param string|array $name
      * @return static
+     * @see LoadableRoute::setName()
      */
     public function name($name): ILoadableRoute
     {

src/Pecee/SimpleRouter/Route/Route.php

@@ -337,6 +337,17 @@ abstract class Route implements IRoute
      */
     public function setNamespace(string $namespace): IRoute
     {
+        $ns = $this->getNamespace();
+
+        if ($ns !== null) {
+            // Don't overwrite namespaces that starts with \
+            if ($ns[0] !== '\\') {
+                $namespace .= '\\' . $ns;
+            } else {
+                $namespace = $ns;
+            }
+        }
+
         $this->namespace = $namespace;
 
         return $this;
@@ -407,7 +418,7 @@ abstract class Route implements IRoute
      */
     public function setSettings(array $settings, bool $merge = false): IRoute
     {
-        if ($this->namespace === null && isset($settings['namespace']) === true) {
+        if (isset($settings['namespace']) === true) {
             $this->setNamespace($settings['namespace']);
         }
 

src/Pecee/SimpleRouter/Route/RouteController.php

@@ -88,7 +88,7 @@ class RouteController extends LoadableRoute implements IControllerRoute
 
     public function matchRoute(string $url, Request $request): bool
     {
-        if ($this->getGroup() !== null && $this->getGroup()->matchRoute($url, $request) === false) {
+        if ($this->matchGroup($url, $request) === false) {
             return false;
         }
 

src/Pecee/SimpleRouter/Route/RouteResource.php

@@ -85,7 +85,7 @@ class RouteResource extends LoadableRoute implements IControllerRoute
 
     public function matchRoute(string $url, Request $request): bool
     {
-        if ($this->getGroup() !== null && $this->getGroup()->matchRoute($url, $request) === false) {
+        if ($this->matchGroup($url, $request) === false) {
             return false;
         }
 

src/Pecee/SimpleRouter/Router.php

@@ -509,7 +509,7 @@ class Router
         ]);
 
         /* @var $handler IExceptionHandler */
-        foreach ($this->exceptionHandlers as $key => $handler) {
+        foreach (array_reverse($this->exceptionHandlers) as $key => $handler) {
 
             if (is_object($handler) === false) {
                 $handler = new $handler();
@@ -944,4 +944,10 @@ class Router
         return $this;
     }
 
+    public function addExceptionHandler(IExceptionHandler $handler): self
+    {
+        $this->exceptionHandlers[] = $handler;
+        return $this;
+    }
+
 }

src/Pecee/SimpleRouter/SimpleRouter.php

@@ -348,7 +348,7 @@ class SimpleRouter
      * @param array|null $settings
      * @return RouteUrl|IRoute
      */
-    public static function match(array $requestMethods, string $url, $callback, array $settings = null)
+    public static function match(array $requestMethods, string $url, $callback, array $settings = null): IRoute
     {
         $route = new RouteUrl($url, $callback);
         $route->setRequestMethods($requestMethods);
@@ -368,7 +368,7 @@ class SimpleRouter
      * @param array|null $settings
      * @return RouteUrl|IRoute
      */
-    public static function all(string $url, $callback, array $settings = null)
+    public static function all(string $url, $callback, array $settings = null): IRoute
     {
         $route = new RouteUrl($url, $callback);
 
@@ -387,7 +387,7 @@ class SimpleRouter
      * @param array|null $settings
      * @return RouteController|IRoute
      */
-    public static function controller(string $url, string $controller, array $settings = null)
+    public static function controller(string $url, string $controller, array $settings = null): IRoute
     {
         $route = new RouteController($url, $controller);
 
@@ -406,7 +406,7 @@ class SimpleRouter
      * @param array|null $settings
      * @return RouteResource|IRoute
      */
-    public static function resource(string $url, string $controller, array $settings = null)
+    public static function resource(string $url, string $controller, array $settings = null): IRoute
     {
         $route = new RouteResource($url, $controller);
 
@@ -425,16 +425,9 @@ class SimpleRouter
      */
     public static function error(Closure $callback): CallbackExceptionHandler
     {
-        $routes = static::router()->getRoutes();
-
         $callbackHandler = new CallbackExceptionHandler($callback);
 
-        $group = new RouteGroup();
-        $group->addExceptionHandler($callbackHandler);
-
-        array_unshift($routes, $group);
-
-        static::router()->setRoutes($routes);
+        static::router()->addExceptionHandler($callbackHandler);
 
         return $callbackHandler;
     }
@@ -512,20 +505,7 @@ class SimpleRouter
     public static function addDefaultNamespace(IRoute $route): IRoute
     {
         if (static::$defaultNamespace !== null) {
-
-            $ns = static::$defaultNamespace;
-            $namespace = $route->getNamespace();
-
-            if ($namespace !== null) {
-                // Don't overwrite namespaces that starts with \
-                if ($namespace[0] !== '\\') {
-                    $ns .= '\\' . $namespace;
-                } else {
-                    $ns = $namespace;
-                }
-            }
-
-            $route->setNamespace($ns);
+            $route->setNamespace(static::$defaultNamespace);
         }
 
         return $route;

tests/Pecee/SimpleRouter/Dummy/ClassLoader/CustomClassLoader.php

@@ -16,11 +16,11 @@ class CustomClassLoader implements \Pecee\SimpleRouter\ClassLoader\IClassLoader
      */
     public function loadClassMethod($class, string $method, array $parameters)
     {
-        return call_user_func_array([$class, $method], ['result' => true]);
+        return call_user_func_array([$class, $method], [true]);
     }
 
     public function loadClosure(callable $closure, array $parameters)
     {
-        return call_user_func_array($closure, ['result' => true]);
+        return call_user_func_array($closure, [true]);
     }
 }

tests/Pecee/SimpleRouter/RouterCallbackExceptionHandlerTest.php

@@ -19,10 +19,29 @@ class RouterCallbackExceptionHandlerTest extends \PHPUnit\Framework\TestCase
             throw new ExceptionHandlerException();
         });
 
-        TestRouter::debugNoReset('/404-url', 'get');
-        TestRouter::router()->reset();
+        TestRouter::debug('/404-url');
+    }
 
-        $this->assertTrue(true);
+    public function testExceptionHandlerCallback() {
+
+        TestRouter::group(['prefix' => null], function() {
+            TestRouter::get('/', function() {
+                return 'Hello world';
+            });
+
+            TestRouter::get('/not-found', 'DummyController@method1');
+            TestRouter::error(function(\Pecee\Http\Request $request, \Exception $exception) {
+
+                if($exception instanceof \Pecee\SimpleRouter\Exceptions\NotFoundHttpException && $exception->getCode() === 404) {
+                    return $request->setRewriteCallback(static function() {
+                        return 'success';
+                    });
+                }
+            });
+        });
+
+        $result = TestRouter::debugOutput('/thisdoes-not/existssss', 'get');
+        $this->assertEquals('success', $result);
     }
 
 }

tests/Pecee/SimpleRouter/RouterGroupTest.php

@@ -3,20 +3,20 @@
 require_once 'Dummy/DummyMiddleware.php';
 require_once 'Dummy/DummyController.php';
 
-class GroupTest extends \PHPUnit\Framework\TestCase
+class RouterGroupTest extends \PHPUnit\Framework\TestCase
 {
 
     public function testGroupLoad()
     {
         $result = false;
 
-        TestRouter::group(['prefix' => '/group'], function () use(&$result) {
+        TestRouter::group(['prefix' => '/group'], function () use (&$result) {
             $result = true;
         });
 
         try {
             TestRouter::debug('/', 'get');
-        } catch(\Exception $e) {
+        } catch (\Exception $e) {
 
         }
         $this->assertTrue($result);
@@ -81,4 +81,40 @@ class GroupTest extends \PHPUnit\Framework\TestCase
 
     }
 
+    public function testNamespaceExtend()
+    {
+        TestRouter::group(['namespace' => '\My\Namespace'], function () use (&$result) {
+
+            TestRouter::group(['namespace' => 'Service'], function () use (&$result) {
+
+                TestRouter::get('/test', function () use (&$result) {
+                    return \Pecee\SimpleRouter\SimpleRouter::router()->getRequest()->getLoadedRoute()->getNamespace();
+                });
+
+            });
+
+        });
+
+        $namespace = TestRouter::debugOutput('/test');
+        $this->assertEquals('\My\Namespace\Service', $namespace);
+    }
+
+    public function testNamespaceOverwrite()
+    {
+        TestRouter::group(['namespace' => '\My\Namespace'], function () use (&$result) {
+
+            TestRouter::group(['namespace' => '\Service'], function () use (&$result) {
+
+                TestRouter::get('/test', function () use (&$result) {
+                    return \Pecee\SimpleRouter\SimpleRouter::router()->getRequest()->getLoadedRoute()->getNamespace();
+                });
+
+            });
+
+        });
+
+        $namespace = TestRouter::debugOutput('/test');
+        $this->assertEquals('\Service', $namespace);
+    }
+
 }

tests/Pecee/SimpleRouter/RouterRewriteTest.php

@@ -49,9 +49,9 @@ class RouterRewriteTest extends \PHPUnit\Framework\TestCase
         }
 
         $expectedStack = [
-            ExceptionHandlerFirst::class,
-            ExceptionHandlerSecond::class,
             ExceptionHandlerThird::class,
+            ExceptionHandlerSecond::class,
+            ExceptionHandlerFirst::class,
         ];
 
         $this->assertEquals($expectedStack, $stack);