Класс CakeRoute

__construct()source public

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

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

Параметры

string $template

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

array $defaults optional array()

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

array $options optional array()

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

__set_state()source public static

__set_state( array $fields )

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

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

Параметры

array $fields

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

Возвращает

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

_matchNamed()source protected

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

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

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

Параметры

string $val

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

array $rule

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

string $context

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

Возвращает

boolean

_parseArgs()source protected

_parseArgs( string $args , string $context )

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

Параметры

string $args

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

string $context

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

Возвращает

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

_writeRoute()source protected

_writeRoute( )

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

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

_writeUrl()source protected

_writeUrl( array $params )

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

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

Параметры

array $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.

Параметры

array $url

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

Возвращает

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

parse()source public

parse( string $url )

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

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

Параметры

string $url

URL для попытки парсинга.

Возвращает

mixed
Логическое значение 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