Class RedirectException

An exception subclass used by the routing layer to indicate that a route has resolved to a redirect.

The URL and status code are provided as constructor arguments.

throw new RedirectException('http://example.com/some/path', 301);
Exception implements Throwable
Extended by RuntimeException
Extended by Cake\Core\Exception\Exception
Extended by Cake\Routing\Exception\RedirectException

Properties summary

Inherited Properties

Methods inherited from Cake\Core\Exception\Exception

__construct()source public

__construct( string|array $message , integer|null $code null , Exception|null $previous null )

Constructor.

Allows you to create exceptions that are treated as framework errors and disabled when debug = 0.

Parameters

string|array $message

Either the string of the error message, or an array of attributes that are made available in the view, and sprintf()'d into Exception::$_messageTemplate

integer|null $code optional null
The code of the error, is also the HTTP status code for the error.
Exception|null $previous optional null
the previous exception.

Overrides

Exception::__construct()

getAttributes()source public

getAttributes( )

Get the passed in attributes

Returns

array

responseHeader()source public

responseHeader( string|array|null $header null , string|null $value null )

Get/set the response header to be used

See also Cake\Http\Response::header()

Parameters

string|array|null $header optional null

An array of header strings or a single header string - an associative array of "header name" => "header value" - an array of string headers is also accepted

string|null $value optional null
The header value.

Returns

array

Properties detail

$_defaultCodesource

protected integer

Default exception code

302

© 2005–2017 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.4/class-Cake.Routing.Exception.RedirectException.html