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

Форматы данных

Данные Описание С версии
Описание источника для регистрации
  • SOURCE_ID - идентификатор, уникальный в рамках модуля (обязательный). Содержит символы латинского алфавита и цифры. Первый символ - буква латинского алфавита. Регистрозависимый.
  • TITLE - название (обязательный)
  • TYPE - тип настроек пользовательского фильтра (обязательный). Поддерживаются два типа:
    • \Bitrix\Landing\Source\Selector::SOURCE_TYPE_COMPONENT - форма настроек пользовательского фильтра. (по умолчанию)
    • \Bitrix\Landing\Source\Selector::SOURCE_TYPE_PRESET - фиксированный пользовательский фильтр
  • SETTINGS - массив параметров формы настроек пользовательского фильтра (обязательный):
    • DETAIL_PAGE (Для всех типов) - необязательный, тип - boolean. При передаче false убирается пункт "Детальная страница" в настройках блока.
    для TYPE = \Bitrix\Landing\Source\Selector::SOURCE_TYPE_COMPONENT:
    • COMPONENT_NAME => имя компонента (обязательный)
    • COMPONENT_TEMPLATE_NAME => имя шаблона (обязательный)
    • COMPONENT_PARAMS => массив параметров вызова компонента (обязательный)
    • WRAPPER - массив настроек компонента bitrix:ui.sidepanel.wrapper Компонент системный, не описывается в документации (необязательный). В нем запускается компонент фильтра. Поддерживаемые настройки:
      • USE_PADDING - по умолчанию false
      • PLAIN_VIEW - по умолчанию false
      • USE_UI_TOOLBAR - по умолчанию 'N'
    для TYPE = \Bitrix\Landing\Source\Selector::SOURCE_TYPE_PRESET:
    • FILTER - массив фильтра блока
  • DATA_SETTINGS - массив доступных полей источника (обязательный)
  • FIELDS - массив полей источника для показа (числовой). Каждый элемент имеет следующую структуру:
  • ORDER - массив полей источника для сортировки (числовой). Каждый элемент имеет структуру:
    • id - идентификатор поля
    • name - название поля
  • DATA_LOADER - полное (с указанием namespace) имя класса-загрузчика (наследника \Bitrix\Landing\Source\DataLoader). обязательный
  • SOURCE_FILTER - дополнительный (ненастраиваемый) фильтр для данных. Массив, необязательный. Для инфоблоков, например, должен содержать ID инфоблока и ключи проверки доступа.

Во избежание проблем с экспортом, не рекомендуется привязываться к числовым идентификаторам сущностей текущего проекта (например, iblock12, где 12 идентификатор инфоблока). Но вы можете использовать цифры, если они относятся к иной (вашей внутренней) логике.

Фильтр блока Массив с целочисленными индексами. Каждое условие фильтра описывается массивом с такой структурой (все ключи обязательные):
  • name - название параметра фильтра (для отображения в настройках динамического блока)
  • key - имя параметра (поле или свойство элемента источника)
  • value - значения для фильтрации. Формат и содержимое value определяются источником. Для упрощения разработки рекомендуется использовать формат полей компонента bitrix:main.ui.filter. В этом случае можно использовать:
    • для передачи динамического фильтра из формы настроек - js-библиотеку landing.uifilterconverter
    • для показа динамического фильтра в форме настроек - класс \Bitrix\Landing\Source\UiFilterPreset
    • для преобразования динамического фильтра в orm/GetList формат - класс \Bitrix\Landing\Source\DataFilter
    если формат выбран иной - все эти операции будет необходимо выполнять самостоятельно.


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

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

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

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

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
© «Битрикс», 2001-2021, «1С-Битрикс», 2021
Наверх