Spec-Zone.ru › CakePHP 2.10

Класс CakeRoute

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

Обычно не создается как самостоятельный объект. Используйте Router::connect() для создания маршрутов для вашего приложения.

Прямые подклассы

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

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

  • $_compiledRoute protected
    string
    Скомпилированное регулярное выражение маршрута
  • $_greedy protected
    string

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

  • $_headerMap protected
    array
    Краткое отображение заголовков HTTP. Используется для оценки выражений маршрута, основанных на заголовках.
  • $defaults public
    array
    Параметры по умолчанию для маршрута
  • $keys public
    array

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

  • $options public
    array
    Массив дополнительных параметров для маршрута.
  • $template public
    string
    Строка шаблона маршрута.

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

  • __construct() public
    Конструктор маршрута
  • __set_state() public static
    Магический метод для установки состояния для поддержки var_export
  • _matchNamed() protected
    Проверка соответствия именованного параметра текущим правилам.
  • _parseArgs() protected

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

  • _writeRoute() protected
    Создание регулярного выражения маршрута.
  • _writeUrl() protected
    Преобразование массива соответствующего маршрута в строку URL.
  • compile() public
    Компиляция регулярного выражения маршрута.
  • compiled() public
    Проверка, был ли маршрут скомпилирован в регулярное выражение.
  • match() public
    Проверка, соответствует ли массив URL этому экземпляру маршрута.
  • parse() public
    Проверка, может ли данный URL быть проанализирован этим маршрутом.
  • persistParams() public

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

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

__construct()source public 

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

Конструктор маршрута

Параметры

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

__set_state()source public static 

__set_state( array $fields )

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

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

Параметры

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

Возвращает

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

_matchNamed()source protected 

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

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

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

Параметры

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

Возвращает

boolean

_parseArgs()source protected 

_parseArgs( string $args , string $context )

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

Параметры

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

Возвращает

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

_writeRoute()source protected 

_writeRoute( )

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

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

_writeUrl()source protected 

_writeUrl( array $params )

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

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

Параметры

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

Возвращает

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

compile()source public 

compile( )

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

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

Возвращает

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

compiled()source public 

compiled( )

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

Возвращает

boolean

match()source public 

match( array $url )

Проверка, соответствует ли массив URL этому экземпляру маршрута.

Если URL соответствует параметрам и настройкам маршрута, возвращается сгенерированная строка URL. Если URL не соответствует параметрам маршрута, возвращается false. Этот метод обрабатывает обратную маршрутизацию или преобразование массивов URL в строки URL.

Параметры

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

Возвращает

mixed
Строка URL для параметров, если они совпадают, или false.

parse()source public 

parse( string $url )

Проверка, может ли данный URL быть проанализирован этим маршрутом.

Если маршрут может быть проанализирован, будет возвращен массив параметров; в противном случае будет возвращено false. Строки URL анализируются, если они соответствуют регулярному выражению маршрута.

Параметры

строка $url
URL для попытки анализа.

Возвращает

mixed
Ложь в случае неудачи, в противном случае массив параметров

persistParams()source public 

persistParams( array $url , array $params )

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

Параметры

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

Возвращает

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

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

$_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–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-CakeRoute.html

Spec-Zone.ru

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