UserFieldTable
Описание и методы
Класс-таблет для работы с таблицей настроек пользовательских полей
Это таблет был добавлен позже исходного апи CUserTypeEntity. Поэтому он используется для простого доступа к существующим данным. Для изменения записей надо пользоваться старым API.
Языковые названия для полей хранятся в отдельной таблице UserFieldLangTable.
Методы
Метод | Описание | С версии |
---|---|---|
public static function getLabelsReference(string $referenceName = null, string $languageId = null): ORM\Fields\Relations\Reference |
Метод возвращает поле для связи с таблицей языковых названий полей. Параметры:
|
|
public static function getLabelFields(): array |
Возвращает массив названий полей, содержащих языковые фразы из связанной таблицы. | |
public static function getLabelsSelect(string $referenceName = null): array |
Возвращает массив для select метода getList с выборкой языкозависимых фраз из связанной таблицы. Параметры:
|
|
public static function getFieldData(int $id): ?array |
Метод возвращает данные о настройках поля с идентификатором $id . Если записи нет, вернут null . Параметры:
|
Поля таблицы
-
ID
-
ENTITY_ID
Строковый идентификатор сущности. Обязательное -
FIELD_NAME
Код поля. Обязательное -
USER_TYPE_ID
Код типа поля. Обязательное -
XML_ID
Внешний строковый идентификатор -
SORT
Индекс сортировки -
MULTIPLE
Булевый флаг множественности (N
илиY
). По умолчаниюN
-
MANDATORY
Булевый флаг обязательности (N
илиY
). По умолчаниюN
-
SHOW_FILTER
Булевый флаг наличия поля в фильтре (N
илиY
). По умолчаниюN
-
SHOW_IN_LIST
Булевый флаг наличия поля в списке (N
илиY
). По умолчаниюN
-
EDIT_IN_LIST
Булевый флаг разрешения редактирования в списке (N
илиY
). По умолчаниюN
-
IS_SEARCHABLE
Булевый флаг наличия поиска по этому полю (N
илиY
). По умолчаниюN
-
SETTINGS
Сериализованный (черезserialize
) массив дополнительных настроек поля, которые зависят от типа
© «Битрикс», 2001-2024, «1С-Битрикс», 2024