Класс Route

__construct()source public

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

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

Опции

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

Параметры

строка $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 и его значение $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 именованными элементами маршрутизации.

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

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

compiled()source public

compiled( )

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

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

boolean

extensions()source public

extensions( null|string|array $extensions null )

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

Устарело

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

Параметры

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

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

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

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

getExtensions()source public

getExtensions( )

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

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

массив

getName()source public

getName( )

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

Возвращает

string

match()source public

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

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

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

Параметры

массив $url

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

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

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

Возвращает

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

parse()source public

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

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

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

Параметры

строка $url

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

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

Метод HTTP запроса, который анализируется.

Возвращает

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

setExtensions()source public

setExtensions( array $extensions )

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

Параметры

массив $extensions

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

Возвращает

$this

staticPath()source public

staticPath( )

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

Возвращает

string

null

[]

false

null

[]

[]

[]

null