Класс 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Массив заголовков, передаваемых методу Cake\Http\Response::header()
- $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(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.RedirectException.html
