Класс PluginShortRoute

matchsource public

match( array $url )

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

Параметры

массив $url

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

Возвращает

mixed
либо false, либо строку URL.

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

CakeRoute::match()

parsesource public

parse( string $url )

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

Параметры

строка $url

URL для разбора

Возвращает

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

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

CakeRoute::parse()

__constructsource public

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

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

Параметры

строка $template

Шаблонная строка с заполнительми параметров

массив $defaults необязательно array()

Массив значений по умолчанию для маршрута.

массив $options необязательно array()

Массив дополнительных параметров для маршрута

__set_statesource public static

__set_state( array $fields )

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

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

Параметры

массив $fields

Ключ/Значение атрибутов объекта

Возвращает

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

_matchNamedsource protected

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

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

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

Параметры

строка $val

Значение именованного параметра

массив $rule

Правило(а), которое нужно применить; также может быть строкой соответствия.

строка $context

Массив с дополнительной информацией о контексте (контроллер/действие)

Возвращает

boolean
bool

_parseArgssource protected

_parseArgs( string $args , string $context )

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

Параметры

строка $args

Строка с переданными и именованными параметрами. Например, /1/page:2

строка $context

Текущий контекст маршрута, который должен содержать ключи контроллера/действия.

Возвращает

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

_writeRoutesource protected

_writeRoute( )

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

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

_writeUrlsource protected

_writeUrl( array $params )

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

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

Параметры

массив $params

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

Возвращает

string
Строка составленного маршрута.

compilesource public

compile( )

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

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

Возвращает

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

compiledsource public

compiled( )

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

Возвращает

boolean
bool

persistParamssource public

persistParams( array $url , array $params )

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

Параметры

массив $url

Массив, к которому нужно применить параметры сохранения.

массив $params

Массив значений сохранения для замены.

Возвращает

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

null

false

array(
    'type' => 'content_type',
    'method' => 'request_method',
    'server' => 'server_name'
)

array()

array()

array()

null