Документация для разработчиков
Темная тема

UserField

Класс, предоставляющий интерфейс для работы с настройками пользовательских полей.

class Bitrix\Rpa\UserField\UserField implements \ArrayAccess

Методы

Метод Описание С версии
public function __construct(array $data, array $visibility) Конструктор.
  • $data - массив с описанием пользовательского поля. Этот массив можно получить с помощью \CUserTypeManager::GetUserFields()
[
	'ID' => 1, // id поля
	'FIELD_NAME' => 'UF_RPA_1_FIELDNAME', // код поля
	'EDIT_FORM_LABEL' => 'Название', // языковое имя поля
	'USER_TYPE_ID' => 'string', // идентификатор типа поля
	'SETTINGS' => [], // массив дополнительных настроек
	'MANDATORY' => 'N', // флаг обязательности
	'MULTIPLE' => 'N', // флаг множественности
	'USER_TYPE' => [], // массив описания типа
];
  • $visibility - массив настроек видимости этого поля здесь ключ - тип видимости поля, а значение - true/false
public function getName(): string Возвращает код поля.
public function getTitle(): string Возвращает языковое название поля.
public function toArray(): array Возвращает массив с полным описанием поля.
public function getUserTypeId(): string Возвращает строковый идентификатор типа.
public function getSettings(): ?array Возвращает массив с описанием поля.
public function isVisible(): bool Возвращает true, если поле доступно для отображения.
public function isEditable(): bool Возвращает true, если поле доступно для изменения.
public function isMandatory(): bool Возвращает true, если поле является обязательным согласно [link=fieldtable]настройкам полей[/link].
public function isMandatoryByDefault(): bool Возвращает true, если поле является обязательным согласно общим настройкам поля.
public function isMultiple(): bool Возвращает true, если поле является множественным.
public function isKanbanVisible(): bool Возвращает true, если поле должно отображаться в карточке канбана.
public function isAvailableOnCreate(): bool Возвращает true, если поле должно присутствовать в быстрой форме создания.
public function isBaseTypeFile(): bool Возвращает true, если поле является файлом.
public function isBaseTypeDate(): bool Возвращает true, если поле является датой.


© «Битрикс», 2001-2024, «1С-Битрикс», 2024