Класс RedirectRoute

__construct()source public

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

Конструктор

Параметры

строка $template

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

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

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

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

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

Переопределяет

Cake\Routing\Route\Route::__construct()

match()source public

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

Обратного перенаправления по маршрутам нет.

Параметры

массив $url

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

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

Массив параметров контекста запроса.

Возвращает

boolean
Всегда false.

Переопределяет

Cake\Routing\Route\Route::match()

parse()source public

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

Разбирает строчный URL-адрес в массив. Разбираемые URL-адреса приведут к автоматическому перенаправлению.

Параметры

строка $url

URL-адрес для разбора.

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

Используемый HTTP-метод.

Возвращает

boolean|null
False при ошибке. При успешном соответствии генерируется исключение.

Выбрасывает

Cake\Routing\Exception\RedirectException

При успешном соответствии генерируется исключение. Это используется для остановки сопоставления маршрутов и сигнализации middleware о необходимости перенаправления.

Переопределяет

Cake\Routing\Route\Route::parse()

__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, расширение

_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|строка|массив $extensions необязательно null

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

Возвращает

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

getExtensions()source public

getExtensions( )

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

Возвращает

array

getMiddleware()source public

getMiddleware( )

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

Возвращает

array

getName()source public

getName( )

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

Возвращает

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 )

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

Параметры

array $middleware

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

Возвращает

$this

setPass()source public

setPass( array $names )

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

Параметры

array $names

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

Возвращает

$this

setPatterns()source public

setPatterns( array $patterns )

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

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

Параметры

array $patterns

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

Возвращает

$this

setPersist()source public

setPersist( array $names )

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

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

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

Параметры

array $names

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

Возвращает

$this

staticPath()source public

staticPath( )

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

Возвращает

string