Версия: 5.x
Класс Route
Граф наследования:Route:
RouteAbstract CustomRoute

Подробное описание

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

Открытые члены

 __construct ($id, $masks, $defaults, $description, $hide=false, $wrap_pattern= '^{pattern}$')
 
 buildUrl ($params=array(), $absolute=false, $mask_key=null)
 
 getPatternsView ()
 
- Открытые члены унаследованные от RouteAbstract
 __construct ($id, $patterns, $defaults, $description, $hide=false)
 
 getId ()
 
 match ($host, $uri, $autoset=true)
 
 getHttpRequest ()
 
 getController ()
 
 getAction ()
 
 getDescription ()
 
 buildUrl ($params, $absolute=false)
 
 getPatterns ()
 
 getPatternsView ()
 
 isAdmin ($bool=null)
 
 isUnknown ()
 
 isHidden ()
 
 addExtra ($key, $value)
 
 getExtra ($key, $default=null)
 

Поля данных

 $keys_in_mask = array()
 
 $masks
 
- Поля данных унаследованные от RouteAbstract
const CONTROLLER_PARAM = 'controller'
 
const ACTION_PARAM = 'Act'
 
const DEFAULT_ACTION = 'index'
 
 $match
 
 $patterns = array()
 
 $defaults = array()
 
 $is_admin = false
 
 $hide = false
 
 $description
 
 $extra = array()
 

Защищенные члены

 findKey ($params)
 

Защищенные данные

 $cache = array()
 
- Защищенные данные унаследованные от RouteAbstract
 $id
 

Статические защищенные данные

static $cache_site_folder
 
- Статические защищенные данные унаследованные от RouteAbstract
static $http_request
 

Конструктор(ы)

__construct (   $id,
  $masks,
  $defaults,
  $description,
  $hide = false,
  $wrap_pattern = '^{pattern}$' 
)

Конструктор абстрактного класса для маршрутов (тип: маска в формате ReadyScript)

Допустимые варианты спользования маски ReadyScript: /product/{alias}/ - запишет вторую секцию в переменную alias /product/{alias:[]+}/ - маршрут сработает, только если alias будет числом Чтобы маршрут сработал, должно произойти соответствие по левой части маски. Например: для url: http://domain.ru/product/phone-360gs/comments/ /product/ - сработает маршрут /comments/ - НЕ сработает маршрут

Аргументы
string$id- идентификатор URI
string  | array$masks- Маска для URI в формате ReadyScript.
array  |  null$defaults- значения по умолчанию для переменных из URI
string$description- Текстовое описание страницы по данному URI
booleanhide - Скрывать из списков в админ. панели
string$wrap_pattern- Обрамляющий шаблон для регулярного выражения

Методы

buildUrl (   $params = array(),
  $absolute = false,
  $mask_key = null 
)

Возвращает Uri с нужными параметрами

Аргументы
array$paramsпараметры для uri
bool$absoluteесли true, то вернет абсолютный путь
mixed$mask_keyиндекс маски по которой будет строиться url, если не задан, то будет определен автоматически
findKey (   $params)
protected

Возвращает ключ наиболее подходящего Uri маршрута для построения ссылки

Аргументы
array$params
getPatternsView ( )

Возвращает регулярные выражения, заданные для маршрута в читаемом виде

Возвращает
array

Поля

$cache = array()
protected
$cache_site_folder
staticprotected
$keys_in_mask = array()
$masks