Класс RedirectRoute
Маршрут перенаправления выполнит немедленное перенаправление. Маршруты перенаправления полезны, когда требуется, чтобы в вашем приложении выполнялись перенаправления уровня маршрутизации, в случаях, когда URL-адреса перемещаются.
- CakeRoute
-
RedirectRoute
Авторские права: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: MIT License
Расположение: Cake/Routing/Route/RedirectRoute.php
Краткое описание свойств
-
$redirectpublicМесто назначения перенаправления. Может быть строкой или URL-адресом в формате массива CakePHP.mixed - Объект CakeResponse
$responsepublic -
$stoppublicФлаг для отключения exit() при обработке URL-адреса этим маршрутом.boolean
Унаследованные свойства
Краткое описание методов
- __construct() publicКонструктор
- _stop() protected
Остановка выполнения текущего скрипта. Оборачивает exit(), что упрощает тестирование.
- match() publicПеренаправление обратной маршрутизации не поддерживается
- parse() public
Разбирает строковый URL в массив. Обработанные URL-адреса приведут к автоматическому перенаправлению
Подробное описание методов
__construct()source public
__construct( string $template , array $defaults array() , array $options array() )
Конструктор
Параметры
- строка
$template - Шаблонная строка с заменителями параметров
- массив
$defaultsнеобязательно array() - Массив значений по умолчанию для маршрута.
- массив
$optionsнеобязательно array() - Дополнительный массив опций для маршрута
Переопределяет
CakeRoute::__construct() _stop()source protected
_stop( integer|string $code 0 )
Остановка выполнения текущего скрипта. Оборачивает exit(), что упрощает тестирование.
Параметры
- целое число/строка
$codeнеобязательно 0 - См. http://php.net/exit для значений
match()source public
match( array $url )
Перенаправление обратной маршрутизации не поддерживается
Параметры
- массив
$url - Массив параметров для преобразования в строку.
Возвращает
смешанный типлибо false, либо строковый URL.
Переопределяет
CakeRoute::match() parse()source public
parse( string $url )
Разбирает строковый URL в массив. Обработанные URL-адреса приведут к автоматическому перенаправлению
Параметры
- строка
$url - URL-адрес для разбора
Возвращает
булево значениеFalse при ошибке
Переопределяет
CakeRoute::parse() Методы, унаследованные от CakeRoute
__set_state()source public static
__set_state( array $fields )
Магический метод для установки состояния, поддерживающий var_export
Этот метод полезен для приложений, которые хотят реализовать кэширование маршрутизатора.
Параметры
- массив
$fields - Ключ/Значение атрибутов объекта
Возвращает
CakeRouteНовый экземпляр маршрута
_matchNamed()source protected
_matchNamed( string $val , array $rule , string $context )
Проверка соответствия именованного параметра текущим правилам.
Возвращает true, если заданное значение $val именованного параметра $param соответствует заданному правилу $rule в зависимости от $context. В настоящее время реализуются типы правил controller, action и match, которые могут быть объединены друг с другом.
Параметры
- строка
$val - Значение именованного параметра
- массив
$rule - Правило(а) для применения, также может быть строкой match
- строка
$context - Массив с дополнительной информацией контекста (controller/action)
Возвращает
булево значение_parseArgs()source protected
_parseArgs( string $args , string $context )
Разбор переданных и именованных параметров в список переданных аргументов и массив именованных параметров. Будут использованы локальные и глобальные настройки для именованных параметров.
Параметры
- строка
$args - Строка с переданными и именованными параметрами. Например, /1/page:2
- строка
$context - Текущий контекст маршрута, который должен содержать ключи controller/action.
Возвращает
массивМассив ($pass, $named)
_writeRoute()source protected
_writeRoute( )
Создает регулярное выражение для маршрута.
Использует свойства template, defaults и options для компиляции регулярного выражения, которое можно использовать для разбора строк запроса.
_writeUrl()source protected
_writeUrl( array $params )
Преобразует массив соответствий маршрута в строку URL.
Компонует строку URL, используя шаблон, использованный для создания маршрута.
Параметры
- массив
$params - Параметры для преобразования в строку URL.
Возвращает
строкаСгенерированная строка маршрута.
compile()source public
compile( )
Компилирует регулярное выражение маршрута.
Изменяет свойство defaults, чтобы все необходимые ключи были установлены, и заполняет $this->names именованными элементами маршрутизации.
Возвращает
массивВозвращает строковое регулярное выражение скомпилированного маршрута.
compiled()source public
compiled( )
Проверка, был ли маршрут скомпилирован в регулярное выражение.
Возвращает
булево значениеpersistParams()source public
persistParams( array $url , array $params )
Применение постоянных параметров к массиву URL. Постоянные параметры - это специальный ключ, используемый при создании маршрута, чтобы принудительно сохранить параметры маршрута, когда они опущены из массива URL.
Параметры
- массив
$url - Массив, к которому нужно применить постоянные параметры.
- массив
$params - Массив постоянных значений для замены постоянных.
Возвращает
массивМассив с применёнными постоянными параметрами.
Подробное описание свойств
$redirectsource
public смешанный тип
Место назначения перенаправления. Может быть строкой или URL-адресом в формате массива CakePHP.
© 2005–2016 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.
http://api.cakephp.org/2.8/class-RedirectRoute.html