Merge pull request #575 from skipperbent/v4-development

Updated documentation

README.md

@@ -791,7 +791,7 @@ If you want to store the token elsewhere, please refer to the "Creating custom T
 When you've created your CSRF-verifier you need to tell simple-php-router that it should use it. You can do this by adding the following line in your `routes.php` file:
 
 ```php
-Router::csrfVerifier(new \Demo\Middlewares\CsrfVerifier());
+SimpleRouter::csrfVerifier(new \Demo\Middlewares\CsrfVerifier());
 ```
 
 ## Getting CSRF-token
@@ -807,7 +807,7 @@ csrf_token();
 You can also get the token directly:
 
 ```php
-return Router::router()->getCsrfVerifier()->getTokenProvider()->getToken();
+return SimpleRouter::router()->getCsrfVerifier()->getTokenProvider()->getToken();
 ```
 
 The default name/key for the input-field is `csrf_token` and is defined in the `POST_KEY` constant in the `BaseCsrfVerifier` class.
@@ -893,10 +893,10 @@ class SessionTokenProvider implements ITokenProvider
 Next you need to set your custom `ITokenProvider` implementation on your `BaseCsrfVerifier` class in your routes file:
 
 ```php
-$verifier = new \dscuz\Middleware\CsrfVerifier();
+$verifier = new \Demo\Middlewares\CsrfVerifier();
 $verifier->setTokenProvider(new SessionTokenProvider());
 
-Router::csrfVerifier($verifier);
+SimpleRouter::csrfVerifier($verifier);
 ```
 
 ---
@@ -938,7 +938,7 @@ ExceptionHandler are classes that handles all exceptions. ExceptionsHandlers mus
 
 ## Handling 404, 403 and other errors
 
-If you simply want to catch a 404 (page not found) etc. you can use the `Router::error($callback)` static helper method.
+If you simply want to catch a 404 (page not found) etc. you can use the `SimpleRouter::error($callback)` static helper method.
 
 This will add a callback method which is fired whenever an error occurs on all routes.
 
@@ -946,17 +946,31 @@ The basic example below simply redirect the page to `/not-found` if an `NotFound
 The code should be placed in the file that contains your routes.
 
 ```php
-Router::get('/not-found', 'PageController@notFound');
+SimpleRouter::get('/not-found', 'PageController@notFound');
+SimpleRouter::get('/forbidden', 'PageController@notFound');
 
