Class AuthSecurityException
Auth Security exception - used when SecurityComponent detects any issue with the current request
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.
-
$_messageTemplate protected
string
Template string that has attributes sprintf()'ed into it.
-
$_reason protected
string
Reason for request blackhole
-
$_responseHeaders protected
array
Array of headers to be passed to Cake\Network\Response::header()
-
$_type protected
string
Security Exception type
Method Summary
-
__construct() public
Constructor
-
getAttributes() public
Get the passed in attributes
-
getReason() public
Get Reason
-
getType() public
Getter for type
-
responseHeader() public
Get/set the response header to be used
-
setMessage() public
Set Message
-
setReason() public
Set Reason
Method Detail
__construct() ¶ public
__construct(string|null $message = null, int $code = 400)
Constructor
Parameters
-
string|null
$message optional If no message is given 'Bad Request' will be the message
-
int
$code optional Status code, defaults to 400
responseHeader() ¶ public
responseHeader(string|array|null $header = null, string|null $value = null): array
Get/set the response header to be used
See also Cake\Network\Response::header()
Parameters
-
string|array|null
$header optional An array of header strings or a single header string
- an associative array of "header name" => "header value"
- an array of string headers is also accepted
-
string|null
$value optional The header value.
Returns
array
setMessage() ¶ public
setMessage(string $message): void
Set Message
Parameters
-
string
$message Exception message
Returns
void
setReason() ¶ public
setReason(string $reason = null): void
Set Reason
Parameters
-
string
$reason optional Reason details
Returns
void