Класс Route

__constructsource public

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

Конструктор маршрута

Параметры

• _ext — Определяет расширения, используемые для этого маршрута.
• pass — Копирует перечисленные параметры в params['pass'].

Параметры

строка $template

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

массив|строка $defaults необязательно []

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

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

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

__set_statesource public static

__set_state( array $fields )

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

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

Параметры

массив $fields

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

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

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

_matchMethodsource protected

_matchMethod( array $url )

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

Параметры

массив $url

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

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

boolean
bool

_parseArgssource protected

_parseArgs( string $args , string $context )

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

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

Параметры

строка $args

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

строка $context

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

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

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

_parseExtensionsource protected

_parseExtension( string $url )

Удаляет расширение из $url, если он содержит зарегистрированное расширение. Если зарегистрированное расширение не найдено, расширение не возвращается, и URL возвращается без изменений.

Параметры

строка $url

URL для разбора.

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

array
содержащий url, расширение

_persistParamssource protected

_persistParams( array $url , array $params )

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

Параметры

массив $url

Массив, к которому применяются постоянные параметры.

массив $params

Массив постоянных значений, которые заменят постоянные.

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

array
Массив с применёнными постоянными параметрами.

_writeRoutesource protected

_writeRoute( )

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

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

_writeUrlsource protected

_writeUrl( array $params , array $pass [] , array $query [] )

Преобразование соответствующего массива маршрута в строку URL.

Составление строки URL с использованием шаблона, используемого для создания маршрута.

Параметры

массив $params

Параметры для преобразования в строку URL

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

Дополнительные переданные аргументы

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

Массив параметров

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

string
Сгенерированная строка маршрута.

compilesource public

compile( )

Компиляция регулярного выражения маршрута.

Изменяет свойство defaults, чтобы все необходимые ключи были установлены, и заполняет $this->names именованными элементами маршрутизации.

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

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

compiledsource public

compiled( )

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

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

boolean
bool

extensionssource public

extensions( null|string|array $extensions null )

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

Параметры

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

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

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

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

getNamesource public

getName( )

Получение стандартизированного имени plugin.controller:action для маршрута.

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

string
строка

matchsource public

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

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

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

Параметры

массив $url

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

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

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

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

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

parsesource public

parse( string $url )

Проверка возможности разбора заданного URL этим маршрутом.

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

Параметры

строка $url

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

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

array|false
Массив параметров запроса или false при ошибке.

staticPathsource public

staticPath( )

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

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

string
строка

null

[]

false

null

[]

[]

[]

null