Класс DashedRoute
Этот класс маршрутов прозрачно инфлектирует параметры маршрутизации контроллера, действия и плагина, так что запрос /my-plugin/my-controller/my-action анализируется как ['plugin' => 'MyPlugin', 'controller' => 'MyController', 'action' => 'myAction']
- Cake\Routing\Route\Route
-
Cake\Routing\Route\DashedRoute
Краткое описание свойств
-
$_inflectedDefaultsprotectedФлаг для отслеживания того, были ли значения по умолчанию инфлектированы.boolean
Унаследованные свойства
Краткое описание методов
- _camelizePlugin() protectedПриводит имя плагина, ранее записанного с дефисами, к верблюжьему регистру, учитывая поставщиков плагинов
- _dasherize() protectedВспомогательный метод для преобразования ключей в массиве URL в дефисный формат.
- match() public
Преобразует контроллер, действие и параметры плагина в дефисный формат перед передачей их родительскому классу.
- parse() public
Парсит строковый URL в массив. Если совпадает, преобразует ключи контроллера и плагина в верблюжий регистр, а ключ действия — в регистр camelBack.
Подробное описание методов
_camelizePlugin()source protected
_camelizePlugin( string $plugin )
Приводит имя плагина, ранее записанного с дефисами, к верблюжьему регистру, учитывая поставщиков плагинов
Параметры
- string
$plugin - Имя плагина
Возвращает
string_dasherize()source protected
_dasherize( array $url )
Вспомогательный метод для преобразования ключей в массиве URL в дефисный формат.
Параметры
- array
$url - Массив ключей URL.
Возвращает
arraymatch()source public
match( array $url , array $context [] )
Преобразует контроллер, действие и параметры плагина в дефисный формат перед передачей их родительскому классу.
Параметры
- array
$url - Массив параметров для преобразования в строку.
- array
$contextнеобязательно [] Массив текущего контекста запроса. Содержит информацию, такую как текущий хост, схема, порт и базовый каталог.
Возвращает
boolean|stringЛибо false, либо строковый URL.
Переопределяет
Cake\Routing\Route\Route::match() parse()source public
parse( string $url )
Парсит строковый URL в массив. Если совпадает, преобразует ключи контроллера и плагина в верблюжий регистр, а ключ действия — в регистр camelBack.
Параметры
- string
$url - URL для парсинга
Возвращает
array|falseМассив параметров запроса или false при ошибке.
Переопределяет
Cake\Routing\Route\Route::parse() Методы, унаследованные от Cake\Routing\Route\Route
__construct()source public
__construct( string $template , array|string $defaults [] , array $options [] )
Конструктор маршрута
Параметры
-
_ext- Определяет расширения, используемые для этого маршрута. -
pass- Копирует перечисленные параметры в params['pass'].
Параметры
- string
$template - Шаблон со знаками замещения параметров
- array|string
$defaultsнеобязательно [] - Значения по умолчанию для маршрута.
- array
$optionsнеобязательно [] - Массив дополнительных параметров для маршрута
__set_state()source public static
__set_state( array $fields )
Метод магии установки состояния для поддержки var_export
Этот метод помогает приложениям, которые хотят реализовать кэширование маршрутизатора.
Параметры
- array
$fields - Ключ/значение атрибутов объекта
Возвращает
Cake\Routing\Route\RouteНовый экземпляр маршрута
_matchMethod()source protected
_matchMethod( array $url )
Проверка соответствия HTTP-метода URL.
Параметры
- array
$url - Массив для генерируемого URL.
Возвращает
boolean_parseArgs()source protected
_parseArgs( string $args , string $context )
Разбор переданных параметров в список переданных аргументов.
Возвращает true, если значение заданного параметра $param's $val соответствует заданному правилу $rule в зависимости от $context. В настоящее время реализованы типы правил: controller, action и match, которые могут быть объединены.
Параметры
- string
$args - Строка с переданными параметрами. Например, /1/foo
- string
$context - Текущий контекст маршрута, который должен содержать ключи controller/action.
Возвращает
arrayМассив переданных аргументов.
_parseExtension()source protected
_parseExtension( string $url )
Удаление расширения из $url, если оно содержит зарегистрированное расширение. Если зарегистрированное расширение не найдено, расширение не возвращается, и URL возвращается без изменений.
Параметры
- string
$url - Url для парсинга.
Возвращает
arrayсодержащий url, расширение
_persistParams()source protected
_persistParams( array $url , array $params )
Применение постоянных параметров к массиву URL. Постоянные параметры — это специальный ключ, используемый при создании маршрута для принудительного сохранения параметров маршрута при их отсутствии в массиве URL.
Параметры
- array
$url - Массив, к которому применяются постоянные параметры.
- array
$params - Массив постоянных значений для замены постоянных.
Возвращает
arrayМассив с применёнными постоянными параметрами.
_writeRoute()source protected
_writeRoute( )
Создание регулярного выражения для маршрута.
Использует свойства template, defaults и options для компиляции регулярного выражения, которое можно использовать для анализа строк запроса.
_writeUrl()source protected
_writeUrl( array $params , array $pass [] , array $query [] )
Преобразование массива соответствующего маршрута в строку URL.
Составление строкового URL с использованием шаблона, используемого для создания маршрута.
Параметры
- array
$params - Параметры для преобразования в строковый URL
- array
$passнеобязательно [] - Дополнительные переданные аргументы
- array
$queryнеобязательно [] - Массив параметров
Возвращает
stringСоставленная строка маршрута.
compile()source public
compile( )
Компиляция регулярного выражения маршрута.
Изменяет свойство defaults, чтобы все необходимые ключи были установлены, и заполняет $this->names именованными элементами маршрутизации.
Возвращает
arrayВозвращает строку регулярного выражения скомпилированного маршрута.
compiled()source public
compiled( )
Проверить, был ли маршрут скомпилирован в регулярное выражение.
Возвращает
booleanextensions()source public
extensions( null|string|array $extensions null )
Получить/Установить поддерживаемые расширения для этого маршрута.
Параметры
- null|string|array
$extensionsнеобязательно null - Расширения для установки. Используйте null для получения.
Возвращает
array|nullРасширения или null.
getName()source public
getName( )
Получить стандартное имя плагина.контроллер:действие для маршрута.
Возвращает
stringstaticPath()source public
staticPath( )
Получить статическую часть пути для этого маршрута.
Возвращает
stringПодробное описание свойств
$_inflectedDefaultssource
protected boolean
Флаг, указывающий, были ли значения по умолчанию склонены.
Значения по умолчанию должны быть склонены, чтобы соответствовать склонениям, которые создаст match().
false
© 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/3.2/class-Cake.Routing.Route.DashedRoute.html