Класс 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 deprecated

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