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

Открытые члены
	__construct ($component=null)
	executeComponent ()
	getUserField ()
	setUserField ($userField)
	getAdditionalParameter (string $key)
	getAdditionalParameters ()
	setAdditionalParameters (?array $additionalParameters)
	getParentComponent ()
	setParentComponent (?CBitrixComponent $_parent)
	getAvailableModes ()
	setAvailableModes (array $availableModes)
	getMode ()
	isMultiple ()
	getHtmlBuilder ()
	setHtmlBuilder (HtmlBuilder $htmlBuilder)
	isDefaultMode ()
	isMobileMode ()
	isAjaxRequest ()
Открытые члены унаследованные от CBitrixComponent
	onPrepareComponentParams ($arParams)
	onIncludeComponentLang ()
	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 ()

Поля данных
const	MODE_DEFAULT = '.default'
const	TEMPLATE_PAGE_DEFAULT = '.default'
const	TEMPLATE_NAME_DEFAULT = '.default'
const	MEDIA_TYPE_DEFAULT = '.default'
const	MEDIA_TYPE_MOBILE = 'mobile'
Поля данных унаследованные от CBitrixComponent
	$__name = ""
	$__path = ""
	$__templatePage = ""
	$__template = null
	$arParams = array()
	$arResult = array()
	$arResultCacheKeys = false
	$__parent = null

Защищенные члены
	initResult ()
	prepareResult ()
	initAvailableModes ()
	initMode ()
	setMode (string $mode)
	initMediaType ()
	setMediaType (string $mediaType)
	resolveTemplateName ()
	getTemplateNameFromMode ()
	resolveTemplatePage ()
	isExistTemplatePage (?string $templatePage='')
	isPossibleMediaType ()
	getTemplatePageFromMediaType ()
	getMediaTypes ()
	getMediaType ()
	hasTemplateFolder ()
	getAvailableTemplateFolder ()
	generateAvailableModesHash ()
	hasTemplatePage (string $templatePage)
	getFieldName ()
	getFieldValue ()
Защищенные члены унаследованные от CBitrixComponent
	listKeysSignedParameters ()
	__includeComponent ()

Защищенные статические члены
static	normalizeFieldValue ($value)
static	getUserTypeId ()

Защищенные данные
	$componentTemplate
	$userField = []
	$additionalParameters = []
Защищенные данные унаследованные от CBitrixComponent
	$request
	$signedParameters

Статические защищенные данные
static	$htmlBuilder = []

Дополнительные унаследованные члены
Открытые статические члены унаследованные от CBitrixComponent
static	includeComponentClass ($componentName)
static	clearComponentCache ($componentName, $siteId="")

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

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

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

◆ __construct()

__construct ( $component = null )

Constructor with ability to copy the component.

Аргументы

CBitrixComponent $component

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

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

Методы

◆ executeComponent()

executeComponent ( )

final

Function calls __includeComponent in order to execute the component.

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

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

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

◆ generateAvailableModesHash()

generateAvailableModesHash ( )

finalprotected

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

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

◆ getAdditionalParameter()

getAdditionalParameter ( string $key )

Аргументы

string $key

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

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

◆ getAdditionalParameters()

getAdditionalParameters ( )

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

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

◆ getAvailableModes()

getAvailableModes ( )

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

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

◆ getAvailableTemplateFolder()

getAvailableTemplateFolder ( )

finalprotected

Returning first correct template folder from array of availables modes

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

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

◆ getFieldName()

getFieldName ( )

protected

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

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

◆ getFieldValue()

getFieldValue ( )

protected

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

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

◆ getHtmlBuilder()

getHtmlBuilder ( )

final

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

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

◆ getMediaType()

getMediaType ( )

protected

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

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

◆ getMediaTypes()

getMediaTypes ( )

finalprotected

Return all mediaTypes

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

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

◆ getMode()

getMode ( )

final

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

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

◆ getParentComponent()

getParentComponent ( )

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

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

◆ getTemplateNameFromMode()

getTemplateNameFromMode ( )

protected

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

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

◆ getTemplatePageFromMediaType()

getTemplatePageFromMediaType ( )

protected

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

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

◆ getUserField()

getUserField ( )

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

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

◆ getUserTypeId()

getUserTypeId ( )

staticabstractprotected

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

◆ hasTemplateFolder()

hasTemplateFolder ( )

finalprotected

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

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

◆ hasTemplatePage()

hasTemplatePage ( string $templatePage )

finalprotected

Аргументы

string $templatePage

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

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

◆ initAvailableModes()

initAvailableModes ( )

protected

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

◆ initMediaType()

initMediaType ( )

protected

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

◆ initMode()

