Класс PluginShortRoute

match()source public

match( array $url , array $context [] )

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

Параметры

массив $url

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

массив $context необязательно []

Массив текущего контекста запроса. Содержит информацию, такую как текущий хост, схема, порт и базовый каталог.

Возвращает

строка|ложь
Строка URL для параметров, если они соответствуют, или ложь.

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

Cake\Routing\Route\InflectedRoute::match()

parse()source public

parse( string $url , string $method '' )

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

Параметры

строка $url

URL для разбора

строка $method необязательно ''

Метод HTTP

Возвращает

массив|ложь
Массив параметров запроса или логическое значение ложь при ошибке.

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

Cake\Routing\Route\InflectedRoute::parse()

_underscore()source protected

_underscore( array $url )

Вспомогательный метод для подчеркивания ключей в массиве URL.

Параметры

массив $url

Массив ключей URL.

Возвращает

массив

__construct()source public

__construct( string $template , array|string $defaults [] , array $options [] )

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

Параметры

• _ext - Определяет расширения, используемые для этого маршрута.
• pass - Копирует перечисленные параметры в params['pass'].

Параметры

строка $template

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

массив|строка $defaults необязательно []

Значения по умолчанию для маршрута.

массив $options необязательно []

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

__set_state()source public static

__set_state( array $fields )

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

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

Параметры

массив $fields

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

Возвращает

Cake\Routing\Route\Route
Новый экземпляр маршрута

_matchMethod()source protected

_matchMethod( array $url )

Проверка соответствия метода HTTP URL.

Параметры

массив $url

Массив для генерируемого URL.

Возвращает

логическое значение

_parseArgs()source protected

_parseArgs( string $args , string $context )

Разбор переданных параметров в список переданных аргументов.

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

Параметры

строка $args

Строка с переданными параметрами. Например, /1/foo

строка $context

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

Возвращает

массив
Массив переданных аргументов.

_parseExtension()source protected

_parseExtension( string $url )

Удаляет расширение из $url, если он содержит зарегистрированное расширение. Если зарегистрированное расширение не найдено, расширение не возвращается, и URL возвращается без изменений.

Параметры

строка $url

URL для разбора.

Возвращает

массив
содержащий url, расширение

_persistParams()source protected

_persistParams( array $url , array $params )

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

Параметры

массив $url

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

массив $params

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

Возвращает

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

_writeRoute()source protected

_writeRoute( )

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

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

_writeUrl()source protected

_writeUrl( array $params , array $pass [] , array $query [] )

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

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

Параметры

массив $params

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

массив $pass необязательно []

Дополнительные переданные аргументы

массив $query необязательно []

Массив параметров

Возвращает

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

compile()source public

compile( )

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

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

Возвращает

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

compiled()source public

compiled( )

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

Возвращает

логическое значение

extensions()source public

extensions( null|string|array $extensions null )

Получение/Установка поддерживаемых расширений для данного маршрута.

Устарело

3.3.9 Используйте getExtensions/setExtensions вместо этого.

Параметры

null|строка|массив $extensions необязательно null

Расширения для установки. Используйте null для получения.

Возвращает

массив|null
Расширения или null.

getExtensions()source public

getExtensions( )

Получить поддерживаемые расширения для этого маршрута.

Возвращает

array

getName()source public

getName( )

Получить стандартизированное имя plugin.controller:action для маршрута.

Возвращает

string

setExtensions()source public

setExtensions( array $extensions )

Установить поддерживаемые расширения для этого маршрута.

Параметры

array $extensions

Расширения для установки.

Возвращает

$this

staticPath()source public

staticPath( )

Получить статическую часть пути для этого маршрута.

Возвращает

string