class AuthenticationRequiredException extends Exception (View source)

An "AccessDenied" Exception

Properties

protected string $referenceCode from  Exception
protected int $statusCode
protected ActionRequest $interceptedRequest

Methods

string
getReferenceCode()

Returns a code which can be communicated publicly so that whoever experiences the exception can refer to it and a developer can find more information about it in the system log.

int
getStatusCode()

Returns the HTTP status code this exception corresponds to (defaults to 500).

attachInterceptedRequest(ActionRequest $actionRequest)

Attach the given action request as intercepted request and return self.

bool
hasInterceptedRequest()

No description

ActionRequest|null
getInterceptedRequest()

No description

Details

string getReferenceCode()

Returns a code which can be communicated publicly so that whoever experiences the exception can refer to it and a developer can find more information about it in the system log.

Return Value

string

int getStatusCode()

Returns the HTTP status code this exception corresponds to (defaults to 500).

Return Value

int

AuthenticationRequiredException attachInterceptedRequest(ActionRequest $actionRequest)

Attach the given action request as intercepted request and return self.

Parameters

ActionRequest $actionRequest

Return Value

AuthenticationRequiredException

bool hasInterceptedRequest()

No description

Return Value

bool

True if this instance has an intercepted ActionRequest attached

ActionRequest|null getInterceptedRequest()

No description

Return Value

ActionRequest|null

The attached intercepted ActionRequest or null