Компоненты отрисовки пользовательских полей

Описание

С версии 20.0.800 модуля main доступно новое API для отрисовки контролов пользовательских полей.

Вызов компонента и его параметры одинаковы для всех компонентов, меняется только тип пользовательского поля.

Все компоненты содержат шаблоны для декстопа и мобильного приложения, поддерживают возможность изменения внешнего вида контролов через стандартный механизм шаблонов.

В физической структуре компонент находится в папке /bitrix/components/bitrix/[название_компонента].

Список компонентов

Компонент	Описание
main.field.boolean	Предназначен для отрисовки пользовательских полей типа boolean (да/нет).
main.field.date	Предназначен для отрисовки пользовательских полей типа date (дата).
main.field.datetime	Предназначен для отрисовки пользовательских полей datetime (дата со временем).
main.field.double	Предназначен для отрисовки пользовательских полей типа double (число).
main.field.enum	Предназначен для отрисовки пользовательских полей типа enum (список).
main.field.file	Предназначен для отрисовки пользовательских полей типа file (файл).
main.field.integer	Предназначен для отрисовки пользовательских полей типа integer (целое число).
main.field.string	Предназначен для отрисовки пользовательских полей типа string (строка).
main.field.stringformatted	Предназначен для отрисовки пользовательских полей типа stringformatted.
main.field.url	Предназначен для отрисовки пользовательских полей типа url (ссылка).

Параметры

Параметр	Описание
$userField	Массив метаинформации пользовательского поля. Может быть получен методом GetUserFields класса CUserTypeManager.
$additionalParameters	Массив, который содержит необходимые настройки в зависимости от шаблона, которым выводится контрол. В частности в этом массиве передаются следующие элементы: mode - имя шаблона компонента; mediaType - имя страницы шаблона, на текущий момент или .default, или mobile. Пустое значение эквивалентно .default.

Параметр

Описание

$userField

Массив метаинформации пользовательского поля. Может быть получен методом GetUserFields класса CUserTypeManager.

$additionalParameters

Массив, который содержит необходимые настройки в зависимости от шаблона, которым выводится контрол. В частности в этом массиве передаются следующие элементы:

mode - имя шаблона компонента;
mediaType - имя страницы шаблона, на текущий момент или .default, или mobile. Пустое значение эквивалентно .default.

Пример вызова компонента main.field.string

<?
$APPLICATION->IncludeComponent(
	'bitrix:main.field.string',
		'',
		[
			'userField' => $userField,
			'additionalParameters' => $additionalParameters,
		]
	);
?>

Дополнительно

Также можно использовать универсальное API:

$renderer = new \Bitrix\Main\UserField\Renderer($userField, $additionalParameters);
return $renderer->render();

Пользовательские комментарии

Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.

Наверх