Spec-Zone.ru › CakePHP 2.7

Класс RedirectRoute

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

CakeRoute
Extended by RedirectRoute
Пакет: Cake\Routing\Route
Авторские права: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: MIT License
Расположение Cake/Routing/Route/RedirectRoute.php

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

__constructsource public

__construct( string $template , array $defaults array() , array $options array() )

Конструктор

Параметры

строка $template
Шаблонная строка с параметрами-заполнителями
массив $defaults необязательный array()
Массив значений по умолчанию для маршрута.
массив $options необязательный array()
Массив дополнительных параметров для маршрута

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

CakeRoute::__construct()

_stopsource protected

_stop( integer|string $code 0 )

Останавливает выполнение текущего скрипта. Оборачивает exit(), что упрощает тестирование.

Параметры

целое число/строка $code необязательный 0
См. http://php.net/exit для значений

matchsource public

match( array $url )

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

Параметры

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

Возвращает

mixed
либо false, либо строку URL.

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

CakeRoute::match()

parsesource public

parse( string $url )

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

Параметры

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

Возвращает

boolean
False при ошибке

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

CakeRoute::parse()

Методы, унаследованные от CakeRoute

__set_statesource public static

__set_state( array $fields )

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

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

Параметры

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

Возвращает

CakeRoute
Новый экземпляр маршрута

_matchNamedsource protected

_matchNamed( string $val , array $rule , string $context )

Проверяет, соответствует ли именованный параметр текущим правилам.

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

Параметры

строка $val
Значение именованного параметра
массив $rule
Правила (правила) для применения, также может быть строкой match
строка $context
Массив с дополнительной информацией о контексте (controller / action)

Возвращает

boolean
bool

_parseArgssource protected

_parseArgs( string $args , string $context )

Разбирает переданные и именованные параметры в список переданных аргументов и хеш именованных параметров. Будут использованы локальные и глобальные настройки для именованных параметров.

Параметры

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

Возвращает

array
Массив ($pass, $named)

_writeRoutesource protected

_writeRoute( )

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

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

_writeUrlsource protected

_writeUrl( array $params )

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

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

Параметры

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

Возвращает

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

compilesource public

compile( )

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

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

Возвращает

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

compiledsource public

compiled( )

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

Возвращает

boolean
bool

persistParamssource public

persistParams( array $url , array $params )

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

Параметры

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

Возвращает

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

Краткое описание свойств

$redirectsource

public mixed

Место перенаправления. Строка или массив URL CakePHP.

$responsesource

public CakeResponse

Объект CakeResponse

null

$stopsource

public boolean

Флаг для отключения exit() при разборе URL-адреса этим маршрутом.

true

Свойства, унаследованные от CakeRoute

$_compiledRoutesource

protected строка

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

null

$_greedysource

protected строка

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

false

$_headerMapsource

protected массив

Карта сокращений HTTP-заголовков. Используется для оценки выражений маршрута, основанных на заголовках.

array(
    'type' => 'content_type',
    'method' => 'request_method',
    'server' => 'server_name'
)

$defaultssource

public массив

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

array()

$keyssource

public массив

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

array()

$optionssource

public массив

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

array()

$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/2.7/class-RedirectRoute.html

Spec-Zone.ru

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