Класс 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

Возвращает

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

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

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

Параметры

строка $args

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

строка $context

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

Возвращает

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

_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 устаревшее

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