W3cubDocs

/CakePHP 4.1

Class AuthSecurityException

Auth Security exception - used when SecurityComponent detects any issue with the current request

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.

  • $_reason protected
    string|null

    Reason for request blackhole

  • $_responseHeaders protected
    array|null

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

  • $_type protected
    string

    Security Exception type

Method Summary

Method Detail

__construct() public

__construct(?string $message, ?int $code, ?\Throwable $previous)

Constructor

Parameters

string|null $message optional

If no message is given 'Bad Request' will be the message

int|null $code optional

Status code, defaults to 400

\Throwable|null $previous optional

The previous exception.

getAttributes() public

getAttributes()

Get the passed in attributes

Returns

array

getCode() public

getCode()

Gets the Exception code.

getReason() public

getReason()

Get Reason

Returns

string|null

getType() public

getType()

Getter for type

Returns

string

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

setMessage() public

setMessage(string $message)

Set Message

Parameters

string $message

Exception message

setReason() public

setReason(?string $reason)

Set Reason

Parameters

string|null $reason optional

Reason details

Returns

$this

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

$_reason protected

Reason for request blackhole

Type

string|null

$_responseHeaders protected

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

Type

array|null

$_type protected

Security Exception type

Type

string

© 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.Controller.Exception.AuthSecurityException.html