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

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

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

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

setStatus()source public

setStatus( integer $status )

Устанавливает HTTP-статус

Параметры

целое число $status

Код состояния для этого маршрута

Возвращает

$this

__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. В настоящее время реализованы типы правил контроллер, действие и совпадение, которые можно комбинировать друг с другом.

Параметры

строка $args

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

строка $context

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

Возвращает

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

_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( )

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

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

_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|string|array $extensions необязательно null

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

Возвращает

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

getExtensions()source public

getExtensions( )

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

Возвращает

array

getMiddleware()source public

getMiddleware( )

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

Возвращает

array

getName()source public

getName( )

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

Возвращает

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 )

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

Параметры

array $middleware

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

Возвращает

$this

setPass()source public

setPass( array $names )

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

Параметры

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