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 {@link \Cake\Http\Response::withHeader()}
array<string, mixed>
Constructor
Add headers to be included in the response generated from this exception
Get the passed in attributes
Gets the Exception code.
Returns array of response headers.
Remove a header from the exception.
Get/set the response header to be used
Set a single HTTP response header.
Sets HTTP response headers.
__construct(string $target, int $code = 302, array $headers = [])
Constructor
Allows you to create exceptions that are treated as framework errors and disabled when debug mode is off.
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): $this
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(): array
Get the passed in attributes
array
getCode(): int
Gets the Exception code.
int
getHeaders(): array<string, mixed>
Returns array of response headers.
array<string, mixed>
removeHeader(string $key): $this
Remove a header from the exception.
string
$key The header to remove.
$this
responseHeader(array|string|null $header = null, string|null $value = null): array|null
Get/set the response header to be used
See also {@link \Cake\Http\Response::withHeader()}
array|string|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
setHeader(string $header, array<string>|string|null $value = null): void
Set a single HTTP response header.
string
$header Header name
array<string>|string|null
$value optional Header value
void
setHeaders(array<string, mixed> $headers): void
Sets HTTP response headers.
array<string, mixed>
$headers Array of header name and value pairs.
void
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 {@link \Cake\Http\Response::withHeader()}
array|null
array<string, mixed>
© 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.4/class-Cake.Http.Exception.RedirectException.html