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

Открытые члены
	onPrepareComponentParams ($arParams)
	onIncludeComponentLang ()
	executeComponent ()
	__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 ()

Открытые статические члены
static	includeComponentClass ($componentName)
static	clearComponentCache ($componentName, $siteId="")

Поля данных
	$__name = ""
	$__path = ""
	$__templatePage = ""
	$__template = null
	$arParams = array()
	$arResult = array()
	$arResultCacheKeys = false
	$__parent = null

Защищенные члены
	listKeysSignedParameters ()
	__includeComponent ()

Защищенные данные
	$request
	$signedParameters

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

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

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

◆ __construct()

__construct ( $component = null )

Constructor with ability to copy the component.

Аргументы

CBitrixComponent $component

Переопределяется в Base, Base, Entity, BaseUfComponent, EntitySelector, LogEntry, WorkgroupList и WorkgroupUserList.

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

Методы

◆ __includeComponent()

__includeComponent ( )

finalprotected

Function includes component.php file thus executing the component. Returns what component.php returns.

Before include there is some helper variables made available for component.php scope.

Note: component must be inited by initComponent method.

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

@noinspection PhpUnusedLocalVariableInspection

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

◆ __prepareComponentParams()

__prepareComponentParams ( & $arParams )

final

Helper function for component parameters safe html escaping.

Аргументы

array[string]mixed &$arParams

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

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

◆ __showError()

__showError	(		$errorMessage,
			$errorCode = "" )

Function shows an internal error message.

Аргументы

string	$errorMessage
string	$errorCode

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

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

◆ abortResultCache()

abortResultCache ( )

final

Function aborts the cache after it's start.

Note: must be called if component returns before endResultCache or includeComponentTemplate called.

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

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

◆ addChildCSS()

addChildCSS ( $cssPath )

final

Function registers children css file for cache.

Аргументы

string $cssPath

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

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

◆ addChildEpilog()

addChildEpilog ( $epilogFile )

final

Function registers children epilog file for cache.

Аргументы

string $epilogFile

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

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

◆ addChildFrame()

addChildFrame ( $frame )

final

Registers child frame for cache.

Аргументы

\Bitrix\Main\Composite\StaticArea $frame

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

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

◆ addChildJS()

addChildJS ( $jsPath )

final

Function registers children js file for cache.

Аргументы

string $jsPath

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

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

◆ addDeleteAction()

addDeleteAction	(	$entryId,
		$deleteLink,
		$deleteTitle = false,
		$arParams = array() )

final

Function adds an delete action to some area inside the component.

$arParams['CONFIRM'] = false - disable confirm;
$arParams['CONFIRM'] = 'Text' - confirm with custom text;
no $arParams['CONFIRM'] at all - confirm with default text

Аргументы

string	$entryId
string	$deleteLink
string \| bool	$deleteTitle
	array[string]mixed	$arParams

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

@global CMain $APPLICATION

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

◆ addEditAction()

addEditAction	(	$entryId,
		$editLink,
		$editTitle = false,
		$arParams = array() )

final

Function adds an edit action to some area inside the component.

Аргументы

string	$entryId
string	$editLink
string \| bool	$editTitle
	array[string]mixed	$arParams

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

@global CMain $APPLICATION

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

◆ addEditButton()

addEditButton ( $arButton )

final

Function adds a button to be displayed.

Аргументы

array[int]string $arButton

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

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

◆ addIncludeAreaIcon()

addIncludeAreaIcon ( $arIcon )

final

Function adds an Icon to the component area in the editing mode.

Аргументы

array[string]mixed $arIcon

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

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

◆ addIncludeAreaIcons()

addIncludeAreaIcons ( $arIcons )

final

Function replaces Icons displayed for the component by an collection.

Аргументы

array[int][string]mixed $arIcon

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

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

◆ addViewTarget()

addViewTarget	(	$target,
		$content,
		$pos )

final

Function registers new view target for the cache.

Аргументы

string	$target
string	$content
int	$pos

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

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

◆ clearComponentCache()

clearComponentCache	(		$componentName,
			$siteId = "" )

staticfinal

Function clears entire component cache.

Note: parameters must exactly match to startResultCache call.

Аргументы

string	$componentName
string	$siteId

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

@global CCacheManager $CACHE_MANAGER

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

◆ clearResultCache()

clearResultCache	(		$additionalCacheID = false,
			$cachePath = false )

final

Function deletes the cache created before.

Note: parameters must exactly match to startResultCache call.

Аргументы

mixed	$additionalCacheID
string \| bool	$cachePath

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

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

◆ endResultCache()

endResultCache ( )

final

Function ends the caching block of the component execution.

Note: automaticly called by includeComponentTemplate.

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

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

◆ executeComponent()

