Class RedirectException

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.

Namespace: Cake\Http\Exception

Properties summary

  • $_attributes protected
    array

    Array of attributes that are passed in from the constructor, and made available in the view when a development error is displayed.

  • $_defaultCode protected
    int

    Default exception code

  • $_messageTemplate protected
    string

    Template string that has attributes sprintf()'ed into it.

  • $_responseHeaders protected
    array|null

    Array of headers to be passed to Cake\Http\Response::header()

  • $headers protected
    array

    Headers to include in the response.

Method Summary

Method Detail

__construct() public 

__construct(string $target, int $code, array $headers)

Constructor

Parameters

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() public 

addHeaders(array $headers)

Add headers to be included in the response generated from this exception

Parameters

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.

Returns

$this

getAttributes() public 

getAttributes()

Get the passed in attributes

Returns

array

getCode() public 

getCode()

Gets the Exception code.

getHeaders() public 

getHeaders()

Get the headers from the exception.

Returns

array

removeHeader() public 

removeHeader(string $key)

Remove a header from the exception.

Parameters

string $key

The header to remove.

Returns

$this

responseHeader() public 

responseHeader(mixed $header, mixed $value)

Get/set the response header to be used

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

Parameters

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.

Returns

array|null

Property Detail

$_attributes protected

Array of attributes that are passed in from the constructor, and made available in the view when a development error is displayed.

Type

array

$_defaultCode protected

Default exception code

Type

int

$_messageTemplate protected

Template string that has attributes sprintf()'ed into it.

Type

string

$_responseHeaders protected

Array of headers to be passed to Cake\Http\Response::header()

Type

array|null

$headers protected

Headers to include in the response.

Type

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