An exception subclass used by routing and application code to trigger a redirect.
The URL and status code are provided as constructor arguments.
throw new RedirectException('http://example.com/some/path', 301);
Additional headers can also be provided in the constructor, or using the addHeaders() method.
array
Array of attributes that are passed in from the constructor, and made available in the view when a development error is displayed.
int
Default exception code
string
Template string that has attributes sprintf()'ed into it.
array|null
Array of headers to be passed to Cake\Http\Response::header()
array
Headers to include in the response.
__construct(string $target, int $code, array $headers)
Constructor
string
$target The URL to redirect to.
int
$code optional The exception code that will be used as a HTTP status code
array
$headers optional The headers that should be sent in the unauthorized challenge response.
addHeaders(array $headers)
Add headers to be included in the response generated from this exception
array
$headers An array of header => value
to append to the exception. If a header already exists, the new values will be appended to the existing ones.
$this
getAttributes()
Get the passed in attributes
array
getCode()
Gets the Exception code.
getHeaders()
Get the headers from the exception.
array
removeHeader(string $key)
Remove a header from the exception.
string
$key The header to remove.
$this
responseHeader(mixed $header, mixed $value)
Get/set the response header to be used
See also Cake\Http\Response::withHeader()
string|array|null
$header optional A single header string or an associative array of "header name" => "header value"
string|null
$value optional The header value.
array|null
Array of attributes that are passed in from the constructor, and made available in the view when a development error is displayed.
array
Default exception code
int
Template string that has attributes sprintf()'ed into it.
string
Array of headers to be passed to Cake\Http\Response::header()
array|null
Headers to include in the response.
array
© 2005–present 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/4.1/class-Cake.Http.Exception.RedirectException.html