Class CakeRedirectHandler
This handler will redirect the response if one of configured exception classes is encountered.
CakePHP Router compatible array URL syntax is supported.
Namespace: Authorization\Middleware\UnauthorizedHandler
Property Summary
-
$defaultOptions protected
arrayDefault config:
Method Summary
-
__construct() public
Constructor.
-
checkException() protected
Checks if an exception matches one of the classes.
-
getUrl() protected
Returns the url for the Location header.
-
handle() public
Handles the unauthorized request. The modified response should be returned.
Method Detail
__construct() ¶ public
__construct()Constructor.
Throws
RuntimeExceptionWhen `Cake\Routing\Router` class cannot be found.
checkException() ¶ protected
checkException(Authorization\Exception\Exception $exception, arrayException> $exceptions): boolChecks if an exception matches one of the classes.
Parameters
-
Authorization\Exception\Exception$exception Exception instance.
-
arrayException>$exceptions A list of exception classes.
Returns
boolgetUrl() ¶ protected
getUrl(Psr\Http\Message\ServerRequestInterface $request, array $options): stringReturns the url for the Location header.
Parameters
-
Psr\Http\Message\ServerRequestInterface$request -
array$options
Returns
stringhandle() ¶ public
handle(Authorization\Exception\Exception $exception, Psr\Http\Message\ServerRequestInterface $request, array $options = []): Psr\Http\Message\ResponseInterfaceHandles the unauthorized request. The modified response should be returned.
Return a response with a location header set if an exception matches.
Parameters
-
Authorization\Exception\Exception$exception -
Psr\Http\Message\ServerRequestInterface$request -
array$options optional
Returns
Psr\Http\Message\ResponseInterfaceProperty Detail
$defaultOptions ¶ protected
Default config:
exceptions- A list of exception classes.url- Url to redirect to.queryParam- Query parameter name for the target url.statusCode- Redirection status code.
Type
array