Класс CakeRoute

__constructsource public

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

Конструктор для маршрута

Параметры

строка $template

Шаблонная строка с заполнительными параметрами

массив $defaults необязательно array()

Массив значений по умолчанию для маршрута.

массив $options необязательно array()

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

__set_statesource public static

__set_state( array $fields )

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

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

Параметры

массив $fields

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

Возвращает

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

_matchNamedsource protected

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

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

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

Параметры

строка $val

Значение именованного параметра

массив $rule

Применяемое правило(а), также может быть строкой match

строка $context

Массив с дополнительной контекстной информацией (контроллер/действие)

Возвращает

boolean
bool

_parseArgssource protected

_parseArgs( string $args , string $context )

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

Параметры

строка $args

Строка с переданными и именованными параметрами, например /1/page:2

строка $context

Текущий контекст маршрута, который должен содержать ключи контроллера/действия.

Возвращает

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

_writeRoutesource protected

_writeRoute( )

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

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

_writeUrlsource protected

_writeUrl( array $params )

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

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

Параметры

массив $params

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

Возвращает

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

compilesource public

compile( )

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

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

Возвращает

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

compiledsource public

compiled( )

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

Возвращает

boolean
bool

matchsource public

match( array $url )

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

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

Параметры

массив $url

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

Возвращает

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

parsesource public

parse( string $url )

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

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

Параметры

строка $url

URL для попытки анализа.

Возвращает

mixed
Логическое значение false при неудаче, в противном случае массив параметров

persistParamssource public

persistParams( array $url , array $params )

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

Параметры

массив $url

Массив, к которому применяются постоянные параметры.

массив $params

Массив постоянных значений для замены постоянных значений.

Возвращает

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

null

false

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

array()

array()

array()

null