Класс 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 - Определяет расширения, используемые для этого маршрута.
• _middleware - Определяет имена middleware для этого маршрута.
• pass - Копирует перечисленные параметры в params['pass'].
• _host - Определяет шаблон имени хоста, если этот маршрут должен соответствовать только определённым именам хостов. Можно использовать .* и для создания поддоменов/хостов с подстановкой. Например, *.example.com соответствует всем поддоменам на example.com.

Параметры

строка $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

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

Возвращает

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

_parseExtension()source protected

_parseExtension( string $url )

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

Параметры

строка $url

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

Возвращает

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

_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 deprecated

extensions( null|string|array $extensions = null )

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

Устарело

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

Параметры

null|string|array $extensions необязательно null

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

Возвращает

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

getExtensions()source public

getExtensions( )

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

Возвращает

array

getMiddleware()source public

getMiddleware( )

Получение имён middleware, которые должны применяться к данному маршруту.

Возвращает

array

getName()source public

getName( )

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

Возвращает

string

hostMatches()source public

hostMatches( string $host )

Проверка соответствия хоста требованиям маршрута

Параметры

string $host

Имя хоста запроса

Возвращает

boolean
Соответствует ли хост условиям, заданным для данного маршрута.

parseRequest()source public

parseRequest( Psr\Http\Message\ServerRequestInterface $request )

Проверяет, может ли данный URL быть обработан этим маршрутом.

Если маршрут может быть обработан, возвращается массив параметров; в противном случае возвращается false.

Параметры

Psr\Http\Message\ServerRequestInterface $request

URL для попытки обработки.

Возвращает

array|false
Массив параметров запроса или false при неудаче.

setExtensions()source public

setExtensions( array $extensions )

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

Параметры

array $extensions

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

Возвращает

$this

setHost()source public

setHost( string $host )

Установка требования к хосту

Параметры

string $host

Имя хоста, к которому привязан данный маршрут

Возвращает

$this

setMethods()source public

setMethods( array $methods )

Установка допустимых HTTP-методов для данного маршрута.

Параметры

array $methods

HTTP-методы для принятия.

Возвращает

$this

Исключения

InvalidArgumentException

setMiddleware()source public

setMiddleware( array $middleware )

Установка имён middleware, которые должны применяться к данному маршруту.

Параметры

array $middleware

Список имён middleware, которые нужно применить к этому маршруту. Имена middleware будут проверены только при совпадении маршрута.

Возвращает

$this

setPass()source public

setPass( array $names )

Установка имён параметров, которые будут преобразованы в параметры передачи

Параметры

array $names

Имена параметров, которые нужно передать.

Возвращает

$this

setPatterns()source public

setPatterns( array $patterns )

Установка регулярных выражений для параметров маршрутизации

Если какой-либо из ваших шаблонов содержит многобайтовые значения, режим multibytePattern будет включен.

Параметры

array $patterns

Шаблоны, применяемые к элементам маршрутизации

Возвращает

$this

setPersist()source public

setPersist( array $names )

Установка имён параметров, которые будут автоматически сохранены

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

// remove a persistent 'date' parameter
Router::url(['date' => false', ...]);

Параметры

array $names

Имена параметров, которые нужно передать.

Возвращает

$this

staticPath()source public

staticPath( )

Получение статической части пути для данного маршрута.

Возвращает

string