Класс 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 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. В настоящее время реализованы типы правил контроллер, действие и совпадение, которые могут комбинироваться друг с другом.

Параметры

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

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

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

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

false