Spec-Zone.ru › CakePHP 2.10

Класс RedirectRoute

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

CakeRoute
Extended by RedirectRoute
Пакет: Cake\Маршрутизация\Маршрут
Авторские права: Copyright (c) Cake Software Foundation, Inc. (https://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 статический

__set_state( array $fields )

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

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

Параметры

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

Возвращает

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

_matchNamed()source protected

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

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

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

Параметры

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

Возвращает

логическое значение

_parseArgs()source protected

_parseArgs( string $args , string $context )

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

Параметры

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

Возвращает

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

_writeRoute()source protected

_writeRoute( )

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

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

_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 boolean

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

true
END_OF_DOCUMENT_MARKER

© 2005–2017 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.10/class-RedirectRoute.html

Spec-Zone.ru

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