Класс UnauthorizedException
Представляет ошибку HTTP 401.
Краткое описание свойств
- $_attributes protected
arrayМассив атрибутов, переданных из конструктора и доступных в представлении при отображении ошибки разработки.
- $_defaultCode protected
intЗначение кода исключения по умолчанию
- $_messageTemplate protected
stringШаблон строки сообщения с атрибутами, подставленными с помощью sprintf().
- $_responseHeaders protected
array|nullМассив заголовков, которые будут переданы в Cake\Http\Response::header()
- $headers protected
array
Краткое описание методов
-
__construct() public
Конструктор
-
getAttributes() public
Получение переданных атрибутов
-
getCode() public @method
Получение кода исключения.
-
getHeaders() public
Возвращает массив заголовков ответа.
-
responseHeader() public deprecated
Получение/установка используемого заголовка ответа
-
setHeader() public
Устанавливает отдельный заголовок HTTP ответа.
-
setHeaders() public
Установка заголовков HTTP ответа.
Подробное описание методов
__construct() public
__construct(string|null $message = null, int|null $code = null, Throwable|null $previous = null)
Конструктор
Позволяет создавать исключения, которые обрабатываются как ошибки фреймворка и отключаются при выключенном режиме отладки.
Параметры
-
string|null$message optional Если сообщение не задано, используется сообщение 'Неавторизован'
-
int|null$code optional Код состояния, по умолчанию 401
-
Throwable|null$previous optional Предыдущее исключение.
getAttributes() public
getAttributes(): array
Получение переданных атрибутов
Возвращает
arraygetCode() public @method
getCode(): int
Получение кода исключения.
Возвращает
intgetHeaders() public
getHeaders(): array
Возвращает массив заголовков ответа.
Возвращает
arrayresponseHeader() public
responseHeader(string|array|null $header = null, string|null $value = null): array|null
Получение/установка используемого заголовка ответа
См. также Cake\Http\Response::withHeader()
Параметры
-
string|array|null$header optional Строка одного заголовка или ассоциативный массив "имя_заголовка" => "значение_заголовка"
-
string|null$value optional Значение заголовка.
Возвращает
array|nullsetHeader() public
setHeader(string $header, string|string[]|null $value = null): void
Устанавливает отдельный заголовок HTTP ответа.
Параметры
-
string$header Имя заголовка
-
string|string[]|null$value optional Значение заголовка
Возвращает
voidsetHeaders() public
setHeaders(array $headers): void
Установка заголовков HTTP ответа.
Параметры
-
array$headers Массив пар "имя_заголовка" и "значение_заголовка".
Возвращает
voidПодробное описание свойств
$_attributes protected
Массив атрибутов, переданных из конструктора и доступных в представлении при отображении ошибки разработки.
Тип
array$_defaultCode protected
Значение кода исключения по умолчанию
Тип
int$_messageTemplate protected
Шаблон строки сообщения с атрибутами, подставленными с помощью sprintf().
Тип
string$_responseHeaders protected
Массив заголовков, которые будут переданы в Cake\Http\Response::header()
Тип
array|null$headers protected
Тип
array
© 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.2/class-Cake.Http.Exception.UnauthorizedException.html