-Router::error(function(Request $request, \Exception $exception) {
+SimpleRouter::error(function(Request $request, \Exception $exception) {
 
-    if($exception instanceof NotFoundHttpException && $exception->getCode() === 404) {
-        response()->redirect('/not-found');
+    switch($exception->getCode()) {
+        // Page not found
+        case 404:
+            response()->redirect('/not-found');
+        // Forbidden
+        case 403:
+            response()->redirect('/forbidden');
     }
     
 });
 ```
 
+The example above will redirect all errors with http-code `404` (page not found) to `/not-found` and `403` (forbidden) to `/forbidden`.
+
+If you do not want a redirect, but want the error-page rendered on the current-url, you can tell the router to execute a rewrite callback like so:
+
+```php
+$request->setRewriteCallback('ErrorController@notFound');
+```
+
 ## Using custom exception handlers
 
 This is a basic example of an ExceptionHandler implementation (please see "[Easily overwrite route about to be loaded](#easily-overwrite-route-about-to-be-loaded)" for examples on how to change callback).
@@ -1297,7 +1311,7 @@ All event callbacks will retrieve a `EventArgument` object as parameter. This ob
 | `EVENT_RENDER_BOOTMANAGER`  | `bootmanagers`<br>`bootmanager` | Fires before a boot-manager is rendered. |
 | `EVENT_LOAD_ROUTES`         | `routes` | Fires when the router is about to load all routes. |
 | `EVENT_FIND_ROUTE`          | `name` | Fires whenever the `findRoute` method is called within the `Router`. This usually happens when the router tries to find routes that contains a certain url, usually after the `EventHandler::EVENT_GET_URL` event. |
-| `EVENT_GET_URL`             | `name`<br>`parameters`<br>`getParams` | Fires whenever the `Router::getUrl` method or `url`-helper function is called and the router tries to find the route. |
+| `EVENT_GET_URL`             | `name`<br>`parameters`<br>`getParams` | Fires whenever the `SimpleRouter::getUrl` method or `url`-helper function is called and the router tries to find the route. |
 | `EVENT_MATCH_ROUTE`         | `route` | Fires when a route is matched and valid (correct request-type etc). and before the route is rendered. |
 | `EVENT_RENDER_ROUTE`        | `route` | Fires before a route is rendered. |
 | `EVENT_LOAD_EXCEPTIONS`     | `exception`<br>`exceptionHandlers` | Fires when the router is loading exception-handlers. |
@@ -1480,7 +1494,7 @@ $eventHandler->register(EventHandler::EVENT_ADD_ROUTE, function(EventArgument $e
 	
 });
 
-TestRouter::addEventHandler($eventHandler);
+SimpleRouter::addEventHandler($eventHandler);
 ```
 
 In the example shown above, we create a new `EVENT_ADD_ROUTE` event that triggers, when a new route is added.

src/Pecee/Http/Input/InputFile.php

@@ -6,12 +6,39 @@ use Pecee\Exceptions\InvalidArgumentException;
 
 class InputFile implements IInputItem
 {
+    /**
+     * @var string
+     */
     public $index;
+
+    /**
+     * @var string
+     */
     public $name;
+
+    /**
+     * @var string|null
+     */
     public $filename;
+
+    /**
+     * @var int|null
+     */
     public $size;
+
+    /**
+     * @var int|null
+     */
     public $type;
+
+    /**
+     * @var int
+     */
     public $errors;
+
+    /**
+     * @var string|null
+     */
     public $tmpName;
 
     public function __construct(string $index)

src/Pecee/Http/Middleware/BaseCsrfVerifier.php

@@ -18,11 +18,16 @@ class BaseCsrfVerifier implements IMiddleware
      * @var array|null
      */
     protected $except;
+
     /**
      * Urls to include. Can be used to include urls from a certain path.
      * @var array|null
      */
     protected $include;
+
+    /**
+     * @var ITokenProvider
+     */
     protected $tokenProvider;
 
     /**

src/Pecee/Http/Security/CookieTokenProvider.php

@@ -9,7 +9,14 @@ class CookieTokenProvider implements ITokenProvider
 {
     public const CSRF_KEY = 'CSRF-TOKEN';
 
+    /**
+     * @var string
+     */
     protected $token;
+
+    /**
+     * @var int
+     */
     protected $cookieTimeoutMinutes = 120;
 
     /**

src/Pecee/Http/Url.php

@@ -7,15 +7,49 @@ use Pecee\Http\Exceptions\MalformedUrlException;
 
 class Url implements JsonSerializable
 {
+    /**
+     * @var string|null
+     */
     private $originalUrl;
 
+    /**
+     * @var string|null
+     */
     private $scheme;
+
+    /**
+     * @var string|null
+     */
     private $host;
+
+    /**
+     * @var int|null
+     */
     private $port;
+
+    /**
+     * @var string|null
+     */
     private $username;
+
+    /**
+     * @var string|null
+     */
     private $password;
+
+    /**
+     * @var string|null
+     */
     private $path;
+
+    /**
+     * @var array
+     */
     private $params = [];
+
+    /**
+     * @var string|null
+     */
     private $fragment;
 
     /**

src/Pecee/SimpleRouter/Event/EventArgument.php

@@ -24,7 +24,7 @@ class EventArgument implements IEventArgument
      */
     protected $arguments = [];
 
-    public function __construct($eventName, $router, array $arguments = [])
+    public function __construct(string $eventName, Router $router, array $arguments = [])
     {
         $this->eventName = $eventName;
         $this->router = $router;
@@ -94,7 +94,7 @@ class EventArgument implements IEventArgument
      * @param mixed $value
      * @throws InvalidArgumentException
      */
-    public function __set(string $name, $value)
+    public function __set(string $name, $value): void
     {
         throw new InvalidArgumentException('Not supported');
     }

src/Pecee/SimpleRouter/Exceptions/ClassNotFoundHttpException.php

@@ -6,10 +6,17 @@ use Throwable;
 
 class ClassNotFoundHttpException extends NotFoundHttpException
 {
+    /**
+     * @var string
+     */
     protected $class;
+
+    /**
+     * @var string|null
+     */
     protected $method;
 
-    public function __construct(string $class, ?string $method = null, $message = "", $code = 0, Throwable $previous = null)
+    public function __construct(string $class, ?string $method = null, string $message = "", int $code = 0, Throwable $previous = null)
     {
         parent::__construct($message, $code, $previous);
 

src/Pecee/SimpleRouter/Handlers/CallbackExceptionHandler.php

@@ -17,6 +17,9 @@ use Pecee\Http\Request;
 class CallbackExceptionHandler implements IExceptionHandler
 {
 
+    /**
+     * @var Closure
+     */
     protected $callback;
 
     public function __construct(Closure $callback)

src/Pecee/SimpleRouter/Handlers/DebugEventHandler.php

@@ -47,7 +47,7 @@ class DebugEventHandler implements IEventHandler
     public function fireEvents(Router $router, string $name, array $eventArgs = []): void
     {
         $callback = $this->callback;
-        $callback(new EventArgument($router, $eventArgs));
+        $callback(new EventArgument($name, $router, $eventArgs));
     }
 
     /**

src/Pecee/SimpleRouter/Route/LoadableRoute.php

@@ -19,6 +19,9 @@ abstract class LoadableRoute extends Route implements ILoadableRoute
      */
     protected $name;
 
+    /**
+     * @var string|null
+     */
     protected $regex;
 
     /**
@@ -59,7 +62,14 @@ abstract class LoadableRoute extends Route implements ILoadableRoute
             return null;
         }
 
-        return ((bool)preg_match($this->regex, $url) !== false);
+        $parameters = [];
+        if ((bool)preg_match($this->regex, $url, $parameters) !== false) {
+            $this->setParameters($parameters);
+
+            return true;
+        }
+
+        return false;
     }
 
     /**

src/Pecee/SimpleRouter/Route/RouteUrl.php

@@ -6,7 +6,12 @@ use Pecee\Http\Request;
 
 class RouteUrl extends LoadableRoute
 {
-    public function __construct($url, $callback)
+    /**
+     * RouteUrl constructor.
+     * @param string $url
+     * @param \Closure|string $callback
+     */
+    public function __construct(string $url, $callback)
     {
         $this->setUrl($url);
         $this->setCallback($callback);

tests/Pecee/SimpleRouter/RouterUrlTest.php

@@ -181,6 +181,22 @@ class RouterUrlTest extends \PHPUnit\Framework\TestCase
 
         $output = TestRouter::debugOutput('/admin/asd/bec/123', 'get');
         $this->assertEquals('match', $output);
+
+        TestRouter::router()->reset();
+    }
+
+    public function testCustomRegexWithParameter()
+    {
+        TestRouter::request()->setHost('google.com');
+
+        $results = '';
+
+        TestRouter::get('/tester/{param}', function ($param = null) use($results) {
+            return $results = $param;
+        })->setMatch('/(.*)/i');
+
+        $output = TestRouter::debugOutput('/tester/abepik/ko');
+        $this->assertEquals('/tester/abepik/ko/', $output);
     }
 
     public function testRenderMultipleRoutesDisabled()

tests/TestRouter.php

@@ -8,7 +8,7 @@ class TestRouter extends \Pecee\SimpleRouter\SimpleRouter
         static::request()->setHost('testhost.com');
     }
 
-    public static function debugNoReset($testUrl, $testMethod = 'get')
+    public static function debugNoReset(string $testUrl, string $testMethod = 'get'): void
     {
         $request = static::request();
 
@@ -18,7 +18,7 @@ class TestRouter extends \Pecee\SimpleRouter\SimpleRouter
         static::start();
     }
 
-    public static function debug($testUrl, $testMethod = 'get', bool $reset = true)
+    public static function debug(string $testUrl, string $testMethod = 'get', bool $reset = true): void
     {
         try {
             static::debugNoReset($testUrl, $testMethod);
@@ -35,7 +35,7 @@ class TestRouter extends \Pecee\SimpleRouter\SimpleRouter
 
     }
 
-    public static function debugOutput($testUrl, $testMethod = 'get', bool $reset = true)
+    public static function debugOutput(string $testUrl, string $testMethod = 'get', bool $reset = true): string
     {
         $response = null;