Класс RedirectRoute

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

CakeRoute

RedirectRoute

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

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

$redirect public

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

CakeResponse
Объект CakeResponse
$stop public

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

Наследованные свойства

_compiledRoute, _greedy, _headerMap, defaults, keys, options, template

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

__construct() public
Конструктор
_stop() protected

Останавливает выполнение текущего сценария. Оборачивает exit(), что упрощает тестирование.
match() public
Обратный маршрутизация перенаправлений не поддерживается
parse() public

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

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

__construct()source public

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

Конструктор

Параметры

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

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

CakeRoute::__construct()

_stop()source protected

_stop( integer|string $code 0 )

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

Параметры

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

match()source public

match( array $url )

Обратный маршрутизация перенаправлений не поддерживается

Параметры

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

Возвращает

смешанный тип
либо false, либо строка URL.

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

CakeRoute::match()

parse()source public

parse( string $url )

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

Параметры

строка $url: URL для парсинга

Возвращает

булево значение
False при ошибке

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

CakeRoute::parse()

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

__set_state()source public static

__set_state( array $fields )

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

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

Параметры

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

Возвращает

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

_matchNamed()source protected

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

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

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

Параметры

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

Возвращает

булево значение

_parseArgs()source protected

_parseArgs( string $args , string $context )

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

Параметры

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

Возвращает

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

_writeRoute()source protected

_writeRoute( )

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

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

_writeUrl()source protected

_writeUrl( array $params )

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

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

Параметры

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

Возвращает

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

compile()source public

compile( )

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

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

Возвращает

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

compiled()source public

compiled( )

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

Возвращает

булево значение

persistParams()source public

persistParams( array $url , array $params )

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

Параметры

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

Возвращает

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

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

$redirectsource

public смешанный тип

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

$responsesource

public CakeResponse

Объект CakeResponse

null

$stopsource

public булево значение

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

true

END_OF_DOCUMENT_MARKER

© 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.
https://api.cakephp.org/2.9/class-RedirectRoute.html