Class ForbiddenException
Represents an HTTP 403 error.
Property Summary
-
$_attributes protected
arrayArray of attributes that are passed in from the constructor, and made available in the view when a development error is displayed.
-
$_defaultCode protected
intDefault exception code
-
$_messageTemplate protected
stringTemplate string that has attributes sprintf()'ed into it.
-
$_responseHeaders protected
array|nullArray of headers to be passed to Cake\Http\Response::header()
-
$headers protected
array
Method Summary
-
__construct() public
Constructor
-
getAttributes() public
Get the passed in attributes
-
getCode() public @method
Gets the Exception code.
-
getHeaders() public
Returns array of response headers.
-
responseHeader() public deprecated
Get/set the response header to be used
-
setHeader() public
Set a single HTTP response header.
-
setHeaders() public
Sets HTTP response headers.
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.
responseHeader() ¶ public
responseHeader(string|array|null $header = null, string|null $value = null): array|nullGet/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|nullsetHeader() ¶ public
setHeader(string $header, string|string[]|null $value = null): voidSet a single HTTP response header.
Parameters
-
string$header Header name
-
string|string[]|null$value optional Header value
Returns
voidsetHeaders() ¶ public
setHeaders(array $headers): voidSets HTTP response headers.
Parameters
-
array$headers Array of header name and value pairs.
Returns
void