Класс CakeRoute

__construct()source public

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

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

Параметры

строка $template

Строка-шаблон с заполнительми параметров

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

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

массив $options необязательно 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's $val соответствует заданному правилу $rule в зависимости от $context. В настоящее время реализованы типы правил: контроллер, действие и соответствие, которые могут быть объединены друг с другом.

Параметры

строка $val

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

массив $rule

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

строка $context

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

Возвращает

boolean

_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( )

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

Возвращает

boolean

match()source public

match( array $url )

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

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

Параметры

массив $url

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

Возвращает

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

parse()source public

parse( string $url )

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

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

Параметры

строка $url

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

Возвращает

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

persistParams()source public

persistParams( array $url , array $params )

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

Параметры

массив $url

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

массив $params

Массив постоянных значений, которые нужно заменить существующими.

Возвращаемое значение

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

null

false

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

array()

array()

array()

null