Класс Route

__construct()source public

__construct( string $template , array|string $defaults = [] , array $options = [] )

Конструктор для маршрута

Параметры

• _ext - Определяет расширения, используемые для этого маршрута.
• _middleware - Определяет имена middleware для этого маршрута.
• pass - Копирует перечисленные параметры в params['pass'].
• _host - Определяет шаблон имени хоста, если вы хотите, чтобы этот маршрут соответствовал только определённым именам хостов. Вы можете использовать .* и для создания поддоменов/хостов с подстановочными знаками, например *.example.com соответствует всем поддоменам на example.com.

Параметры

строка $template

Строка шаблона с заполнительными параметрами

массив|строка $defaults optional []

Значения по умолчанию для маршрута.

массив $options optional []

Массив дополнительных опций для маршрута

__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.

Возвращает

boolean

_parseArgs()source protected

_parseArgs( string $args , string $context )

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

Возвращает true, если значение заданного параметра $param's $val соответствует заданному правилу $rule в зависимости от контекста $context. В настоящее время реализованы типы правил: контроллер, действие и соответствие, которые могут быть объединены.

Параметры

строка $args

Строка с переданными параметрами. Например, /1/foo

строка $context

Текущий контекст маршрута, который должен содержать ключи контроллера/действия.

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

массив
Массив переданных аргументов.

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

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

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

логическое значение

extensions()source public устарело

extensions( null|string|array $extensions = null )

Получение/установка поддерживаемых расширений для данного маршрута.

Устарело

3.3.9 Используйте getExtensions/setExtensions вместо этого.

Параметры

null|строка|массив $extensions необязательно null

Расширения для установки. Используйте null для получения.

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

массив|null
Расширения или null.

getExtensions()source public

getExtensions( )

Получение поддерживаемых расширений для данного маршрута.

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

массив

getMiddleware()source public

getMiddleware( )

Получение имён middleware, которые должны быть применены к этому маршруту.

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

массив

getName()source public

getName( )

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

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

строка

hostMatches()source public

hostMatches( string $host )

Проверка соответствия имени хоста требованиям маршрута.

Параметры

строка $host

Имя хоста запроса

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

логическое значение
Соответствует ли хост установленным условиям для этого маршрута.

match()source public

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

Проверка, соответствует ли массив URL данному экземпляру маршрута.

Если URL соответствует параметрам и настройкам маршрута, возвращается сгенерированная строка URL. Если URL не соответствует параметрам маршрута, возвращается false. Этот метод обрабатывает обратную маршрутизацию или преобразование массивов URL в строки URL.

Параметры

массив $url

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

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

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

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

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

parse()source public устарело

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

Проверка, может ли данный URL быть обработан этим маршрутом.

Если маршрут может быть обработан, возвращается массив параметров; если нет — false. Строковые URL обрабатываются, если они соответствуют регулярному выражению маршрута.

Устарело

3.4.0 Используйте/реализуйте parseRequest() вместо этого, так как оно обеспечивает большую гибкость/контроль.

Параметры

строка $url

URL для попытки обработки.

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

Метод HTTP запроса, который обрабатывается.

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

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

parseRequest()source public

parseRequest( Psr\Http\Message\ServerRequestInterface $request )

Проверяет, может ли данный URL быть обработан этим маршрутом.

Если маршрут может быть обработан, возвращается массив параметров; если нет — false.

Параметры

Psr\Http\Message\ServerRequestInterface $request

URL для попытки обработки.

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

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

setExtensions()source public

setExtensions( array $extensions )

Установить поддерживаемые расширения для данного маршрута.

Параметры

массив $extensions

Расширения для установки.

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

$this

setHost()source public

setHost( string $host )

Установить требование к хосту.

Параметры

строка $host

Имя хоста, к которому привязан этот маршрут

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

$this

setMethods()source public

setMethods( array $methods )

Установить принимаемые методы HTTP для данного маршрута.

Параметры

массив $methods

Методы HTTP для принятия.

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

$this

Исключения

InvalidArgumentException

setMiddleware()source public

setMiddleware( array $middleware )

Установите имена middleware, которые должны быть применены к этому маршруту.

Параметры

массив $middleware

Список имён middleware, которые нужно применить к этому маршруту. Имена middleware не будут проверены до тех пор, пока маршрут не будет сопоставлен.

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

$this

setPass()source public

setPass( array $names )

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

Параметры

массив $names

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

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

$this

setPatterns()source public

setPatterns( array $patterns )

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

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

Параметры

массив $patterns

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

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

$this

setPersist()source public

setPersist( array $names )

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

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

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

Параметры

массив $names

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

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

$this

staticPath()source public

staticPath( )

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

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

строка

[]

false

false

[]

[]

[]

[]