Класс Route

__construct()source public

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

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

Параметры

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

Параметры

строка $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.

Возвращает

boolean

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

Возвращает

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

compiled()source public

compiled( )

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

Возвращает

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

extensions()source public

extensions( null|string|array $extensions null )

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

Параметры

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

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

Возвращает

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

getName()source public

getName( )

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

Возвращает

строка

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 )

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

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

Параметры

строка $url

URL для попытки парсинга.

Возвращает

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

staticPath()source public

staticPath( )

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

Возвращает

строка

null

[]

false

null

[]

[]

[]

null