Класс RedirectRoute

__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 )

Парсит строковый URL в массив. Парсируемые URL приведут к автоматическому перенаправлению.

Параметры

строка $url

URL для парсинга.

Возвращает

false|null
False при ошибке. Исключение генерируется при успешном совпадении.

Выбрасывает

Cake\Routing\Exception\RedirectException

Исключение генерируется при успешном совпадении. Это используется для остановки сопоставления маршрутов и сигнализирования middleware о необходимости перенаправления.

Переопределяет

Cake\Routing\Route\Route::parse()

__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, расширение

_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( )

Проверяет, был ли маршрут скомпилирован в регулярное выражение.

Возвращает

boolean

extensions()source public

extensions( null|string|array $extensions null )

Получение/установка поддерживаемых расширений для данного маршрута.

Параметры

null|строка|массив $extensions опционально null

Расширения для установки. Использование null для получения.

Возвращает

массив|null
Расширения или null.

getName()source public

getName( )

Получение стандартного имени плагина.controller:action для маршрута.

Возвращает

строка

staticPath()source public

staticPath( )

Получить статическую часть пути для этого маршрута.

Возвращает

строка

null