Версия: 6.x
Открытые члены | |
| __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) | |
Поля данных | |
| const | CONTROLLER_PARAM = 'controller' |
| const | ACTION_PARAM = 'Act' |
| const | DEFAULT_ACTION = 'index' |
| $match | |
| $patterns = [] | |
| $defaults = [] | |
| $is_admin = false | |
| $hide = false | |
| $description | |
| $extra = [] | |
Защищенные данные | |
| $id | |
Статические защищенные данные | |
| static | $http_request |
| __construct | ( | $id, | |
| $patterns, | |||
| $defaults, | |||
| $description, | |||
$hide = false |
|||
| ) |
Конструктор абстрактного класса для маршрутов (тип: регулярные выражения)
| string | $id | - идентификатор URI |
| string | array | $patterns | - Регулярное выражение для URI |
| array | null | $defaults | - значения по умолчанию для переменных из URI |
| string | $description | - Текстовое описание страницы по данному URI |
| bool | $hide | - скрывать маршрут в списках в административной панели. Рекомендуется для системных маршрутов. |
| addExtra | ( | $key, | |
| $value | |||
| ) |
Добавляет произвольные данные в секцию extra
| string | $key | - ключ |
| mixed | $value | - значение |
| buildUrl | ( | $params, | |
$absolute = false |
|||
| ) |
Возвращает построенный URL по данному маршруту
| array | $params | - параметры запроса |
| boolean | $absolute | - абсолютный или относительный путь строить |
| getAction | ( | ) |
Возвращает имя метода контроллера, который соответствует данному URI
| getController | ( | ) |
Возвращает имя класса контроллера, который соответствует данному URI
| getDescription | ( | ) |
Возвращает описание страницы для данного маршрута
| getExtra | ( | $key, | |
$default = null |
|||
| ) |
Возвращает данные из секции extra по ключу
| string | $key | - ключ |
| mixed | $default | - значение по умолчанию |
| getHttpRequest | ( | ) |
Возвращает объект URL
| getId | ( | ) |
Возвращает идентификатор маршрута
| getPatterns | ( | ) |
Возвращает регулярные выражения, заданные для маршрута
| getPatternsView | ( | ) |
Возвращает регулярные выражения, заданные для маршрута в читаемом виде
| isAdmin | ( | $bool = null | ) |
Возвращает true, если данный url принадлежит административной панели
| mixed | $bool |
| isHidden | ( | ) |
Возвращает true, если маршрут скрытый
| isUnknown | ( | ) |
Возвращает true, если этот маршрут - заглушка, иначе - false
| match | ( | $host, | |
| $uri, | |||
$autoset = true |
|||
| ) |
Возвращает true в случае если маршрут соответствует текущему URL
| string | $host | - хост |
| string | $uri | - REQUEST_URI |
| boolean | $autoset | - устанавливать автоматически, параметры из GET запроса |
| $defaults = [] |
| $description |
| $extra = [] |
| $hide = false |
|
staticprotected |
|
protected |
| $is_admin = false |
| $patterns = [] |
| const ACTION_PARAM = 'Act' |
| const CONTROLLER_PARAM = 'controller' |
| const DEFAULT_ACTION = 'index' |