Spec-Zone.ru › CakePHP 2.10

Класс PluginShortRoute

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

CakeRoute
Extended by PluginShortRoute
Пакет: Cake\Routing\Route
Авторские права: Copyright (c) Cake Software Foundation, Inc. (https://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
Массив параметров для преобразования в строку.

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

смешанный тип
либо ложь, либо строковый URL.

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

CakeRoute::match()

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

parse( string $url )

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

Параметры

строка $url
URL для парсинга

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

смешанный тип
ложь при ошибке или массив параметров запроса

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

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, если заданное значение параметра $param соответствует заданному правилу $rule в зависимости от $context. В настоящее время реализованы типы правил controller, action и match, которые могут быть объединены друг с другом.

Параметры

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

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

булево

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

_parseArgs( string $args , string $context )

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

Параметры

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

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

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

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

_writeRoute( )

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

Использует свойства template, defaults и options для компиляции регулярного выражения, которое можно использовать для парсинга строк запроса.

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

_writeUrl( array $params )

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

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

Параметры

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

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

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

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

compile( )

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

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

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

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

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

compiled( )

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

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

булево

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

persistParams( array $url , array $params )

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

Параметры

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

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

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

© 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/2.10/class-PluginShortRoute.html

Spec-Zone.ru

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