W3cubDocs

/CakePHP 3.8

Class UnauthorizedException

Represents an HTTP 401 error.

Exception implements Throwable
Extended by RuntimeException
Extended by Cake\Core\Exception\Exception
Extended by Cake\Http\Exception\HttpException
Extended by Cake\Http\Exception\UnauthorizedException
Namespace: Cake\Http\Exception
Location: Http/Exception/UnauthorizedException.php

Properties summary

Inherited Properties

Method Summary

Method Detail

__construct()source public 

__construct( string|null $message = null , integer $code = null , Exception|null $previous = null )

Constructor

Parameters

string|null $message optional null
If no message is given 'Unauthorized' will be the message
integer $code optional null
Status code, defaults to 401
Exception|null $previous optional null
The previous exception.

Overrides

Cake\Core\Exception\Exception::__construct()

Methods inherited from Cake\Core\Exception\Exception

getAttributes()source public 

getAttributes( )

Get the passed in attributes

Returns

array

responseHeader()source public 

responseHeader( string|array|null $header = null , string|null $value = null )

Get/set the response header to be used

See also Cake\Http\Response::withHeader()

Parameters

string|array|null $header optional null

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 (deprecated)

string|null $value optional null
The header value.

Returns

array

Properties detail

$_defaultCodesource

protected integer

Default exception code

401

© 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/3.8/class-Cake.Http.Exception.UnauthorizedException.html