Класс RedirectException
Подкласс исключений, используемый кодом маршрутизации и приложения для перенаправления.
URL и код состояния передаются в качестве аргументов конструктора.
throw new RedirectException('http://example.com/some/path', 301); Дополнительные заголовки также можно указать в конструкторе или с помощью метода addHeaders().
Краткое описание свойств
- $_attributes protected
arrayМассив атрибутов, переданных из конструктора и доступных в представлении при отображении ошибки разработки.
- $_defaultCode protected
intЗначение кода исключения по умолчанию
- $_messageTemplate protected
stringШаблонная строка, в которую атрибуты подставляются с помощью sprintf().
- $_responseHeaders protected
array|nullМассив заголовков, передаваемых в {@link \Cake\Http\Response::withHeader()}
- $headers protected
array
Краткое описание методов
-
__construct() public
Конструктор
-
addHeaders() public deprecated
Добавить заголовки, которые будут включены в ответ, сгенерированный из этого исключения
-
getAttributes() public
Получить переданные атрибуты
-
getCode() public @method
Возвращает код исключения.
-
getHeaders() public
Возвращает массив заголовков ответа.
-
removeHeader() public deprecated
Удалить заголовок из исключения.
-
responseHeader() public deprecated
Получить/установить заголовок ответа, который будет использоваться
-
setHeader() public
Установить отдельный заголовок HTTP ответа.
-
setHeaders() public
Устанавливает заголовки HTTP ответа.
Подробное описание методов
__construct() public
__construct(string $target, int $code = 302, array $headers = [])
Конструктор
Позволяет создавать исключения, которые обрабатываются как ошибки фреймворка и отключаются при выключенном режиме отладки.
Параметры
-
string$target URL для перенаправления.
-
int$code optional Код исключения, который будет использован как код HTTP состояния.
-
array$headers optional Заголовки, которые должны быть отправлены в ответе.
addHeaders() public
addHeaders(array $headers): $this
Добавить заголовки, которые будут включены в ответ, сгенерированный из этого исключения
Параметры
-
array$headers Массив
header => valueдля добавления к исключению. Если заголовок уже существует, новые значения будут добавлены к существующим.
Возвращает
$thisgetAttributes() public
getAttributes(): array
Получить переданные атрибуты
Возвращает
arraygetCode() public @method
getCode(): int
Возвращает код исключения.
Возвращает
intgetHeaders() public
getHeaders(): array
Возвращает массив заголовков ответа.
Возвращает
arrayremoveHeader() public
removeHeader(string $key): $this
Удалить заголовок из исключения.
Параметры
-
string$key Заголовок для удаления.
Возвращает
$thisresponseHeader() 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 $headers): void
Устанавливает заголовки HTTP ответа.
Параметры
-
array$headers Массив пар имя-значение заголовка.
Возвращает
voidПодробное описание свойств
$_attributes protected
Массив атрибутов, переданных из конструктора и доступных в представлении при отображении ошибки разработки.
Тип
array$_defaultCode protected
Значение кода исключения по умолчанию
Тип
int$_messageTemplate protected
Шаблонная строка, в которую атрибуты подставляются с помощью sprintf().
Тип
string$_responseHeaders protected
Массив заголовков, передаваемых в {@link \Cake\Http\Response::withHeader()}
Тип
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.3/class-Cake.Http.Exception.RedirectException.html
