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