Development

- Changed router so it supports both string and object as exception handlers.
- Added `Router::error($callback)` method to `Router` class (issue #238).
- Fixed issues calling `getController` and `getMethod` when callback is an object (issue #239).
- Updated documentation to reflect new changes.
- Added `addExceptionHandler` to `IGroupRoute` interface and `RouteGroup` class.
- Other minor bugfixes and optimisations.
This commit is contained in:
Simon Sessingø
2017-07-06 15:25:04 +02:00
parent 9dd80dd1d9
commit ca381d445f
12 changed files with 182 additions and 18 deletions
+23 -5
View File
@@ -51,8 +51,9 @@ If you want a great new feature or experience any issues what-so-ever, please fe
- [Middlewares](#middlewares) - [Middlewares](#middlewares)
- [Example](#example) - [Example](#example)
- [ExceptionHandler](#exceptionhandler) - [ExceptionHandlers](#exceptionhandlers)
- [Example](#example-1) - [Handling 404, 403 and other errors](#handling-404-403-and-other-errors)
- [Using custom exception handlers](#using-custom-exception-handlers)
- [Urls](#urls) - [Urls](#urls)
- [Get by name (single route)](#get-by-name-single-route) - [Get by name (single route)](#get-by-name-single-route)
@@ -626,13 +627,30 @@ class CustomMiddleware implements Middleware {
--- ---
# ExceptionHandler # ExceptionHandlers
ExceptionHandler are classes that handles all exceptions. ExceptionsHandlers must implement the `IExceptionHandler` interface. ExceptionHandler are classes that handles all exceptions. ExceptionsHandlers must implement the `IExceptionHandler` interface.
## Example ## Handling 404, 403 and other errors
Resource controllers can implement the `IRestController` interface, but is not required. If you simply want to catch a 404 (page not found) etc. you can use the `Router::error($callback)` static helper method.
This will add a callback method which is fired whenever an error occurs on all routes.
The basic example below simply redirect the page to `/not-found` if an `NotFoundHttpException` (404) occurred.
The code should be placed in the file that contains your routes.
```php
Router::get('/not-found', 'PageController@notFound');
Router::error(function(Request $request, \Exception $exception) {
if($exception instanceof NotFoundHttpException && $exception->getCode == 404) {
response()->redirect('/not-found');
}
});
```
## 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). 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).
@@ -0,0 +1,38 @@
<?php
namespace Pecee\Handlers;
use Pecee\Http\Request;
/**
* Class CallbackExceptionHandler
*
* Class is used to create callbacks which are fired when an exception is reached.
* This allows for easy handling 404-exception etc. without creating an custom ExceptionHandler.
*
* @package Pecee\Handlers
*/
class CallbackExceptionHandler implements IExceptionHandler
{
protected $callback;
public function __construct($callback)
{
$this->callback = $callback;
}
/**
* @param Request $request
* @param \Exception $error
* @return Request|null
*/
public function handleError(Request $request, \Exception $error)
{
/* Fire exceptions */
return call_user_func($this->callback,
$request,
$error
);
}
}
+1 -1
View File
@@ -8,7 +8,7 @@ use Pecee\SimpleRouter\SimpleRouter;
class Request class Request
{ {
protected $data = []; private $data = [];
protected $headers; protected $headers;
protected $host; protected $host;
protected $uri; protected $uri;
@@ -0,0 +1,7 @@
<?php
namespace Pecee\SimpleRouter\Exceptions;
class RouterException extends \Exception
{
}
@@ -1,6 +1,8 @@
<?php <?php
namespace Pecee\SimpleRouter\Route; namespace Pecee\SimpleRouter\Route;
use Pecee\Handlers\IExceptionHandler;
use Pecee\Http\Request; use Pecee\Http\Request;
interface IGroupRoute extends IRoute interface IGroupRoute extends IRoute
@@ -13,6 +15,14 @@ interface IGroupRoute extends IRoute
*/ */
public function matchDomain(Request $request); public function matchDomain(Request $request);
/**
* Add exception handler
*
* @param IExceptionHandler $handler
* @return static $this;
*/
public function addExceptionHandler(IExceptionHandler $handler);
/** /**
* Set exception-handlers for group * Set exception-handlers for group
* *
@@ -98,8 +98,10 @@ abstract class LoadableRoute extends Route implements ILoadableRoute
{ {
$url = $this->getUrl(); $url = $this->getUrl();
if ($this->getGroup() !== null && count($this->getGroup()->getDomains()) > 0) { $group = $this->getGroup();
$url = '//' . $this->getGroup()->getDomains()[0] . $url;
if ($group !== null && count($group->getDomains()) > 0) {
$url = '//' . $group->getDomains()[0] . $url;
} }
/* Contains parameters that aren't recognized and will be appended at the end of the url */ /* Contains parameters that aren't recognized and will be appended at the end of the url */
+3 -3
View File
@@ -168,7 +168,7 @@ abstract class Route implements IRoute
*/ */
public function getIdentifier() public function getIdentifier()
{ {
if (strpos($this->callback, '@') !== false) { if (is_string($this->callback) === true && strpos($this->callback, '@') !== false) {
return $this->callback; return $this->callback;
} }
@@ -265,7 +265,7 @@ abstract class Route implements IRoute
public function getMethod() public function getMethod()
{ {
if (strpos($this->callback, '@') !== false) { if (is_string($this->callback) === true && strpos($this->callback, '@') !== false) {
$tmp = explode('@', $this->callback); $tmp = explode('@', $this->callback);
return $tmp[1]; return $tmp[1];
@@ -276,7 +276,7 @@ abstract class Route implements IRoute
public function getClass() public function getClass()
{ {
if (strpos($this->callback, '@') !== false) { if (is_string($this->callback) === true && strpos($this->callback, '@') !== false) {
$tmp = explode('@', $this->callback); $tmp = explode('@', $this->callback);
return $tmp[0]; return $tmp[0];
@@ -74,8 +74,10 @@ class RouteController extends LoadableRoute implements IControllerRoute
$method .= '/'; $method .= '/';
} }
if ($this->getGroup() !== null && count($this->getGroup()->getDomains()) > 0) { $group = $this->getGroup();
$url .= '//' . $this->getGroup()->getDomains()[0];
if ($group !== null && count($group->getDomains()) > 0) {
$url .= '//' . $group->getDomains()[0];
} }
$url .= '/' . trim($this->getUrl(), '/') . '/' . strtolower($method) . join('/', $parameters); $url .= '/' . trim($this->getUrl(), '/') . '/' . strtolower($method) . join('/', $parameters);
@@ -1,6 +1,8 @@
<?php <?php
namespace Pecee\SimpleRouter\Route; namespace Pecee\SimpleRouter\Route;
use Pecee\Handlers\IExceptionHandler;
use Pecee\Http\Request; use Pecee\Http\Request;
class RouteGroup extends Route implements IGroupRoute class RouteGroup extends Route implements IGroupRoute
@@ -54,6 +56,19 @@ class RouteGroup extends Route implements IGroupRoute
return $this->matchDomain($request); return $this->matchDomain($request);
} }
/**
* Add exception handler
*
* @param IExceptionHandler $handler
* @return static $this
*/
public function addExceptionHandler(IExceptionHandler $handler)
{
$this->exceptionHandlers[] = $handler;
return $this;
}
/** /**
* Set exception-handlers for group * Set exception-handlers for group
* *
+22 -4
View File
@@ -1,4 +1,5 @@
<?php <?php
namespace Pecee\SimpleRouter; namespace Pecee\SimpleRouter;
use Pecee\Handlers\IExceptionHandler; use Pecee\Handlers\IExceptionHandler;
@@ -143,6 +144,7 @@ class Router
/* Add exception handlers */ /* Add exception handlers */
if (count($route->getExceptionHandlers()) > 0) { if (count($route->getExceptionHandlers()) > 0) {
/** @noinspection AdditionOperationOnArraysInspection */
$exceptionHandlers += $route->getExceptionHandlers(); $exceptionHandlers += $route->getExceptionHandlers();
} }
@@ -297,7 +299,10 @@ class Router
for ($i = 0; $i < $max; $i++) { for ($i = 0; $i < $max; $i++) {
$handler = $this->exceptionHandlers[$i]; $handler = $this->exceptionHandlers[$i];
$handler = new $handler();
if (is_object($handler) === false) {
$handler = new $handler();
}
if (($handler instanceof IExceptionHandler) === false) { if (($handler instanceof IExceptionHandler) === false) {
throw new HttpException('Exception handler must implement the IExceptionHandler interface.', 500); throw new HttpException('Exception handler must implement the IExceptionHandler interface.', 500);
@@ -372,7 +377,7 @@ class Router
} }
/* Using @ is most definitely a controller@method or alias@method */ /* Using @ is most definitely a controller@method or alias@method */
if (strpos($name, '@') !== false) { if (is_string($name) === true && strpos($name, '@') !== false) {
list($controller, $method) = array_map('strtolower', explode('@', $name)); list($controller, $method) = array_map('strtolower', explode('@', $name));
if ($controller === strtolower($route->getClass()) && $method === strtolower($route->getMethod())) { if ($controller === strtolower($route->getClass()) && $method === strtolower($route->getMethod())) {
@@ -381,7 +386,7 @@ class Router
} }
/* Check if callback matches (if it's not a function) */ /* Check if callback matches (if it's not a function) */
if (strpos($name, '@') !== false && strpos($route->getCallback(), '@') !== false && !is_callable($route->getCallback())) { if (is_string($name) === true && is_string($route->getCallback()) && strpos($name, '@') !== false && strpos($route->getCallback(), '@') !== false && is_callable($route->getCallback()) === false) {
/* Check if the entire callback is matching */ /* Check if the entire callback is matching */
if (strpos($route->getCallback(), $name) === 0 || strtolower($route->getCallback()) === strtolower($name)) { if (strpos($route->getCallback(), $name) === 0 || strtolower($route->getCallback()) === strtolower($name)) {
@@ -451,7 +456,7 @@ class Router
} }
/* Using @ is most definitely a controller@method or alias@method */ /* Using @ is most definitely a controller@method or alias@method */
if (strpos($name, '@') !== false) { if (is_string($name) === true && strpos($name, '@') !== false) {
list($controller, $method) = explode('@', $name); list($controller, $method) = explode('@', $name);
/* Loop through all the routes to see if we can find a match */ /* Loop through all the routes to see if we can find a match */
@@ -517,6 +522,19 @@ class Router
return $this->routes; return $this->routes;
} }
/**
* Set routes
*
* @param array $routes
* @return static $this
*/
public function setRoutes(array $routes)
{
$this->routes = $routes;
return $this;
}
/** /**
* Get current request * Get current request
* *
+28 -1
View File
@@ -7,8 +7,10 @@
* This class is added so calls can be made statically like Router::get() making the code look pretty. * This class is added so calls can be made statically like Router::get() making the code look pretty.
* It also adds some extra functionality like default-namespace. * It also adds some extra functionality like default-namespace.
*/ */
namespace Pecee\SimpleRouter; namespace Pecee\SimpleRouter;
use Pecee\Handlers\CallbackExceptionHandler;
use Pecee\Http\Middleware\BaseCsrfVerifier; use Pecee\Http\Middleware\BaseCsrfVerifier;
use Pecee\Http\Response; use Pecee\Http\Response;
use Pecee\SimpleRouter\Exceptions\HttpException; use Pecee\SimpleRouter\Exceptions\HttpException;
@@ -301,6 +303,31 @@ class SimpleRouter
return $route; return $route;
} }
/**
* Add exception callback handler.
*
* @param \Closure $callback
* @return CallbackExceptionHandler $callbackHandler
*/
public static function error($callback)
{
$routes = static::router()->getRoutes();
$callbackHandler = new CallbackExceptionHandler($callback);
$group = new RouteGroup();
$group->setCallback(function () {
});
$group->addExceptionHandler($callbackHandler);
array_unshift($routes, $group);
static::router()->setRoutes($routes);
return $callbackHandler;
}
/** /**
* Get url for a route by using either name/alias, class or method name. * Get url for a route by using either name/alias, class or method name.
* *
@@ -355,7 +382,7 @@ class SimpleRouter
*/ */
public static function router() public static function router()
{ {
if(static::$router === null) { if (static::$router === null) {
static::$router = new Router(); static::$router = new Router();
} }
@@ -0,0 +1,27 @@
<?php
require_once 'Dummy/DummyMiddleware.php';
require_once 'Dummy/DummyController.php';
require_once 'Dummy/Exceptions/ExceptionHandlerException.php';
require_once 'Helpers/TestRouter.php';
class RouterCallbackExceptionHandlerTest extends PHPUnit_Framework_TestCase
{
public function testCallbackExceptionHandler()
{
$this->setExpectedException(ExceptionHandlerException::class);
// Match normal route on alias
TestRouter::get('/my-new-url', 'DummyController@method2');
TestRouter::get('/my-url', 'DummyController@method1');
TestRouter::error(function (\Pecee\Http\Request $request, \Exception $exception) {
throw new ExceptionHandlerException();
});
TestRouter::debugNoReset('/404-url', 'get');
TestRouter::router()->reset();
}
}