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

Регистрация источника

Обработчик события сбора источников. Пример.

Параметры

Параметры Описание С версии
$event переменная типа \Bitrix\Main\Event. В переменую передаётся SELECTOR - объект класса \Bitrix\Landing\Source\Selector.

Возвращаемое значение

Возвращается объект класса \Bitrix\Main\EventResult. В случае, если источники не возвращаются (нет подпадающих под ограничения, под режим работы лендинга):

return new Main\EventResult(Main\EventResult::ERROR, null, 'ИД_модуля');

Если источники есть, возвращается массив, где каждый элемент описывает один источник (даже если в модуле источник данных только один):

$result = [];
$result[] = [ // описание одного источника
    SOURCE_ID 
         ...
    ];
return new Main\EventResult(Main\EventResult::SUCCESS, $result, 'ИД_модуля');

Ключи массива:

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

Смотри также



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

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

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

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

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