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

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

Базовый контроллер для модулей.

Открытые члены
	__construct ($param=[])

	getParam ($key=null, $default=null, $checkempty=false)

	setParam ($key, $value=null)

	setResource ()

	getControllerName ()

	addResource ()

	init ()

	fetch ($tpl, $param_name= 'tpl')

	request ($key, $type, $default=null, $strip= '')

	getKeyName ($keyname)

	comError ($error_text)

	checkAccessRight ()

	exec ($returnAsIs=false)

	getDebugGroup ()

	getModTplPath ()

	getModuleConfig ()

Открытые члены унаследованные от AbstractController
	__construct ()

	isViewCacheExpired (string $cache_id_str, string $template, int $lifetime=null)

	wrapHtml ($body, $html_template=null)

	getAction ()

	exec ($returnAsIs=false)

	processResult ($result)

	presetAct ($act)

	e404 ($reason=null)

	redirect ($url=null, $status=302)

	refreshPage ()

	getUrlName ()

Открытые члены унаследованные от IController
	exec ()

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

	$access_right = 1

	$default_params = []

	$param = []

	$mod_name = ''

	$controller_name = ''

	$mod_css = '/modules/%MODULE%/view/css/'

	$mod_js = '/modules/%MODULE%/view/js/'

	$mod_img = '/modules/%MODULE%/view/img/'

	$mod_tpl = '/modules/%MODULE%/view/'

	$mod_relative_tpl = ''

Защищенные данные унаследованные от AbstractController
	$act = null

	$action_var = 'Act'

	$result

Дополнительные унаследованные члены
Поля данных унаследованные от AbstractController
const	DEFAULT_ERROR_PAGE_TPL = '%THEME%/exception.tpl'

	$view

	$url

	$app

	$router

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

__construct ( $param = [] )

Методы

addResource ( )

Здесь добавляем все css, js которые требует компонент

checkAccessRight ( )

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

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

Исключения

\RS\Exception

comError ( $error_text )

Возвращает ошибку $error_text, в удобном виде (обернутую в HTML)

Аргументы

string $error_text - текст ошибки

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

Исключения

\SmartyException

exec ( $returnAsIs = false )

Выполняет action(действие) текущего контроллера, возвращает результат действия

Аргументы

boolean $returnAsIs - возвращать как есть. Если true, то метод будет возвращать точно то, что вернет действие, иначе результат будет обработан методом processResult

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

Исключения

Exception
ExceptionPageNotFound
\RS\Event\Exception
\RS\Exception

fetch	(	$tpl,
		$param_name = `'tpl'`
	)

готовим результат компонента

Аргументы

string	$tpl	- путь к шаблону компонента
string	$param_name	- ключ параметра для опредления откуда дать шаблон

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

Исключения

Exception
\SmartyException

getControllerName ( )

Возввращает имя контроллера

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

getDebugGroup ( )

У контроллеров админки не может быть отладочной информации

Возвращает: | null

getKeyName ( $keyname )

Возвращает имя переменной с учетом префикса

Аргументы

string $keyname - префикс

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

getModTplPath ( )

Возвращает путь к шаблонам модуля

getModuleConfig ( )

Возвращает объект с конфигурацией модуля, к которому относится данный контроллер

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

getParam	(	$key = `null`,
		$default = `null`,
		$checkempty = `false`
	)

Возвращает значение параметра по ключу, заданного в конструкторе или default - если такового не существует Поиск значения по ключу также ведется в массиве $this->default_params, если не задан параметр $default Если ключ не задан, возвращает все параметры

Аргументы

string	$key	- название параметра, если key == null, то вернётся весь массив параметров
mixed	$default	- значение параметра по-умолчанию
bool	$checkempty	- Если true, то наличие значеня для key будет проверяться функцией empty иначе isset

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

init ( )

Функция, вызывающяся сразу после конструктора в случае успешной инициализации ничего не должна возвращать (null), в случае ошибки должна вернуть текст ошибки, который будет возвращен при вызове _exec();

request	(	$key,
		$type,
		$default = `null`,
		$strip = `''`
	)

Метод возвращает параметры из $_REQUEST с учетом установленных префиксов для компонента. (префиксы можно устанавливать, если на одной странице имеется несколько одинаковых компонентов)

Аргументы

string	$key	- ключ массив $_REQUEST
string	$type	- тип ожидаемых данных. Используйте константы: TYPE_STRING, TYPE_INTEGER, TYPE_ARRAY, TYPE_BOOLEAN, TYPE_FLOAT
mixed	$default	- значение по умолчанию
string	$strip	- Какие теги не вырезать? Если false, то теги не будут вырезаться, иначе можно указать теги, которые нужно оставить.

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

setParam	(	$key,
		$value = `null`
	)

Устанавливает параметры для текущего контроллера

Аргументы

string \| array	$key	ключ или массив ключей
mixed	$value	значение, если в $key была передана строка

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

setResource ( )

Устанавливает основные пути для компонента, исходя из его имени.

Исключения

Exception

Поля

$access_right = 1

protected

$controller_name = ''

protected

$default_params = []

protected

$mod_css = '/modules/%MODULE%/view/css/'

protected

$mod_img = '/modules/%MODULE%/view/img/'

protected

$mod_js = '/modules/%MODULE%/view/js/'

protected

$mod_name = ''

protected

$mod_relative_tpl = ''

protected

$mod_tpl = '/modules/%MODULE%/view/'

protected

$param = []

protected

$user

protected

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

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

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

Дополнительные унаследованные члены

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

Методы

Поля