initMode ( )

protected

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

◆ initResult()

initResult ( )

finalprotected

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

◆ isAjaxRequest()

isAjaxRequest ( )

final

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

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

◆ isDefaultMode()

isDefaultMode ( )

final

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

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

◆ isExistTemplatePage()

isExistTemplatePage ( ?string $templatePage = '' )

finalprotected

Аргументы

string | null $templatePage

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

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

◆ isMobileMode()

isMobileMode ( )

final

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

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

◆ isMultiple()

isMultiple ( )

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

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

◆ isPossibleMediaType()

isPossibleMediaType ( )

finalprotected

Checking if mediaType specified when calling the component is valid

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

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

◆ normalizeFieldValue()

normalizeFieldValue ( $value )

staticfinalprotected

Аргументы

mixed $value

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

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

◆ prepareResult()

prepareResult ( )

protected

You can override this method in a child class to add the personal custom functionality of the child class

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

◆ resolveTemplateName()

resolveTemplateName ( )

protected

Resolving a mode name to template name. By default, mode === templateFolderName, can be otherwise in child class

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

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

◆ resolveTemplatePage()

resolveTemplatePage ( )

finalprotected

Return templatePage name from mediaType or null if mediaType incorrect

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

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

◆ setAdditionalParameters()

setAdditionalParameters ( ?array $additionalParameters )

Аргументы

array | null $additionalParameters

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

◆ setAvailableModes()

setAvailableModes ( array $availableModes )

Аргументы

array $availableModes

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

◆ setHtmlBuilder()

setHtmlBuilder ( HtmlBuilder $htmlBuilder )

final

Аргументы

HtmlBuilder $htmlBuilder

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

◆ setMediaType()

setMediaType ( string $mediaType )

protected

Аргументы

string $mediaType

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

◆ setMode()

setMode ( string $mode )

protected

Аргументы

string $mode

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

◆ setParentComponent()

setParentComponent ( ?CBitrixComponent $_parent )

Аргументы

CBitrixComponent | null $_parent

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

◆ setUserField()

setUserField ( $userField )

Аргументы

array | bool $userField

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

Поля

◆ $additionalParameters

$additionalParameters = []

protected

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

◆ $componentTemplate

$componentTemplate

protected

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

◆ $htmlBuilder

$htmlBuilder = []

staticprotected

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

◆ $userField

$userField = []

protected

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

◆ MEDIA_TYPE_DEFAULT

const MEDIA_TYPE_DEFAULT = '.default'

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

◆ MEDIA_TYPE_MOBILE

const MEDIA_TYPE_MOBILE = 'mobile'

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

◆ MODE_DEFAULT

const MODE_DEFAULT = '.default'

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

◆ TEMPLATE_NAME_DEFAULT

const TEMPLATE_NAME_DEFAULT = '.default'

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

◆ TEMPLATE_PAGE_DEFAULT

const TEMPLATE_PAGE_DEFAULT = '.default'

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

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

C:/bitrix/modules/main/lib/component/baseufcomponent.php

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

Поля данных

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

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

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

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

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

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

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

◆ __construct()

Методы

◆ executeComponent()

◆ generateAvailableModesHash()

◆ getAdditionalParameter()

◆ getAdditionalParameters()

◆ getAvailableModes()

◆ getAvailableTemplateFolder()

◆ getFieldName()

◆ getFieldValue()

◆ getHtmlBuilder()

◆ getMediaType()

◆ getMediaTypes()

◆ getMode()

◆ getParentComponent()

◆ getTemplateNameFromMode()

◆ getTemplatePageFromMediaType()

◆ getUserField()

◆ getUserTypeId()

◆ hasTemplateFolder()

◆ hasTemplatePage()

◆ initAvailableModes()

◆ initMediaType()

◆ initMode()

◆ initResult()

◆ isAjaxRequest()

◆ isDefaultMode()

◆ isExistTemplatePage()

◆ isMobileMode()

◆ isMultiple()

◆ isPossibleMediaType()

◆ normalizeFieldValue()

◆ prepareResult()

◆ resolveTemplateName()

◆ resolveTemplatePage()

◆ setAdditionalParameters()

◆ setAvailableModes()

◆ setHtmlBuilder()

◆ setMediaType()

◆ setMode()

◆ setParentComponent()

◆ setUserField()

Поля

◆ $additionalParameters

◆ $componentTemplate

◆ $htmlBuilder

◆ $userField

◆ MEDIA_TYPE_DEFAULT

◆ MEDIA_TYPE_MOBILE

◆ MODE_DEFAULT

◆ TEMPLATE_NAME_DEFAULT

◆ TEMPLATE_PAGE_DEFAULT