Класс 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 в массив. Если совпадает, преобразует ключи префикса, контроллера и плагина в их camelized форму.

Параметры

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

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

Возвращаемые значения

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