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

Открытые статические члены
static	getUserTypeDescription ()
static	renderField (array $userField, ?array $additionalParameters=[])
static	renderView (array $userField, ?array $additionalParameters=[])
static	renderEdit (array $userField, ?array $additionalParameters=[])
static	renderSettings ($userField, ?array $additionalParameters, $varsFromForm)
static	renderEditForm (array $userField, ?array $additionalParameters)
static	renderAdminListView (array $userField, ?array $additionalParameters)
static	renderAdminListEdit (array $userField, ?array $additionalParameters)
static	renderFilter (array $userField, ?array $additionalParameters)
static	renderText (array $userField)
static	getSettingsHtml ($userField, ?array $additionalParameters, $varsFromForm)
static	getPublicView (array $userField, ?array $additionalParameters=[])
static	getPublicEdit (array $userField, ?array $additionalParameters=[])
static	getEditFormHtml (array $userField, ?array $additionalParameters)
static	getAdminListViewHtml (array $userField, ?array $additionalParameters)
static	getAdminListEditHTML (array $userField, ?array $additionalParameters)
static	getFilterHtml (array $userField, ?array $additionalParameters)
static	getPublicText (array $userField)
static	getDefaultValue (array $userField, array $additionalParameters=[])
static	getDbColumnType ()
static	isMandatorySupported ()
static	isMultiplicitySupported ()

Поля данных
const	MODE_EDIT = 'main.edit'
const	MODE_VIEW = 'main.view'

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

Защищенные данные
const	USER_TYPE_ID = null
const	RENDER_COMPONENT = null

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

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

Методы

◆ getAdminListEditHTML()

getAdminListEditHTML	(	array	$userField,
		?array	$additionalParameters )

static

Аргументы

array	$userField
array \| null	$additionalParameters

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

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

◆ getAdminListViewHtml()

getAdminListViewHtml	(	array	$userField,
		?array	$additionalParameters )

static

Аргументы

array	$userField
array \| null	$additionalParameters

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

Переопределяется в CUserTypeHlblock.

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

◆ getBaseUserTypeDescription()

getBaseUserTypeDescription ( )

staticprotected

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

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

◆ getDbColumnType()

getDbColumnType ( )

staticabstract

Переопределяется в MoneyType, AddressType, ElementType, BooleanType, DateTimeType, DateType, DoubleType, EnumType, FileType, IntegerType и StringType.

◆ getDefaultValue()

getDefaultValue	(	array	$userField,
		array	$additionalParameters = [] )

static

Аргументы

array	$userField
array	$additionalParameters

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

Переопределяется в ElementType, SectionType, DateType, EnumType и CUserTypeHlblock.

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

◆ getDescription()

getDescription ( )

staticprotected

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

Переопределяется в MoneyType, AddressType, ElementType, SectionType, BooleanType, DateTimeType, DateType, DoubleType, EnumType, FileType, IntegerType, StringFormattedType, StringType, UrlType и CUserTypeHlblock.

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

◆ getEditFormHtml()

getEditFormHtml	(	array	$userField,
		?array	$additionalParameters )

static

Аргументы

array	$userField
array \| null	$additionalParameters

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

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

◆ getFilterHtml()

getFilterHtml	(	array	$userField,
		?array	$additionalParameters )

static

Аргументы

array	$userField
array \| null	$additionalParameters

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

Переопределяется в FileType.

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

◆ getPublicEdit()

getPublicEdit	(	array	$userField,
		?array	$additionalParameters = [] )

static

Аргументы

array	$userField
array \| null	$additionalParameters

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

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

◆ getPublicText()

getPublicText ( array $userField )

static

Аргументы

array $userField

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

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

◆ getPublicView()

getPublicView	(	array	$userField,
		?array	$additionalParameters = [] )

static

Аргументы

array	$userField
array \| null	$additionalParameters

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

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

◆ getSettingsHtml()

getSettingsHtml	(		$userField,
		?array	$additionalParameters,
			$varsFromForm )

static

Аргументы

array \| bool	$userField
array \| null	$additionalParameters
	$varsFromForm

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

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

◆ getUserTypeDescription()

getUserTypeDescription ( )

static

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

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

◆ isMandatorySupported()

isMandatorySupported ( )

static

Переопределяется в BooleanType.

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

◆ isMultiplicitySupported()

isMultiplicitySupported ( )

static

Переопределяется в BooleanType.

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

◆ renderAdminListEdit()

renderAdminListEdit	(	array	$userField,
		?array	$additionalParameters )

static

This function is called when the property value is displayed in the list of items in edit mode.

Returns html to embed in a table cell. $AdditionalParameters elements are converted to html safe mode.

Аргументы

