Spec-Zone.ru › CakePHP 2.9

Класс PluginShortRoute

Маршрут короткого плагина, который копирует параметр плагина в параметры контроллера. Используется для поддержки маршрутов /:plugin.

CakeRoute
Extended by PluginShortRoute
Пакет: Cake\Маршрутизация\Маршрут
Авторские права: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: MIT License
Расположение: Cake/Routing/Route/PluginShortRoute.php

Наследуемые свойства

  • _compiledRoute, _greedy, _headerMap, defaults, keys, options, template

Краткое описание методов

  • match() public

    Обратный маршрут сокращенных ссылок плагина. Если плагин и контроллер не совпадают, соответствие автоматически отклоняется.

  • parse() public

    Разбирает строковый URL в массив. Если найден ключ плагина, он будет скопирован в параметр контроллера

Подробное описание методов

match()source public

match( array $url )

Обратный маршрут сокращенных ссылок плагина. Если плагин и контроллер не совпадают, соответствие автоматически отклоняется.

Параметры

массив $url
Массив параметров для преобразования в строку.

Возвращает

mixed
либо false, либо строковый URL.

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

CakeRoute::match()

parse()source public

parse( string $url )

Разбирает строковый URL в массив. Если найден ключ плагина, он будет скопирован в параметр контроллера

Параметры

строка $url
URL для разбора

Возвращает

mixed
false при ошибке или массив параметров запроса

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

CakeRoute::parse()

Методы, унаследованные от CakeRoute

__construct()source public

__construct( string $template , array $defaults array() , array $options array() )

Конструктор для маршрута

Параметры

строка $template
Шаблонная строка с заменителями параметров
массив $defaults необязательно массив()
Массив значений по умолчанию для маршрута.
массив $options необязательно массив()
Массив дополнительных параметров для маршрута

__set_state()source public static

__set_state( array $fields )

Магический метод для установки состояния, для поддержки var_export

Этот метод полезен для приложений, которые хотят реализовать кэширование маршрутизатора.

Параметры

массив $fields
Ключ/значение атрибутов объекта

Возвращает

CakeRoute
Новый экземпляр маршрута

_matchNamed()source protected

_matchNamed( string $val , array $rule , string $context )

Проверяет, соответствует ли именованный параметр текущим правилам.

Возвращает true, если заданное значение $param с именем $val соответствует заданному правилу $rule в зависимости от $context. В настоящее время реализованы типы правил контроллер, действие и сопоставление, которые могут быть объединены друг с другом.

Параметры

строка $val
Значение именованного параметра
массив $rule
Правило(а), которое(ые) необходимо применить, может также быть строкой сопоставления
строка $context
Массив с дополнительной информацией о контексте (контроллер/действие)

Возвращает

boolean

_parseArgs()source protected

_parseArgs( string $args , string $context )

Разбирает переданные и именованные параметры в список переданных аргументов и хеш именованных параметров. Будут использоваться локальные и глобальные настройки именованных параметров.

Параметры

строка $args
Строка с переданными и именованными параметрами. Например, /1/page:2
строка $context
Текущий контекст маршрута, который должен содержать ключи контроллер/действие.

Возвращает

массив
Массив ($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( )

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

Возвращает

boolean

persistParams()source public

persistParams( array $url , array $params )

Применяет постоянные параметры к массиву URL. Постоянные параметры — это специальный ключ, используемый при создании маршрута, чтобы принудительно сохранить параметры маршрута, когда они отсутствуют в массиве URL.

Параметры

массив $url
Массив, к которому необходимо применить постоянные параметры.
массив $params
Массив постоянных значений, которые заменят постоянные значения.

Возвращает

массив
Массив с применёнными постоянными параметрами.

© 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.
https://api.cakephp.org/2.9/class-PluginShortRoute.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API