UserFieldTable

Description and methods

ORM data manager class for handling tables with user fields settings

This data manager was added post- original API CUserTypeEntity. That's why it is used for just accessing to existing data. Old API must be used to update records.

Language names for fields are stored in a separate table UserFieldLangTable.

Methods

Method	Description	Available from version
public static function getLabelsReference(string $referenceName = null, string $languageId = null): ORM\Fields\Relations\Reference	Method returns field for associating with field language names table. Parameters: $referenceName - field name, LABELS by default $languageId - language ID
public static function getLabelFields(): array	Returns array of field names containing language phrases from associated table.
public static function getLabelsSelect(string $referenceName = null): array	Returns array for select of method getList with selection of language-dependent phrases from associated tables. Parameters: $referenceName - field name, LABELS by default
public static function getFieldData(int $id): ?array	Method returns field settings data with ID $id. When no record exists, returns null. Parameters: $id - record ID

Table fields

• ID
• ENTITY_ID Entity string ID. Required
• FIELD_NAME Field code. Required
• USER_TYPE_ID Field type code. Required
• XML_ID External string ID
• SORT Sorting index
• MULTIPLE Boolean flag for multiple selection (N or Y). N by default
• MANDATORY Boolean flag of mandatory status (N or Y). N by default
• SHOW_FILTER Boolean flag of showing field in filter (N or Y). N by default
• SHOW_IN_LIST Boolean flag of field availability in filter (N or Y). N by default
• EDIT_IN_LIST Boolean flag of permitting editing in list (N or Y). N by default
• IS_SEARCHABLE Boolean flag of field searchability (N or Y). N by default
• SETTINGS Serialized (via serialize) array of additional field settings that depend on type