Граф наследования:RouteAbstract:

Открытые члены
	__construct ($id, $patterns, $defaults, $description, $hide=false)

	getId ()

	match ($host, $uri, $autoset=true)

	getHttpRequest ()

	getController ()

	getAction ()

	getDescription ()

	buildUrl ($params, $absolute=false)

	setSiteContext (Site $site)

	getSiteContext ()

	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 = []

	$site

Защищенные данные
	$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	- абсолютный или относительный путь строить

Возвращает: string

getAction ( )

Возвращает имя метода контроллера, который соответствует данному URI

getController ( )

Возвращает имя класса контроллера, который соответствует данному URI

getDescription ( )

Возвращает описание страницы для данного маршрута

getExtra	(	$key,
		$default = `null`
	)

Возвращает данные из секции extra по ключу

Аргументы

string	$key	- ключ
mixed	$default	- значение по умолчанию

Возвращает: mixed

getHttpRequest ( )

Возвращает объект URL

Возвращает

getId ( )

Возвращает идентификатор маршрута

getPatterns ( )

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

Возвращает: array

getPatternsView ( )

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

Возвращает: array

getSiteContext ( )

Возвращает сайт, в контексте которого строятся URL

Возвращает: false|Site

isAdmin ( $bool = null )

Возвращает true, если данный url принадлежит административной панели

Аргументы

mixed $bool

Возвращает: boolean

isHidden ( )

Возвращает true, если маршрут скрытый

isUnknown ( )

Возвращает true, если этот маршрут - заглушка, иначе - false

match	(	$host,
		$uri,
		$autoset = `true`
	)

Возвращает true в случае если маршрут соответствует текущему URL

Аргументы

string	$host	- хост
string	$uri	- REQUEST_URI
boolean	$autoset	- устанавливать автоматически, параметры из GET запроса

Возвращает: bool

setSiteContext ( Site $site )

Устанавливает сайт, в контексте которого будут строиться URL

Аргументы

Site $site

Возвращает: $this

Поля

$defaults = []

$description

$extra = []

$hide = false

$http_request

staticprotected

$id

protected

$is_admin = false

$match

$patterns = []

$site

const ACTION_PARAM = 'Act'

const CONTROLLER_PARAM = 'controller'

const DEFAULT_ACTION = 'index'

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

Поля данных

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

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

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

Методы

Поля