executeComponent ( )

Function calls __includeComponent in order to execute the component.

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

Переопределяется в StoreChart, ReportProductList, ReportStoreList, ReportStoreProfitList, Base, GridComponent, Entity, BaseUfComponent, GridComponent, BaseViewComponent, CommonSenderComponent, EntitySelector, CPullDemoComponent и CPullDemoWebrtcComponent.

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

◆ getCacheID()

getCacheID ( $additionalCacheID = false )

Function returns an cache identifier based on component parameters and environment.

Аргументы

mixed $additionalCacheID

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

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

◆ getCachePath()

getCachePath ( )

final

Function returns component cache path.

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

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

◆ getDefaultFrameMode()

getDefaultFrameMode ( )

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

◆ getEditAreaId()

getEditAreaId ( $entryId )

final

Function returns component area id for editing mode.

Аргументы

string $entryId

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

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

◆ getFrameMode()

getFrameMode ( )

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

◆ getIncludeAreaIcons()

getIncludeAreaIcons ( )

final

Function returns the collection of the Icons displayed for the component.

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

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

◆ getLanguageId()

getLanguageId ( )

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

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

◆ getName()

getName ( )

final

Function returns component name in form bitrix:component.name

Note: component must be inited by initComponent method.

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

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

◆ getParent()

getParent ( )

final

Function returns the parent component (if exists)

Note: component must be inited by initComponent method.

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

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

◆ getPath()

getPath ( )

final

Function returns path to component relative to Web server DOCUMENT_ROOT in form /bitrix/components/bitrix/component.name

Note: component must be inited by initComponent method.

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

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

◆ getRealFrameMode()

getRealFrameMode ( )

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

◆ getRelativePath()

getRelativePath ( )

final

Function returns path to component in form /bitrix/component.name

Note: component must be inited by initComponent method.

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

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

◆ getSignedParameters()

getSignedParameters ( )

final

Returns signed parameters. The list contains parameters which are presented in \CBitrixComponent::listKeysSignedParameters().

См. также: \CBitrixComponent::listKeysSignedParameters()

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

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

◆ getSiteId()

getSiteId ( )

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

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

◆ getSiteTemplateId()

getSiteTemplateId ( )

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

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

◆ getTemplate()

getTemplate ( )

final

Function returns the template object

Note: component must be inited by initComponent method.

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

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

◆ getTemplateCachedData()

getTemplateCachedData ( )

final

Function returns current template css files or null if there is no template.

Note: component must be inited by initComponent method.

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

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

◆ getTemplateName()

getTemplateName ( )

final

Function returns the name of the template

Note: component must be inited by initComponent method.

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

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

◆ getTemplatePage()

getTemplatePage ( )

final

Function returns the template page witch was set with initComponentTemplate

Note: component must be inited by initComponent method.

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

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

◆ includeComponentClass()

includeComponentClass ( $componentName )

staticfinal

Function includes class of the component by component name bitrix:component.base

Аргументы

string $componentName

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

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

◆ includeComponentLang()

includeComponentLang	(		$relativePath = "",
			$lang = false )

final

Function includes language files from within the component directory.

For example: $this->includeComponentLang("ajax.php") will include "lang/en/ajax.php" file.

Note: component must be inited by initComponent method.

Аргументы

string	$relativePath
string \| bool	$lang

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

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

◆ includeComponentTemplate()

includeComponentTemplate	(		$templatePage = "",
			$customTemplatePath = "" )

final

Function executes the template.

Note: component must be inited by initComponent method.

Аргументы

string	$templatePage
string	$customTemplatePath

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

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

◆ initComponent()

initComponent	(		$componentName,
			$componentTemplate = false )

final

Function initializes the component. Returns true on success.

It is absolutly necessery to call this function before any component usage.

Аргументы

string	$componentName
string \| bool	$componentTemplate

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

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

◆ initComponentTemplate()

initComponentTemplate	(	$templatePage = "",
		$siteTemplate = false,
		$customTemplatePath = "" )

final

Function initializes the template of the component. Returns true on success.

Instansiates the template object and calls it's init function.

Note: component must be inited by initComponent method.

Аргументы

string	$templatePage
string \| bool	$siteTemplate
string	$customTemplatePath

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

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

◆ listKeysSignedParameters()

listKeysSignedParameters ( )

protected

List of keys of parameters which the component have to sign,

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

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

◆ onIncludeComponentLang()

onIncludeComponentLang ( )

Event called from includeComponent before component execution.

Includes component.php from within lang directory of the component.

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

Переопределяется в Entity и EntitySelector.

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

◆ onPrepareComponentParams()

onPrepareComponentParams ( $arParams )

Event called from includeComponent before component execution.

Takes component parameters as argument and should return it formatted as needed.

