Класс DashedRoute

_camelizePlugin()source protected

_camelizePlugin( string $plugin )

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

Параметры

строка $plugin

Имя плагина

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

строка

_dasherize()source protected

_dasherize( array $url )

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

Параметры

массив $url

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

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

массив

match()source public

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

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

Параметры

массив $url

Массив параметров, которые нужно преобразовать в строку.

массив $context необязательный []

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

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

boolean|строка
Либо false, либо строковый URL.

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

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

parse()source public

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

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

Параметры

строка $url

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

строка $method необязательный ''

Метод HTTP.

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

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

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

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 )

Метод магии set_state для поддержки var_export

Этот метод полезен для приложений, которые хотят реализовать кэширование маршрутизатора.

Параметры

массив $fields

Ключ/значение атрибутов объекта

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

Cake\Routing\Route\Route
Новый экземпляр маршрута

_matchMethod()source protected

_matchMethod( array $url )

Проверка соответствия метода HTTP URL.

Параметры

массив $url

Массив для генерируемого URL.

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

boolean

_parseArgs()source protected

_parseArgs( string $args , string $context )

Разбор переданных параметров в список аргументов.

Возвращает true, если заданное имя параметра $param и его значение $val соответствует заданному правилу $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( )

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

Использует свойства 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 именованными элементами маршрутизации.

Возвращает

string
Возвращает строковое регулярное выражение скомпилированного маршрута.

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