Класс 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 в массив. Если совпадение найдено, ключи контроллера и плагина будут преобразованы в верблюжий регистр, а ключ действия — в регистр с нижним подчёркиванием.
Подробное описание методов
_camelizePlugin()source protected
_camelizePlugin( string $plugin )
Преобразует ранее разделенный маршрут плагина в верблюжьего случая, учитывая поставщиков плагинов
Параметры
- строка
$plugin - Имя плагина
Возвращаемое значение
строка_dasherize()source protected
_dasherize( array $url )
Вспомогательный метод для преобразования ключей в массиве URL в дефисный формат.
Параметры
- массив
$url - Массив ключей URL.
Возвращаемое значение
массивmatch()source public
match( array $url , array $context [] )
Преобразует контроллер, действие и параметры плагина в дефисный формат перед передачей их родительскому классу.
Параметры
- массив
$url - Массив параметров для преобразования в строку.
- массив
$contextнеобязательно [] Массив текущего контекста запроса. Содержит информацию, такую как текущий хост, схему, порт и базовый каталог.
Возвращаемое значение
логическое значение|строкаЛибо false, либо строковый URL.
Переопределяет
Cake\Routing\Route\Route::match() parse()source public
parse( string $url , string $method '' )
Парсит строковый URL в массив. Если совпадение найдено, ключи контроллера и плагина будут преобразованы в верблюжий регистр, а ключ действия — в регистр с нижним подчёркиванием.
Параметры
- строка
$url - URL для парсинга
- строка
$methodнеобязательно '' - HTTP-метод.
Возвращаемое значение
массив|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'].
Параметры
- строка
$template - Шаблон со знаками замещения параметров
- массив|строка
$defaultsнеобязательно [] - Значения по умолчанию для маршрута.
- массив
$optionsнеобязательно [] - Массив дополнительных параметров для маршрута
__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.
Возвращаемое значение
логическое значение_parseArgs()source protected
_parseArgs( string $args , string $context )
Разбирает переданные параметры в список переданных аргументов.
Возвращает true, если заданное именованное значение $param's $val соответствует заданному $rule в зависимости от $context. В настоящее время реализованы типы правил — controller, action и match, которые могут быть объединены друг с другом.
Параметры
- строка
$args - Строка с переданными параметрами. Пример: /1/foo
- строка
$context - Текущий контекст маршрута, который должен содержать ключи контроллера/действия.
Возвращаемое значение
массивМассив переданных аргументов.
_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|string|array
$extensionsнеобязательно null - Расширения для установки. Используйте null для получения.
Возвращает
array|nullРасширения или null.
getExtensions()source public
getExtensions( )
Получить поддерживаемые расширения для этого маршрута.
Возвращает
arraygetName()source public
getName( )
Получить стандартизированное имя plugin.controller:action для маршрута.
Возвращает
stringsetExtensions()source public
setExtensions( array $extensions )
Установить поддерживаемые расширения для этого маршрута.
Параметры
- array
$extensions - Расширения для установки.
Возвращает
$this
staticPath()source public
staticPath( )
Получить статическую часть пути для этого маршрута.
Возвращает
stringПодробное описание свойств
$_inflectedDefaultssource
protected boolean
Флаг для отслеживания того, были ли значения по умолчанию склонены.
Значения по умолчанию необходимо склонять, чтобы они соответствовали склонениям, которые создаст match().
false
© 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.DashedRoute.html