Spec-Zone.ru › CakePHP 2.8

Класс PluginShortRoute

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

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

Унаследованные свойства

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

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

  • match() public

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

  • parse() public

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

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

match()исходный код public

match( array $url )

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

Параметры

массив $url
Массив параметров, которые нужно преобразовать в строку.

Возвращаемое значение

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

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

CakeRoute::match()

parse()исходный код public

parse( string $url )

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

Параметры

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

Возвращаемое значение

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

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

CakeRoute::parse()

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

__construct()исходный код public

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

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

Параметры

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

__set_state()исходный код public static

__set_state( array $fields )

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

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

Параметры

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

Возвращаемое значение

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

_matchNamed()исходный код protected

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

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

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

Параметры

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

Возвращаемое значение

boolean

_parseArgs()исходный код protected

_parseArgs( string $args , string $context )

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

Параметры

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

Возвращаемое значение

массив
Массив ($pass, $named)

_writeRoute()исходный код protected

_writeRoute( )

Создает регулярное выражение для маршрута.

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

_writeUrl()исходный код protected

_writeUrl( array $params )

Преобразует массив соответствующего маршрута в строку URL.

Создает строку URL, используя шаблон, использованный для создания маршрута.

Параметры

массив $params
Параметры для преобразования в строку URL.

Возвращаемое значение

строка
Сгенерированная строка маршрута.

compile()исходный код public

compile( )

Компилирует регулярное выражение маршрута.

Изменяет свойство defaults, чтобы все необходимые ключи были заданы, и заполняет $this->names именованными элементами маршрутизации.

Возвращаемое значение

массив
Возвращает строку регулярного выражения скомпилированного маршрута.

compiled()исходный код public

compiled( )

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

Возвращаемое значение

boolean

persistParams()исходный код 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.
http://api.cakephp.org/2.8/class-PluginShortRoute.html

Spec-Zone.ru

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