Аргументы

array[string]mixed $arParams

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

Переопределяется в ReportProductList, Base, Entity, EntitySelector, LogEntry и LogList.

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

◆ randString()

randString ( $length = 6 )

Function returns next pseudo random value.

Аргументы

int $length

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

См. также: \Bitrix\Main\Type\RandomSequencerandString

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

◆ setFrameMode()

setFrameMode ( $mode )

Marks a component as capable of composite mode. You should use is to mark a whole component as composite incompatible.

Аргументы

bool $mode

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

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

◆ setLanguageId()

setLanguageId ( $languageId )

Аргументы

string $languageId

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

◆ setResultCacheKeys()

setResultCacheKeys ( $arResultCacheKeys )

final

Function marks the arResult keys to be saved to cache. Just like __sleep magic method do.

Note: it's call adds key, not replacing.

Аргументы

array[int]string $arResultCacheKeys

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

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

◆ setSiteId()

setSiteId ( $siteId )

Аргументы

string $siteId

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

◆ setSiteTemplateId()

setSiteTemplateId ( $siteTemplateId )

Аргументы

string $siteTemplateId

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

◆ setTemplateCachedData()

setTemplateCachedData ( $templateCachedData )

final

Function applies collection of the css files to the current template.

Note: component must be inited by initComponent method.

Аргументы

array[string][int]string $templateCachedData

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

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

◆ setTemplateEpilog()

setTemplateEpilog ( $arEpilogInfo )

final

Function saves component epilog environment

Аргументы

array[string]mixed $arEpilogInfo

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

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

◆ setTemplateName()

setTemplateName ( $templateName )

final

Function sets the name of the template. Returns true on success.

Note: component must be inited by initComponent method.

Аргументы

string $templateName

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

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

◆ showComponentTemplate()

showComponentTemplate ( )

final

Function executes initialized template of the component.

Note: component must be inited by initComponent method.

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

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

◆ startResultCache()

startResultCache	(	$cacheTime = false,
		$additionalCacheID = false,
		$cachePath = false )

final

Function starts the caching block of the component execution.

Аргументы

int \| bool	$cacheTime
mixed	$additionalCacheID
string \| bool	$cachePath

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

@global CMain $APPLICATION

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

Поля

◆ $__name

$__name = ""

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

◆ $__parent

$__parent = null

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

◆ $__path

$__path = ""

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

◆ $__template

$__template = null

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

◆ $__templatePage

$__templatePage = ""

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

◆ $arParams

$arParams = array()

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

◆ $arResult

$arResult = array()

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

◆ $arResultCacheKeys

$arResultCacheKeys = false

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

◆ $request

$request

protected

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

◆ $signedParameters

$signedParameters

protected

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

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

C:/bitrix/modules/main/classes/general/component.php

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

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

Поля данных

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

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

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

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

◆ __construct()

Методы

◆ __includeComponent()

◆ __prepareComponentParams()

◆ __showError()

◆ abortResultCache()

◆ addChildCSS()

◆ addChildEpilog()

◆ addChildFrame()

◆ addChildJS()

◆ addDeleteAction()

◆ addEditAction()

◆ addEditButton()

◆ addIncludeAreaIcon()

◆ addIncludeAreaIcons()

◆ addViewTarget()

◆ clearComponentCache()

◆ clearResultCache()

◆ endResultCache()

◆ executeComponent()

◆ getCacheID()

◆ getCachePath()

◆ getDefaultFrameMode()

◆ getEditAreaId()

◆ getFrameMode()

◆ getIncludeAreaIcons()

◆ getLanguageId()

◆ getName()

◆ getParent()

◆ getPath()

◆ getRealFrameMode()

◆ getRelativePath()

◆ getSignedParameters()

◆ getSiteId()

◆ getSiteTemplateId()

◆ getTemplate()

◆ getTemplateCachedData()

◆ getTemplateName()

◆ getTemplatePage()

◆ includeComponentClass()

◆ includeComponentLang()

◆ includeComponentTemplate()

◆ initComponent()

◆ initComponentTemplate()

◆ listKeysSignedParameters()

◆ onIncludeComponentLang()

◆ onPrepareComponentParams()

◆ randString()

◆ setFrameMode()

◆ setLanguageId()

◆ setResultCacheKeys()

◆ setSiteId()

◆ setSiteTemplateId()

◆ setTemplateCachedData()

◆ setTemplateEpilog()

◆ setTemplateName()

◆ showComponentTemplate()

◆ startResultCache()

Поля

◆ $__name

◆ $__parent

◆ $__path

◆ $__template

◆ $__templatePage

◆ $arParams

◆ $arResult

◆ $arResultCacheKeys

◆ $request

◆ $signedParameters