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

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

Этот класс должен быть родителем клиентского контроллера модуля.

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

	getParamObject ()

	exec ($returnAsIs=false)

	updateParamCache ()

	getStoreParams ()

	getBlockId ()

	myGet ($key, $type, $default=null)

	myBlockIdInput ()

	isMyPost ()

	getSettingUrl ($absolute=false)

Открытые члены унаследованные от AbstractClient
	__construct ($param=[])

	isConstructorBlock ()

	getDebugGroup ()

	wrapHtml ($body, $html_template=null)

Открытые члены унаследованные от 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 ()

Открытые статические члены
static	getInfo ($key=null)

static	getNotReplaceableParams ()

static	isVisibleOnSiteConstructor ()

Поля данных
const	BLOCK_ID_PARAM = '_block_id'

const	BLOCK_PATH_PARAM = 'tplpath'

const	BLOCK_NUM_PARAM = 'num'

const	BLOCK_LOADED_FROM_DB_PARAM = 'params_loaded_from_db'

const	BLOCK_INSERT_CONTEXT = 'theme_context'

Поля данных унаследованные от AbstractClient
	$debug_group = null

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

	$view

	$url

	$app

	$router

Защищенные члены
	appendParamsFromDb ($param)

	loadStoredParams ()

Защищенные члены унаследованные от AbstractClient
	isDebugModeEnabled ()

	canProcessResult ()

Защищенные статические члены
static	getSelfNotReplaceableParams ()

static	getAlwaysNotReplaceableParams ()

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

	$action_var = null

	$store_params

	$store_key

Защищенные данные унаследованные от AbstractModule
	$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

Статические защищенные данные
static	$controller_title = ''

static	$controller_description = ''

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

__construct ( $param = [] )

Block constructor.

Аргументы

array $param

Методы

appendParamsFromDb ( $param )

protected

Добавляет необходимые параметры из БД для блоков, добавленных не по сетке в клиентской части сайта

Аргументы

array $param - Параметры по умолчанию

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

exec ( $returnAsIs = false )

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

Аргументы

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

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

Исключения

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

static getAlwaysNotReplaceableParams ( )

staticprotected

Возвращает список параметров, которые не изменяются при редактировании через "режим отладки"

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

getBlockId ( )

Возвращает id блока, который можно использовать в URL для обращения к данному блоку. По данному id будут загружены все параметры($this->param) для блока

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

static getInfo ( $key = null )

static

Возвращает информацию о текущем контроллере.

Аргументы

string $key - параметр информации, который нужно вернуть

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

static getNotReplaceableParams ( )

static

Возвращает список параметров, которые не изменяются при редактировании через "режим отладки"

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

getParamObject ( )

Возвращает ORM объект, содержащий настриваемые параметры или false в случае, если контроллер не поддерживает настраиваемые параметры

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

static getSelfNotReplaceableParams ( )

staticprotected

Возвращает список параметров, которые не изменяются при редактировании через "режим отладки"

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

getSettingUrl ( $absolute = false )

Возвращает URL для настройки блока (в случае если используется сборка по сетке)

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

getStoreParams ( )

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

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

isMyPost ( )

Возвращает true, если инициатором POST запроса выступил данный контроллер

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

static isVisibleOnSiteConstructor ( )

static

Возвращает true, если Блок нужно отобразить в списке Блоков в конструкторе сайта. Иначе - false.

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

loadStoredParams ( )

protected

Загружает параметры из кэша

myBlockIdInput ( )

Возвращает input[type="hidden"] с id блочного контроллера, чтобы отметить, что данный пост идет по его инициативе.

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

myGet	(	$key,
		$type,
		$default = `null`
	)

Возвращает значение параметра из get только если запрос идет конкретно к текущему контроллеру.

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

updateParamCache ( )

Обновляет сохраненные в кэше параметры текущего блока

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

Поля

$action_var = null

protected

$block_id_cache

protected

$controller_description = ''

staticprotected

$controller_title = ''

staticprotected

$store_key

protected

$store_params

protected

const BLOCK_ID_PARAM = '_block_id'

const BLOCK_INSERT_CONTEXT = 'theme_context'

const BLOCK_LOADED_FROM_DB_PARAM = 'params_loaded_from_db'

const BLOCK_NUM_PARAM = 'num'

const BLOCK_PATH_PARAM = 'tplpath'

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

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

Открытые статические члены

Поля данных

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

Защищенные статические члены

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

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

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

Методы

Поля