Класс RedirectRoute
Маршрут перенаправления выполнит немедленное перенаправление. Маршруты перенаправления полезны, когда вы хотите, чтобы перенаправления уровня маршрутизации происходили в вашем приложении, например, при перемещении URL-адресов.
Перенаправление сигнализируется исключением, которое останавливает сопоставление маршрутов и определяет URL-адрес перенаправления и код состояния.
- Cake\Routing\Route\Route
-
Cake\Routing\Route\RedirectRoute
Краткое описание свойств
-
$redirectpublicМесто перенаправления. Строка или CakePHP массив URL.array|string - Объект Response
$responsepublic
Унаследованные свойства
Краткое описание методов
- __construct() publicКонструктор
- match() publicОбратного маршрутизации перенаправления нет.
- parse() public
Парсит строковый URL в массив. Парсинг URL приводит к автоматическому перенаправлению.
Подробное описание методов
__construct()source public
__construct( string $template , array|string $defaults [] , array $options [] )
Конструктор
Параметры
- строка
$template - Шаблонная строка с заполнительными параметрами
- массив|строка
$defaultsнеобязательно [] - Значения по умолчанию для маршрута.
- массив
$optionsнеобязательно [] - Массив дополнительных опций для маршрута
Переопределяет
Cake\Routing\Route\Route::__construct() match()source public
match( array $url , array $context [] )
Обратного маршрутизации перенаправления нет.
Параметры
- массив
$url - Массив параметров для преобразования в строку.
- массив
$contextнеобязательно [] - Массив параметров контекста запроса.
Возвращает
booleanВсегда false.
Переопределяет
Cake\Routing\Route\Route::match() parse()source public
parse( string $url , string $method '' )
Парсит строковый URL в массив. Парсинг URL приводит к автоматическому перенаправлению.
Параметры
- строка
$url - URL для парсинга.
- строка
$methodнеобязательно '' - HTTP-метод, используемый.
Возвращает
false|nullFalse при ошибке. При успешном сопоставлении генерируется исключение.
Выбрасывает
Cake\Routing\Exception\RedirectExceptionИсключение генерируется при успешном сопоставлении. Это используется для остановки сопоставления маршрутов и сигнализации посреднику о необходимости перенаправления.
Переопределяет
Cake\Routing\Route\Route::parse() Методы, унаследованные от Cake\Routing\Route\Route
__set_state()source public static
__set_state( array $fields )
Магический метод установки состояния для поддержки var_export
Этот метод помогает приложениям, которые хотят реализовать кэширование маршрутизатора.
Параметры
- массив
$fields - Ключи/Значения атрибутов объекта
Возвращает
Cake\Routing\Route\RouteНовый экземпляр маршрута
_matchMethod()source protected
_matchMethod( array $url )
Проверка соответствия HTTP-метода URL.
Параметры
- массив
$url - Массив для генерируемого URL.
Возвращает
boolean_parseArgs()source protected
_parseArgs( string $args , string $context )
Разбор переданных параметров в список переданных аргументов.
Возвращает true, если заданное именованное $param's $val соответствует заданному $rule в зависимости от $context. В настоящее время реализуемые типы правил — controller, action и match, которые могут быть объединены друг с другом.
Параметры
- строка
$args - Строка с переданными параметрами. Пример: /1/foo
- строка
$context - Текущий контекст маршрута, который должен содержать ключи controller/action.
Возвращает
массивМассив переданных аргументов.
_parseExtension()source protected
_parseExtension( string $url )
Удаляет расширение из $url, если он содержит зарегистрированное расширение. Если зарегистрированное расширение не найдено, расширение не возвращается, и URL возвращается без изменений.
Параметры
- строка
$url - URL для парсинга.
Возвращает
массивсодержащий url, extension
_persistParams()source protected
_persistParams( array $url , array $params )
Применение постоянных параметров к массиву URL. Постоянные параметры — это специальный ключ, используемый во время создания маршрута для принудительного сохранения параметров маршрута при их отсутствии в массиве URL.
Параметры
- массив
$url - Массив, к которому нужно применить постоянные параметры.
- массив
$params - Массив постоянных значений для замены постоянных.
Возвращает
массивМассив с применёнными постоянными параметрами.
_writeRoute()source protected
_writeRoute( )
Создание регулярного выражения маршрута.
Использует свойства template, defaults и options для компиляции регулярного выражения, которое может использоваться для разбора строк запросов.
_writeUrl()source protected
_writeUrl( array $params , array $pass [] , array $query [] )
Преобразование массива сопоставленного маршрута в строку URL.
Создаёт строковый URL, используя шаблон, использованный для создания маршрута.
Параметры
- массив
$params - Параметры для преобразования в строковый URL
- массив
$passнеобязательно [] - Дополнительные переданные аргументы
- массив
$queryнеобязательно [] - Массив параметров
Возвращает
строкаСгенерированная строка маршрута.
compile()source public
compile( )
Компиляция регулярного выражения маршрута.
Изменяет свойство defaults, чтобы все необходимые ключи были установлены, и заполняет $this->names именованными элементами маршрутизации.
Возвращает
массивВозвращает строку регулярного выражения скомпилированного маршрута.
compiled()source public
compiled( )
Проверка, скомпилирован ли маршрут в регулярное выражение.
Возвращает
booleanextensions()source public
extensions( null|string|array $extensions null )
Получение/Установка поддерживаемых расширений для этого маршрута.
Устарело
3.3.9 Используйте getExtensions/setExtensions вместо этого.Параметры
- null|строка|массив
$extensionsнеобязательно null - Расширения для установки. Используйте null для получения.
Возвращает
массив|nullРасширения или null.
getExtensions()source public
getExtensions( )
Получение поддерживаемых расширений для этого маршрута.
Возвращает
массивgetName()source public
getName( )
Получить стандартизированное имя маршрута plugin.controller:action.
Возвращает
stringsetExtensions()source public
setExtensions( array $extensions )
Установить поддерживаемые расширения для данного маршрута.
Параметры
- array
$extensions - Расширения для установки.
Возвращает
$this
staticPath()source public
staticPath( )
Получить статическую часть пути для данного маршрута.
Возвращает
stringПодробное описание свойств
$redirectsource
public array|string
Место перенаправления. Может быть строкой или массивом URL CakePHP.
$responsesource
public Cake\Network\Response
Объект Response
Устарело
3.2.0 Это свойство не используется.null
© 2005–2017 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/3.3/class-Cake.Routing.Route.RedirectRoute.html