array	$userField	An array describing the field.
array \| null	$additionalParameters	An array of controls from the form. Contains the elements NAME and VALUE.

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

Переопределяется в ElementType, EnumType и CUserTypeHlblock.

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

◆ renderAdminListView()

renderAdminListView	(	array	$userField,
		?array	$additionalParameters )

static

This function is called when the property value is displayed in the list of elements.

Returns html to embed in a table cell. $AdditionalParameters elements are converted to html safe mode.

Аргументы

array	$userField	An array describing the field.
array \| null	$additionalParameters	An array of controls from the form. Contains the elements NAME and VALUE.

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

Переопределяется в ElementType, EnumType и CUserTypeHlblock.

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

◆ renderEdit()

renderEdit	(	array	$userField,
		?array	$additionalParameters = [] )

static

This function is called when editing property values in the public part of the site.

Returns html. If the class does not provide such a function, then the type manager will call the component specified in the property metadata or system bitrix: system.field.edit

Аргументы

array	$userField	An array describing the field.
array \| null	$additionalParameters	Additional parameters (e.g. context).

Возвращает: string HTML для вывода.

Переопределяется в ElementType, EnumType и CUserTypeHlblock.

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

◆ renderEditForm()

renderEditForm	(	array	$userField,
		?array	$additionalParameters )

static

This function is called when the form for editing the property value is displayed, for example, here /bitrix/admin/iblock_section_edit.php

Returns html for embedding in a table cell in the entity editing form (on the "Advanced Properties" tab).

Аргументы

array	$userField	An array describing the field.
array \| null	$additionalParameters	An array of controls from the form. Contains the elements NAME and VALUE.

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

Переопределяется в ElementType, EnumType и CUserTypeHlblock.

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

◆ renderField()

renderField	(	array	$userField,
		?array	$additionalParameters = [] )

static

Аргументы

array	$userField
array \| null	$additionalParameters

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

Переопределяется в ElementType, EnumType и CUserTypeHlblock.

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

◆ renderFilter()

renderFilter	(	array	$userField,
		?array	$additionalParameters )

static

This function is called when the filter is displayed on the list page.

Returns html to embed in a table cell. $additionalParameters elements are html safe.

Аргументы

array	$userField	An array describing the field.
array \| null	$additionalParameters	An array of controls from the form. Contains the elements NAME and VALUE.

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

Переопределяется в ElementType, EnumType и CUserTypeHlblock.

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

◆ renderSettings()

renderSettings	(		$userField,
		?array	$additionalParameters,
			$varsFromForm )

static

This function is called when the property settings form is displayed.

Returns html for embedding in a 2-column table in the form usertype_edit.php

Аргументы

bool \| array	$userField	An array describing the field. For a new (not yet added field - false)
array \| null	$additionalParameters	Array of advanced parameters
	$varsFromForm

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

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

◆ renderText()

renderText ( array $userField )

static

Аргументы

array $userField

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

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

◆ renderView()

renderView	(	array	$userField,
		?array	$additionalParameters = [] )

static

This function is called when the property values are displayed in the public part of the site.

Returns html. If the class does not provide such a function, then the type manager will call the component specified in the property metadata or system bitrix: system.field.view

Аргументы

array	$userField	An array describing the field.
array \| null	$additionalParameters	Additional parameters (e.g. context).

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

Переопределяется в ElementType, EnumType и CUserTypeHlblock.

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

Поля

◆ MODE_EDIT

const MODE_EDIT = 'main.edit'

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

◆ MODE_VIEW

const MODE_VIEW = 'main.view'

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

◆ RENDER_COMPONENT

const RENDER_COMPONENT = null

protected

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

◆ USER_TYPE_ID

const USER_TYPE_ID = null

protected

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

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

C:/bitrix/modules/main/lib/userfield/types/basetype.php

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

Поля данных

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

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

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

Методы

◆ getAdminListEditHTML()

◆ getAdminListViewHtml()

◆ getBaseUserTypeDescription()

◆ getDbColumnType()

◆ getDefaultValue()

◆ getDescription()

◆ getEditFormHtml()

◆ getFilterHtml()

◆ getPublicEdit()

◆ getPublicText()

◆ getPublicView()

◆ getSettingsHtml()

◆ getUserTypeDescription()

◆ isMandatorySupported()

◆ isMultiplicitySupported()

◆ renderAdminListEdit()

◆ renderAdminListView()

◆ renderEdit()

◆ renderEditForm()

◆ renderField()

◆ renderFilter()

◆ renderSettings()

◆ renderText()

◆ renderView()

Поля

◆ MODE_EDIT

◆ MODE_VIEW

◆ RENDER_COMPONENT

◆ USER_TYPE_ID