Bitrix-D7 23.9
 
Загрузка...
Поиск...
Не найдено
Класс EnumType
+ Граф наследования:EnumType:

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

static getDescription ()
 
static renderField (array $userField, ?array $additionalParameters=[])
 
static renderView (array $userField, ?array $additionalParameters=[])
 
static renderEdit (array $userField, ?array $additionalParameters=[])
 
static renderEditForm (array $userField, ?array $additionalParameters)
 
static renderFilter (array $userField, ?array $additionalParameters)
 
static renderAdminListView (array $userField, ?array $additionalParameters)
 
static renderAdminListEdit (array $userField, ?array $additionalParameters)
 
static getDbColumnType ()
 
static prepareSettings (array $userField)
 
static checkFields (array $userField, $value)
 
static onSearchIndex (array $userField)
 
static getFilterData (array $userField, array $additionalParameters)
 
static getList (array $userField)
 
static getEnumList (array &$userField, array $additionalParameters=[])
 
static getEmptyCaption (array $userField)
 
static getListMultiple (array $userFields)
 
static getGroupActionData (array $userField, ?array $additionalParameters)
 
static getAdminListEditHtmlMulty (array $userField, ?array $additionalParameters)
 
static getDefaultValue (array $userField, array $additionalParameters=[])
 
static onBeforeSave ($userField, $value)
 
static getFieldValue (array $userField, array $additionalParameters=[])
 
- Открытые статические члены унаследованные от BaseType
static getUserTypeDescription ()
 
static renderSettings ($userField, ?array $additionalParameters, $varsFromForm)
 
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 isMandatorySupported ()
 
static isMultiplicitySupported ()
 

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

const USER_TYPE_ID = 'enumeration'
 
const RENDER_COMPONENT = 'bitrix:main.field.enum'
 
const DISPLAY_LIST = 'LIST'
 
const DISPLAY_CHECKBOX = 'CHECKBOX'
 
const DISPLAY_UI = 'UI'
 
const DISPLAY_DIALOG = 'DIALOG'
 
- Открытые атрибуты унаследованные от BaseType
const MODE_EDIT = 'main.edit'
 
const MODE_VIEW = 'main.view'
 

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

- Защищенные статические члены унаследованные от BaseType
static getBaseUserTypeDescription ()
 
- Защищенные данные унаследованные от BaseType
const USER_TYPE_ID = null
 
const RENDER_COMPONENT = null
 

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

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

Методы

◆ checkFields()

static checkFields ( array $userField,
$value )
static
Аргументы
array$userField
string | array$value
Возвращает
array

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

◆ getAdminListEditHtmlMulty()

static getAdminListEditHtmlMulty ( array $userField,
?array $additionalParameters )
static
Аргументы
array$userField
array | null$additionalParameters
Возвращает
string

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

◆ getDbColumnType()

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

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

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

◆ getDefaultValue()

static getDefaultValue ( array $userField,
array $additionalParameters = [] )
static
Аргументы
array$userField
array$additionalParameters
Возвращает
mixed

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

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

◆ getDescription()

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

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

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

◆ getEmptyCaption()

static getEmptyCaption ( array $userField)
static

@array $userField

Аргументы
array$userField
Возвращает
string

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

◆ getEnumList()

static getEnumList ( array & $userField,
array $additionalParameters = [] )
static
Аргументы
array$userField
array$additionalParameters

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

◆ getFieldValue()

static getFieldValue ( array $userField,
array $additionalParameters = [] )
static

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

◆ getFilterData()

static getFilterData ( array $userField,
array $additionalParameters )
static
Аргументы
array$userField
array$additionalParameters
Возвращает
array

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

◆ getGroupActionData()

static getGroupActionData ( array $userField,
?array $additionalParameters )
static
Аргументы
array$userField
array | null$additionalParameters
Возвращает
array

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

◆ getList()

static getList ( array $userField)
static
Аргументы
array$userField
Возвращает
bool|CDBResult

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

◆ getListMultiple()

static getListMultiple ( array $userFields)
static

Returns values from multiple enumerations by their ID.

Аргументы
array[]$userFieldsIt has to have the "ID" keys in subarrays.
Возвращает
bool|CDBResult

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

◆ onBeforeSave()

static onBeforeSave ( $userField,
$value )
static

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

◆ onSearchIndex()

static onSearchIndex ( array $userField)
static
Аргументы
array$userField
Возвращает
string|null

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

◆ prepareSettings()

static prepareSettings ( array $userField)
static
Аргументы
array$userField
Возвращает
array

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

◆ renderAdminListEdit()

static 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$userFieldAn array describing the field.
array | null$additionalParametersAn array of controls from the form. Contains the elements NAME and VALUE.
Возвращает
string HTML

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

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

◆ renderAdminListView()

static 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$userFieldAn array describing the field.
array | null$additionalParametersAn array of controls from the form. Contains the elements NAME and VALUE.
Возвращает
string HTML

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

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

◆ renderEdit()

static 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$userFieldAn array describing the field.
array | null$additionalParametersAdditional parameters (e.g. context).
Возвращает
string HTML .

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

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

◆ renderEditForm()

static 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$userFieldAn array describing the field.
array | null$additionalParametersAn array of controls from the form. Contains the elements NAME and VALUE.
Возвращает
string

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

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

◆ renderField()

static renderField ( array $userField,
?array $additionalParameters = [] )
static
Аргументы
array$userField
array | null$additionalParameters
Возвращает
string

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

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

◆ renderFilter()

static 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$userFieldAn array describing the field.
array | null$additionalParametersAn array of controls from the form. Contains the elements NAME and VALUE.
Возвращает
string

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

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

◆ renderView()

static 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$userFieldAn array describing the field.
array | null$additionalParametersAdditional parameters (e.g. context).
Возвращает
string

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

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

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

◆ DISPLAY_CHECKBOX

const DISPLAY_CHECKBOX = 'CHECKBOX'

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

◆ DISPLAY_DIALOG

const DISPLAY_DIALOG = 'DIALOG'

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

◆ DISPLAY_LIST

const DISPLAY_LIST = 'LIST'

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

◆ DISPLAY_UI

const DISPLAY_UI = 'UI'

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

◆ RENDER_COMPONENT

const RENDER_COMPONENT = 'bitrix:main.field.enum'

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

◆ USER_TYPE_ID

const USER_TYPE_ID = 'enumeration'

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