Spec-Zone.ru › CakePHP 3.1

Класс RedirectRoute

Маршрут перенаправления выполнит немедленное перенаправление. Маршруты перенаправления полезны, когда вы хотите, чтобы перенаправления слоя маршрутизации происходили в вашем приложении, для случаев, когда URL перемещаются.

Cake\Routing\Route\Route
Extended by Cake\Routing\Route\RedirectRoute
Пространство имён: Cake\Routing\Route
Расположение Routing/Route/RedirectRoute.php

Подробное описание методов

__constructsource public

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

Конструктор

Параметры

строка $template
Шаблонная строка с заменителями параметров
массив|строка $defaults необязательно []
Значения по умолчанию для маршрута.
массив $options необязательно []
Массив дополнительных опций для маршрута

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

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

matchsource public

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

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

Параметры

массив $url
Массив параметров для преобразования в строку.
массив $context необязательно []
Массив параметров контекста запроса.

Возвращает

boolean
Всегда false.

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

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

parsesource public

parse( string $url )

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

Параметры

строка $url
URL для разбора.

Возвращает

false|null
False при ошибке, иначе null.

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

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

Методы, унаследованные от Cake\Routing\Route\Route

__set_statesource public static

__set_state( array $fields )

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

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

Параметры

массив $fields
Ключ/Значение атрибутов объекта

Возвращает

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

_matchMethodsource protected

_matchMethod( array $url )

Проверяет, соответствует ли HTTP-метод URL.

Параметры

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

Возвращает

boolean
bool

_parseArgssource protected

_parseArgs( string $args , string $context )

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

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

Параметры

строка $args
Строка с переданными параметрами. Пример: /1/foo
строка $context
Текущий контекст маршрута, который должен содержать ключи controller/action.

Возвращает

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

_parseExtensionsource protected

_parseExtension( string $url )

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

Параметры

строка $url
URL для разбора.

Возвращает

array
содержащий URL, расширение

_persistParamssource protected

_persistParams( array $url , array $params )

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

Параметры

массив $url
Массив, к которому применяются постоянные параметры.
массив $params
Массив постоянных значений для замены постоянных.

Возвращает

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

_writeRoutesource protected

_writeRoute( )

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

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

_writeUrlsource protected

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

Преобразует соответствующий массив маршрута в строку URL.

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

Параметры

массив $params
Параметры для преобразования в строковый URL
массив $pass необязательно []
Дополнительные переданные аргументы
массив $query необязательно []
Массив параметров

Возвращает

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

compilesource public

compile( )

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

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

Возвращает

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

compiledsource public

compiled( )

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

Возвращает

boolean
bool

extensionssource public

extensions( null|string|array $extensions null )

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

Параметры

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

Возвращает

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

getNamesource public

getName( )

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

Возвращает

string
строка

staticPathsource public

staticPath( )

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

Возвращает

string
строка

Резюме свойств

$redirectsource

public массив|строка

Место назначения перенаправления. Либо строка, либо CakePHP массив URL.

$responsesource

public Cake\Network\Response

Объект Response

null

Свойства, унаследованные от Cake\Routing\Route\Route

$_compiledRoutesource

protected строка

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

null

$_extensionssource

protected массив

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

[]

$_greedysource

protected строка

Является ли этот маршрут жадным? Жадные маршруты имеют /* в своём шаблоне

false

$_namesource

protected строка

Имя маршрута. Получите с помощью Route::getName();

null

$defaultssource

public массив

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

[]

$keyssource

public массив

Массив именованных сегментов в маршруте. /:controller/:action/:id имеет 3 ключевых элемента

[]

$optionssource

public массив

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

[]

$templatesource

public строка

Строка шаблона маршрута.

null

© 2005–2016 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
http://api.cakephp.org/3.1/class-Cake.Routing.Route.RedirectRoute.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API