Класс AuthSecurityException
Исключение Auth Security — используется, когда SecurityComponent обнаруживает проблемы с текущим запросом
Краткое описание свойств
- $_attributes protected
arrayМассив атрибутов, переданных из конструктора, доступных в представлении при отображении ошибки разработки.
- $_defaultCode protected
intКод исключения по умолчанию
- $_messageTemplate protected
stringШаблон строки сообщения, в который подставляются атрибуты с помощью sprintf().
- $_reason protected
string|nullПричина блокировки запроса
- $_responseHeaders protected
array|nullМассив заголовков, которые будут переданы в Cake\Http\Response::header()
- $_type protected
stringТип исключения Security
- $headers protected
array
Краткое описание методов
-
__construct() public
Конструктор
-
getAttributes() public
Получить переданные атрибуты
-
getCode() public @method
Получить код исключения.
-
getHeaders() public
Возвращает массив заголовков ответа.
-
getReason() public
Получить причину
-
getType() public
Получить тип
-
responseHeader() public deprecated
Получить/установить используемый заголовок ответа
-
setHeader() public
Установить отдельный заголовок HTTP ответа.
-
setHeaders() public
Устанавливает заголовки HTTP ответа.
-
setMessage() public
Установить сообщение
-
setReason() public
Установить причину
Подробное описание методов
__construct() public
__construct(string|null $message = null, int|null $code = null, Throwable|null $previous = null)
Конструктор
Позволяет создавать исключения, которые обрабатываются как ошибки фреймворка и отключаются, когда режим отладки выключен.
Параметры
-
string|null$message optional Если сообщение не задано, будет использовано 'Bad Request'
-
int|null$code optional Код статуса, по умолчанию 400
-
Throwable|null$previous optional Предыдущее исключение.
getAttributes() public
getAttributes(): array
Получить переданные атрибуты
Возвращает
arraygetCode() public @method
getCode(): int
Получить код исключения.
Возвращает
intgetHeaders() public
getHeaders(): array
Возвращает массив заголовков ответа.
Возвращает
arraygetReason() public
getReason(): string|null
Получить причину
Возвращает
string|nullgetType() public
getType(): string
Получить тип
Возвращает
stringresponseHeader() 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 Массив пар имя-значение заголовков.
Возвращает
voidsetMessage() public
setMessage(string $message): void
Установить сообщение
Параметры
-
string$message Сообщение исключения
Возвращает
voidsetReason() public
setReason(string|null $reason = null): $this
Установить причину
Параметры
-
string|null$reason optional Подробности причины
Возвращает
$thisПодробное описание свойств
$_attributes protected
Массив атрибутов, переданных из конструктора, доступных в представлении при отображении ошибки разработки.
Тип
array$_defaultCode protected
Код исключения по умолчанию
Тип
int$_messageTemplate protected
Шаблонная строка с атрибутами, вставленными с помощью sprintf().
Тип
string$_reason protected
Причина блокировки запроса
Тип
string|null$_responseHeaders protected
Массив заголовков, передаваемых в Cake\Http\Response::header()
Тип
array|null$_type protected
Тип исключения безопасности
Тип
string$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.Controller.Exception.AuthSecurityException.html
