Класс HttpException
Базовый класс для всех исключений, связанных с HTTP в CakePHP. Все исключения, связанные со статусом/ошибкой HTTP, должны расширять этот класс, чтобы блоки catch можно было типизировать.
Вы также можете использовать его как значимый мост к 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Массив заголовков, которые будут переданы в 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|array $message = '', int|null $code = null, Throwable|null $previous = null)
Конструктор.
Позволяет создавать исключения, которые обрабатываются как ошибки фреймворка и отключаются, когда режим отладки выключен.
Параметры
-
string|array$message optional Строка сообщения об ошибке или массив атрибутов, которые доступны в представлении, и sprintf()'ed в Exception::$_messageTemplate
-
int|null$code optional Код ошибки
-
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.HttpException.html
