Docs4dev
Docs
cakephp / 4.4 / class-cake.http.exception.forbiddenexception.html

Class ForbiddenException

Represents an HTTP 403 error.

Namespace: Cake\Http\Exception

Property 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 {@link \Cake\Http\Response::withHeader()}

  • $headers protected
    array<string, mixed>

Method Summary

Method Detail

__construct() public

__construct(string|null $message = null, int|null $code = null, Throwable|null $previous = null)

Constructor

Allows you to create exceptions that are treated as framework errors and disabled when debug mode is off.

Parameters

string|null $message optional

If no message is given 'Forbidden' will be the message

int|null $code optional

Status code, defaults to 403

Throwable|null $previous optional

The previous exception.

getAttributes() public

getAttributes(): array

Get the passed in attributes

Returns

array

getCode() public @method

getCode(): int

Gets the Exception code.

Returns

int

getHeaders() public

getHeaders(): array<string, mixed>

Returns array of response headers.

Returns

array<string, mixed>

responseHeader() public

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

Parameters

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.

Returns

array|null

setHeader() public

setHeader(string $header, array<string>|string|null $value = null): void

Set a single HTTP response header.

Parameters

string $header

Header name

array<string>|string|null $value optional

Header value

Returns

void

setHeaders() public

setHeaders(array<string, mixed> $headers): void

Sets HTTP response headers.

Parameters

array<string, mixed> $headers

Array of header name and value pairs.

Returns

void

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 {@link \Cake\Http\Response::withHeader()}

Type

array|null

$headers protected

Type

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.ForbiddenException.html