Класс InflectedRoute

_underscore()source protected

_underscore( array $url )

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

Параметры

массив $url

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

Возвращает

массив

match()source public

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

Преобразует префикс, контроллер и параметры плагина в подчеркнутый вид перед передачей в родительский класс

Параметры

массив $url

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

массив $context дополнительно []

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

Возвращает

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

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

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

parse()source public

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

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

Параметры

строка $url

URL для парсинга

строка $method дополнительно ''

Метод HTTP, на который происходит соответствие.

Возвращает

массив|ложь
Массив параметров запроса, или ложь в случае неудачи.

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

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

__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 статический

__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, расширение

_persistParams()source protected

_persistParams( array $url , array $params )

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

Параметры

массив $url

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

массив $params

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

Возвращает

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

_writeRoute()source protected

_writeRoute( )

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

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

_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( )

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

Возвращает

boolean

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

false