Class UnauthenticatedException
An exception that signals that authentication was required but missing.
This class cannot carry authentication challenge headers. This exception uses the 401 status code by default as this exception is used when the application has rejected a request but we do not know which authenticator the user should try.
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.
-
$headers protected
array<string, mixed>
Method Summary
-
__construct() public
Constructor
-
getAttributes() public
Get the passed in attributes
-
getHeaders() public
Returns array of response headers.
-
setHeader() public
Set a single HTTP response header.
-
setHeaders() public
Sets HTTP response headers.
Method Detail
__construct() ¶ public
__construct(string $message = '', int $code = 401, 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$message optional The exception message
-
int$code optional The exception code that will be used as a HTTP status code
-
Throwable|null$previous optional The previous exception or null
getHeaders() ¶ public
getHeaders(): array<string, mixed>Returns array of response headers.
Returns
array<string, mixed>setHeader() ¶ public
setHeader(string $header, list<string>|string|null $value = null): voidSet a single HTTP response header.
Parameters
-
string$header Header name
-
list<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