Класс PluginShortRoute
Короткая ссылка плагина, копирующая параметр плагина в параметры контроллера. Используется для поддержки маршрутов /:plugin.
- Cake\Routing\Route\Route
-
Cake\Routing\Route\InflectedRoute -
Cake\Routing\Route\PluginShortRoute
Подробное описание методов
matchsource public
match( array $url , array $context [] )
Обрабатывает обратные ссылки на сокращенные адреса плагина. Если плагин и контроллер не совпадают, совпадение автоматически не проходит.
Параметры
- массив
$url - Массив параметров для преобразования в строку.
- массив
$contextнеобязательно [] - Массив текущего контекста запроса. Содержит информацию, такую как текущий хост, схему, порт и базовый каталог.
Возвращает
string|falseСтроковый URL для параметров, если они совпадают, или false.
Переопределяет
Cake\Routing\Route\InflectedRoute::match() parsesource public
parse( string $url )
Разбирает строковый URL в массив. Если найден ключ плагина, он будет скопирован в параметр контроллера.
Параметры
- строка
$url - URL для разбора
Возвращает
array|falseМассив параметров запроса или логическое значение false при ошибке.
Переопределяет
Cake\Routing\Route\InflectedRoute::parse() Методы, унаследованные от Cake\Routing\Route\InflectedRoute
_underscoresource protected
_underscore( array $url )
Вспомогательный метод для подчеркивания ключей в массиве URL.
Параметры
- массив
$url - Массив ключей URL.
Возвращает
arrayмассив
Методы, унаследованные от Cake\Routing\Route\Route
__constructsource public
__construct( string $template , array|string $defaults [] , array $options [] )
Конструктор маршрута.
Параметры
-
_ext— Определяет расширения, используемые для этого маршрута. -
pass— Копирует указанные параметры в params['pass'].
Параметры
- строка
$template - Шаблонная строка с заглушками параметров
- массив|строка
$defaultsнеобязательно [] - Значения по умолчанию для маршрута.
- массив
$optionsнеобязательно [] - Массив дополнительных параметров для маршрута.
__set_statesource public static
__set_state( array $fields )
Магический метод установки состояния для поддержки var_export
Этот метод помогает приложениям, которые хотят реализовать кэширование маршрутизатора.
Параметры
- массив
$fields - Ключ/значение атрибутов объекта
Возвращает
Cake\Routing\Route\RouteНовый экземпляр маршрута
_matchMethodsource protected
_matchMethod( array $url )
Проверка соответствия HTTP-метода URL.
Параметры
- массив
$url - Массив для генерируемого URL.
Возвращает
booleanbool
_parseArgssource protected
_parseArgs( string $args , string $context )
Разбор переданных параметров в список переданных аргументов.
Возвращает true, если заданное имя $param's $val соответствует заданному $rule в зависимости от $context. В настоящее время реализованы типы правил: controller, action и match, которые можно комбинировать друг с другом.
Параметры
- строка
$args - Строка с переданными параметрами. Например, /1/foo
- строка
$context - Текущий контекст маршрута, который должен содержать ключи controller/action.
Возвращает
arrayМассив переданных аргументов.
_parseExtensionsource protected
_parseExtension( string $url )
Удаляет расширение из $url, если он содержит зарегистрированное расширение. Если зарегистрированное расширение не найдено, расширение не возвращается, и URL возвращается без изменений.
Параметры
- строка
$url - URL для разбора.
Возвращает
arrayсодержащий URL, расширение
_persistParamssource protected
_persistParams( array $url , array $params )
Применение постоянных параметров к массиву URL. Постоянные параметры — это специальный ключ, используемый при создании маршрута, для принудительного сохранения параметров маршрута, если они опущены из массива URL.
Параметры
- массив
$url - Массив, к которому применяются постоянные параметры.
- массив
$params - Массив постоянных значений для замены постоянных.
Возвращает
arrayМассив с применёнными постоянными параметрами.
_writeRoutesource protected
_writeRoute( )
Создание регулярного выражения маршрута.
Использует свойства template, defaults и options для компиляции регулярного выражения, которое может использоваться для разбора строк запросов.
_writeUrlsource protected
_writeUrl( array $params , array $pass [] , array $query [] )
Преобразование массива сопоставленного маршрута в строку URL.
Составление строкового URL с использованием шаблона, используемого для создания маршрута.
Параметры
- массив
$params - Параметры для преобразования в строковый URL.
- массив
$passнеобязательно [] - Дополнительные переданные аргументы.
- массив
$queryнеобязательно [] - Массив параметров.
Возвращает
stringСформированная строка маршрута.
compilesource public
compile( )
Компиляция регулярного выражения маршрута.
Изменяет свойство defaults, чтобы установить все необходимые ключи, и заполняет $this->names именованными элементами маршрутизации.
Возвращает
arrayВозвращает строковое регулярное выражение скомпилированного маршрута.
compiledsource public
compiled( )
Проверка, был ли маршрут скомпилирован в регулярное выражение.
Возвращает
booleanbool
extensionssource public
extensions( null|string|array $extensions null )
Получение/установка поддерживаемых расширений для этого маршрута.
Параметры
- null|строка|массив
$extensionsнеобязательно null - Расширения для установки. Используйте null для получения.
Возвращает
array|nullРасширения или null.
getNamesource public
getName( )
Получение стандартизованного имени plugin.controller:action для маршрута.
Возвращает
stringстрока
staticPathsource public
staticPath( )
Получение статической части пути для этого маршрута.
Возвращает
stringстрока
Свойства, унаследованные от Cake\Routing\Route\InflectedRoute
$_inflectedDefaultssource
protected boolean
Флаг, указывающий, были ли значения по умолчанию приведены к соответствию правилам склонения.
Значения по умолчанию должны быть приведены к соответствию правилам склонения, чтобы они совпадали со склонениями, которые создаст метод match().
false Свойства, унаследованные от Cake\Routing\Route\Route
$_greedysource
protected string
Является ли этот маршрут жадным маршрутом? Жадные маршруты содержат /* в своей шаблоне.
false $keyssource
public array
Массив именованных сегментов в маршруте. /:controller/:action/:id содержит 3 ключевых элемента.
[]
© 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.1/class-Cake.Routing.Route.PluginShortRoute.html