Класс CommonSenderComponent

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

Открытые члены
	executeComponent ()
	getEditAction ()
	getViewAction ()
Открытые члены унаследованные от CBitrixComponent
	onPrepareComponentParams ($arParams)
	onIncludeComponentLang ()
	__construct ($component=null)
	getName ()
	getRelativePath ()
	getPath ()
	getTemplateName ()
	setTemplateName ($templateName)
	setSiteTemplateId ($siteTemplateId)
	getSiteTemplateId ()
	setSiteId ($siteId)
	getSiteId ()
	setLanguageId ($languageId)
	getLanguageId ()
	getSignedParameters ()
	getTemplatePage ()
	getTemplate ()
	getParent ()
	getTemplateCachedData ()
	setTemplateCachedData ($templateCachedData)
	initComponent ($componentName, $componentTemplate=false)
	__prepareComponentParams (&$arParams)
	includeComponentLang ($relativePath="", $lang=false)
	includeComponentTemplate ($templatePage="", $customTemplatePath="")
	initComponentTemplate ($templatePage="", $siteTemplate=false, $customTemplatePath="")
	showComponentTemplate ()
	addIncludeAreaIcon ($arIcon)
	addIncludeAreaIcons ($arIcons)
	getIncludeAreaIcons ()
	getCacheID ($additionalCacheID=false)
	startResultCache ($cacheTime=false, $additionalCacheID=false, $cachePath=false)
	endResultCache ()
	abortResultCache ()
	clearResultCache ($additionalCacheID=false, $cachePath=false)
	getCachePath ()
	setResultCacheKeys ($arResultCacheKeys)
	getEditAreaId ($entryId)
	addEditAction ($entryId, $editLink, $editTitle=false, $arParams=array())
	addDeleteAction ($entryId, $deleteLink, $deleteTitle=false, $arParams=array())
	setTemplateEpilog ($arEpilogInfo)
	__showError ($errorMessage, $errorCode="")
	addChildCSS ($cssPath)
	addChildJS ($jsPath)
	addChildEpilog ($epilogFile)
	addChildFrame ($frame)
	addEditButton ($arButton)
	addViewTarget ($target, $content, $pos)
	randString ($length=6)
	setFrameMode ($mode)
	getFrameMode ()
	getRealFrameMode ()
	getDefaultFrameMode ()

Защищенные члены
	checkRequiredParams ()
	initParams ()
	canEdit ()
	printErrors ()
	checkComponentExecution ()
	getAccessController ()
	prepareResultAndTemplate ($template="")
	prepareResult ()
Защищенные члены унаследованные от CBitrixComponent
	listKeysSignedParameters ()
	__includeComponent ()

Защищенные данные
	$errors
	$userId
	$accessController
Защищенные данные унаследованные от CBitrixComponent
	$request
	$signedParameters

Дополнительные унаследованные члены
Открытые статические члены унаследованные от CBitrixComponent
static	includeComponentClass ($componentName)
static	clearComponentCache ($componentName, $siteId="")
Поля данных унаследованные от CBitrixComponent
	$__name = ""
	$__path = ""
	$__templatePage = ""
	$__template = null
	$arParams = array()
	$arResult = array()
	$arResultCacheKeys = false
	$__parent = null

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

См. определение в файле commonsendercomponent.php строка 29

Методы

canEdit()

canEdit ( )

protected

См. определение в файле commonsendercomponent.php строка 88

checkComponentExecution()

checkComponentExecution ( )

protected

См. определение в файле commonsendercomponent.php строка 117

checkRequiredParams()

checkRequiredParams ( )

protected

См. определение в файле commonsendercomponent.php строка 43

executeComponent()

executeComponent

(

)

Function calls __includeComponent in order to execute the component.

Возвращает

mixed

Переопределяет метод предка CBitrixComponent.

См. определение в файле commonsendercomponent.php строка 143

getAccessController()

getAccessController ( )

protected

См. определение в файле commonsendercomponent.php строка 134

getEditAction()

getEditAction ( )

abstract

getViewAction()

getViewAction ( )

abstract

initParams()

initParams ( )

protected

Initialization of component parameters. Validating access to the modify action by Permission Entity Code parameter

См. определение в файле commonsendercomponent.php строка 67

prepareResult()

prepareResult ( )

abstractprotected

prepareResultAndTemplate()

prepareResultAndTemplate ( $template = "" )

protected

Аргументы

string

$template

Возвращает

array|void

См. определение в файле commonsendercomponent.php строка 178

printErrors()

printErrors ( )

protected

См. определение в файле commonsendercomponent.php строка 108

Поля

$accessController

$accessController

protected

См. определение в файле commonsendercomponent.php строка 41

$errors

$errors

protected

См. определение в файле commonsendercomponent.php строка 32

$userId

$userId

protected

См. определение в файле commonsendercomponent.php строка 36

---

Объявления и описания членов класса находятся в файле:

• C:/bitrix/modules/sender/lib/internals/commonsendercomponent.php