Класс 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 необязательно []

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

Возвращает

логическое значение|строка
Либо 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 )

Магический метод установки состояния для поддержки 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

Текущий контекст маршрута, который должен содержать ключи 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 именованными элементами маршрутизации.

Возвращает

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

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 )

Установка имён параметров, которые будут преобразованы в параметры passed.

Параметры

array $names

Имена параметров, которые должны быть переданы.

Возвращает

$this

setPatterns()source public

setPatterns( array $patterns )

Установка регулярных выражений для параметров маршрутизации

Если какие-либо из ваших шаблонов содержат многобайтовые значения, будет включён режим multibytePattern.

Параметры

array $patterns

Шаблоны для применения к элементам маршрутизации

Возвращает

$this

setPersist()source public

setPersist( array $names )

Установка имён параметров, которые будут автоматически сохранены.

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

// remove a persistent 'date' parameter
Router::url(['date' => false', ...]);

Параметры

array $names

Имена параметров, которые нужно передать.

Возвращает

$this

staticPath()source public

staticPath( )

Получение статической части пути для этого маршрута.

Возвращает

string

false