Class ForbiddenException
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 {@link \Cake\Http\Response::withHeader()}
-
$headers protected
array<string, mixed> -
$result protected
Authorization\Policy\ResultInterface|nullPolicy check result.
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.
-
getResult() public
Returns policy check result if passed to the exception.
-
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(Authorization\Policy\ResultInterface|null $result = null, string|array $message = '', int|null $code = null, Throwable|null $previous = null)Constructor
Parameters
-
Authorization\Policy\ResultInterface|null$result optional Policy check result.
-
string|array$message optional Either the string of the error message, or an array of attributes that are made available in the view, and sprintf()'d into Exception::$_messageTemplate
-
int|null$code optional The code of the error, is also the HTTP status code for the error.
-
Throwable|null$previous optional the previous exception.
getHeaders() ¶ public
getHeaders(): array<string, mixed>Returns array of response headers.
Returns
array<string, mixed>getResult() ¶ public
getResult(): Authorization\Policy\ResultInterface|nullReturns policy check result if passed to the exception.
Returns
Authorization\Policy\ResultInterface|nullresponseHeader() ¶ public
responseHeader(array|string|null $header = null, string|null $value = null): array|nullGet/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|nullsetHeader() ¶ public
setHeader(string $header, array<string>|string|null $value = null): voidSet a single HTTP response header.
Parameters
-
string$header Header name
-
array<string>|string|null$value optional Header value
Returns
voidsetHeaders() ¶ public
setHeaders(array<string, mixed> $headers): voidSets HTTP response headers.
Parameters
-
array<string, mixed>$headers Array of header name and value pairs.
Returns
voidProperty 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$_responseHeaders ¶ protected
Array of headers to be passed to {@link \Cake\Http\Response::withHeader()}
Type
array|null