Класс RedirectRoute

__construct()source public

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

Конструктор

Параметры

string $template

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

array|string $defaults необязательно []

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

array $options необязательно []

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

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

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

match()source public

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

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

Параметры

array $url

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

array $context необязательно []

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

Возвращает

boolean
Всегда false.

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

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

parse()source public

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

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

Параметры

string $url

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

string $method необязательно ''

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

Возвращает

boolean|null
False при неудаче. При успешном сопоставлении вызывается исключение.

Исключения

Cake\Routing\Exception\RedirectException

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

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

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

setStatus()source public

setStatus( integer $status )

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

Параметры

integer $status

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

Возвращает

$this

__set_state()source public static

__set_state( array $fields )

Магический метод установки состояния для поддержки var_export

Этот метод полезен для приложений, которые хотят реализовать кэширование маршрутизатора.

Параметры

array $fields

Ключи/Значения атрибутов объекта

Возвращает

Cake\Routing\Route\Route
Новый экземпляр маршрута

_matchMethod()source protected

_matchMethod( array $url )

Проверяет соответствие HTTP-метода URL-адреса.

Параметры

array $url

Массив для генерируемого URL-адреса.

Возвращает

boolean

_parseArgs()source protected

_parseArgs( string $args , string $context )

Разбирает переданные параметры в список переданных аргументов.

Возвращает true, если переданное значение $param совпадает с заданным $rule, в зависимости от $context. В настоящее время реализованы типы правил: controller, action и match, которые могут быть объединены.

Параметры

string $args

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

string $context

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

Возвращает

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

_parseExtension()source protected

_parseExtension( string $url )

Удаляет расширение из $url, если оно содержит зарегистрированное расширение. Если зарегистрированное расширение не найдено, расширение не возвращается, и URL возвращается без изменений.

Параметры

string $url

URL для разбора.

Возвращает

array
содержащий url, extension

_persistParams()source protected

_persistParams( array $url , array $params )

Применяет постоянные параметры к массиву URL. Постоянные параметры — это специальный ключ, используемый во время создания маршрута, чтобы заставить параметры маршрута сохраняться при их отсутствии в массиве URL.

Параметры

array $url

Массив, к которому нужно применить постоянные параметры.

array $params

Массив постоянных значений для замены постоянных значений.

Возвращает

array
Массив с применёнными постоянными параметрами.

_writeRoute()source protected

_writeRoute( )

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

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

_writeUrl()source protected

_writeUrl( array $params , array $pass = [] , array $query = [] )

Преобразует массив совпавшего маршрута в строку URL.

Создаёт строковый URL, используя шаблон, использованный для создания маршрута.

Параметры

array $params

Параметры для преобразования в строковый URL

array $pass необязательно []

Дополнительные переданные аргументы

array $query необязательно []

Массив параметров

Возвращает

string
Сгенерированная строка маршрута.

compile()source public

compile( )

Компилирует регулярное выражение маршрута.

Изменяет свойство defaults, чтобы все необходимые ключи были установлены, и заполняет $this->names именованными элементами маршрутизации.

Возвращает

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

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 )

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

Если какие-либо из ваших шаблонов содержат многобайтовые значения, будет включён режим 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