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

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

static getDescription ()
 
static getDbColumnType ()
 
static prepareSettings (array $userField)
 
static getFilterData (?array $userField, array $additionalSettings)
 
static checkFields (array $userField, $value)
 
static onSearchIndex (array $userField)
 
- Открытые статические члены унаследованные от 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 isMandatorySupported ()
 
static isMultiplicitySupported ()
 

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

const USER_TYPE_ID = 'string'
 
const RENDER_COMPONENT = 'bitrix:main.field.string'
 
- Открытые атрибуты унаследованные от BaseType
const MODE_EDIT = 'main.edit'
 
const MODE_VIEW = 'main.view'
 

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

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

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

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

Методы

◆ checkFields()

static checkFields ( array $userField,
$value )
static

This function is validator. Called from the CheckFields method of the $ USER_FIELD_MANAGER object, which can be called from the Add / Update methods of the property owner entity.

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

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

◆ getDbColumnType()

static getDbColumnType ( )
static

This function is called when new properties are added. We only support mysql data types.

This function is called to construct the SQL column creation query to store non-multiple property values. Values of multiple properties are not stored in rows, but in columns (as in infoblocks) and the type of such a field in the database is always text

Возвращает
string

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

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

◆ getDescription()

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

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

Переопределяется в StringFormattedType и UrlType.

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

◆ getFilterData()

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

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

◆ onSearchIndex()

static onSearchIndex ( array $userField)
static

This function should return a representation of the field value for the search. It is called from the OnSearchIndex method of the object $ USER_FIELD_MANAGER, which is also called the update function of the entity search index. For multiple values, the VALUE field is an array.

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

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

◆ prepareSettings()

static prepareSettings ( array $userField)
static

This function is called before saving the property metadata to the database.

It should 'clear' the array with the settings of the instance of the property type. In order to accidentally / intentionally no one wrote down any garbage there.

Аргументы
array$userFieldAn array describing the field. Warning! this description of the field has not yet been saved to the database!
Возвращает
array An array that will later be serialized and stored in the database.

Переопределяется в StringFormattedType и UrlType.

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

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

◆ RENDER_COMPONENT

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

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

◆ USER_TYPE_ID

const USER_TYPE_ID = 'string'

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