Bitrix-D7 23.9
 
Загрузка...
Поиск...
Не найдено
Открытые члены | Открытые атрибуты | Защищенные члены | Защищенные статические члены | Защищенные данные | Статические защищенные данные | Полный список членов класса
Класс BaseUfComponent
+ Граф наследования: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 ()
 

Открытые атрибуты

const MODE_DEFAULT = '.default'
 
const TEMPLATE_PAGE_DEFAULT = '.default'
 
const TEMPLATE_NAME_DEFAULT = '.default'
 
const MEDIA_TYPE_DEFAULT = '.default'
 
const MEDIA_TYPE_MOBILE = 'mobile'
 

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

 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 ()
 

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

static normalizeFieldValue ($value)
 
static getUserTypeId ()
 

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

 $componentTemplate
 
 $userField = []
 
 $additionalParameters = []
 

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

static $htmlBuilder = []
 

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

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

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

◆ __construct()

__construct ( $component = null)

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

Методы

◆ executeComponent()

executeComponent ( )
final

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

◆ generateAvailableModesHash()

generateAvailableModesHash ( )
finalprotected
Возвращает
string

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

◆ getAdditionalParameter()

getAdditionalParameter ( string $key)
Аргументы
string$key
Возвращает
mixed|null

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

◆ getAdditionalParameters()

getAdditionalParameters ( )
Возвращает
array

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

◆ getAvailableModes()

getAvailableModes ( )
Возвращает
array

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

◆ getAvailableTemplateFolder()

getAvailableTemplateFolder ( )
finalprotected

Returning first correct template folder from array of availables modes

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

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

◆ getFieldName()

getFieldName ( )
protected
Возвращает
string

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

◆ getFieldValue()

getFieldValue ( )
protected
Возвращает
array

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

◆ getHtmlBuilder()

getHtmlBuilder ( )
final
Возвращает
HtmlBuilder

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

◆ getMediaType()

getMediaType ( )
protected
Возвращает
string

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

◆ getMediaTypes()

getMediaTypes ( )
finalprotected

Return all mediaTypes

Возвращает
array

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

◆ getMode()

getMode ( )
final
Возвращает
string

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

◆ getParentComponent()

getParentComponent ( )
Возвращает
CBitrixComponent|null

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

◆ getTemplateNameFromMode()

getTemplateNameFromMode ( )
protected
Возвращает
string

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

◆ getTemplatePageFromMediaType()

getTemplatePageFromMediaType ( )
protected
Возвращает
string

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

◆ getUserField()

getUserField ( )
Возвращает
array

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

◆ getUserTypeId()

static getUserTypeId ( )
staticabstractprotected
Возвращает
string

◆ hasTemplateFolder()

hasTemplateFolder ( )
finalprotected
Возвращает
bool

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

◆ hasTemplatePage()

hasTemplatePage ( string $templatePage)
finalprotected
Аргументы
string$templatePage
Возвращает
bool

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

◆ initAvailableModes()

initAvailableModes ( )
protected

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

◆ initMediaType()

initMediaType ( )
protected

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

◆ initMode()

initMode ( )
protected

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

◆ initResult()

initResult ( )
finalprotected

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

◆ isAjaxRequest()

isAjaxRequest ( )
final
Возвращает
bool

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

◆ isDefaultMode()

isDefaultMode ( )
final
Возвращает
bool

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

◆ isExistTemplatePage()

isExistTemplatePage ( ?string $templatePage = '')
finalprotected
Аргументы
string | null$templatePage
Возвращает
bool

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

◆ isMobileMode()

isMobileMode ( )
final
Возвращает
bool

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

◆ isMultiple()

isMultiple ( )
Возвращает
bool

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

◆ isPossibleMediaType()

isPossibleMediaType ( )
finalprotected

Checking if mediaType specified when calling the component is valid

Возвращает
bool

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

◆ normalizeFieldValue()

static normalizeFieldValue ( $value)
staticfinalprotected
Аргументы
mixed$value
Возвращает
array

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

◆ prepareResult()

prepareResult ( )
protected

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

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

◆ resolveTemplateName()

resolveTemplateName ( )
protected

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

Возвращает
string

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

◆ resolveTemplatePage()

resolveTemplatePage ( )
finalprotected

Return templatePage name from mediaType or null if mediaType incorrect

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

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

◆ setAdditionalParameters()

setAdditionalParameters ( ?array $additionalParameters)
Аргументы
array | null$additionalParameters

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

◆ setAvailableModes()

setAvailableModes ( array $availableModes)
Аргументы
array$availableModes

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

◆ setHtmlBuilder()

setHtmlBuilder ( HtmlBuilder $htmlBuilder)
final
Аргументы
HtmlBuilder$htmlBuilder

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

◆ setMediaType()

setMediaType ( string $mediaType)
protected
Аргументы
string$mediaType

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

◆ setMode()

setMode ( string $mode)
protected
Аргументы
string$mode

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

◆ setParentComponent()

setParentComponent ( ?CBitrixComponent $_parent)
Аргументы
CBitrixComponent | null$_parent

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

◆ setUserField()

setUserField ( $userField)
Аргументы
array | bool$userField

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

Данные класса

◆ $additionalParameters

array $additionalParameters = []
protected

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

◆ $componentTemplate

CBitrixComponentTemplate $componentTemplate
protected

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

◆ $htmlBuilder

array $htmlBuilder = []
staticprotected

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

◆ $userField

array $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