Selector
Описание
Менеджер источников. Служебный класс. Собирает коллекцию источников, реализует интерфейс доступа к фильтру данных. При сборе источников класс валидирует (проверяет на соответствие формату) полученные описания. По результатам проверки каждый источник, прошедший валидацию описания, будет представлен такой структурой:
- INDEX - уникальный индекс источника (см. метод \Bitrix\Landing\Source\Selector::getSourceIndex)
- MODULE - идентификатор модуля (обязательный)
- 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 - массив полей источника для показа (числовой). Каждый элемент имеет следующую структуру:
- id - идентификатор поля
- name - название поля
- type - тип ноды, которая нужна для отрисовки (см. \Bitrix\Landing\Node\Type)
- дополнительные параметры, требующиеся для ноды (см методы \Bitrix\Landing\Node::prepareFieldDefinition и \Bitrix\Landing\Node::validateFieldDefinition)
- ORDER - массив полей источника для сортировки (числовой). Каждый элемент имеет структуру:
- id - идентификатор поля
- name - название поля
- DATA_LOADER - полное (с указанием namespace) имя класса-наследника \Bitrix\Landing\Source\DataLoader, который будет отдавать информацию по элементам. Обязательный
- SOURCE_FILTER - дополнительный (ненастраиваемый) фильтр для элементов. Массив, необязательный. Для инфоблоков, например, содержит ID инфоблока и ключи проверки доступа.
Методы
Метод | Описание | С версии |
---|---|---|
Конструктор класса | Метод - конструктор. | |
showSourceFilterByRequest | Метод-надстройка над showSourceFilter. | |
showSourceFilter | Метод отрисовывает форму настроек пользовательского фильтра данных. | |
getSourcesDescription | Метод позволяет получать описаний всех источников для построения формы выбора в настройках блока лендинга. | |
getSources | Статический метод для получения описания всех доступных источников для заданного события. | |
getSourceNames | Статический метод для получения списка названий источников. | |
getSourceIndex | Статический метод для генерации уникального индекса источника. | |
getSourceFilterBaseUri | Метод получает объект ссылки для формы настроек фильтра. | |
getSiteMode | Возвращает в строке текущий режим работы лендинга. | |
getModuleRestrictions | Метод возвращает ограничения для источников конкретного модуля. | |
getDataLoader | Метод возвращает объект получения данных из источника. | |
findSource | Метод для поиска источника по его уникальному индексу. | |
checkSiteMode | Метод возвращает true, если текущий режим работы лендинга найден в списке переданных режимов. |
© «Битрикс», 2001-2024, «1С-Битрикс», 2024