Selector

Description

Source manager. Service class. Collects set of sources, implements access interface to data filter. Upon collection of sources, the class validates (checks for a format match) the retrieved descriptions. Upon results check, each source with validated description, will be represented by such structure:

• INDEX - unique source index (see the method \Bitrix\Landing\Source\Selector::getSourceIndex)
• MODULE - module ID (required)
• SOURCE_ID - identifier, unique within module (required)
• TITLE - name (required)
• TYPE - user filter settings. Optional. If unavailable, uses default value. Currently, supports only the "component" type - \Bitrix\Landing\Source\Selector::SOURCE_TYPE_COMPONENT.
• SETTINGS - array with settings parameters for user filter (required):
  • COMPONENT_NAME - component name (required)
  • COMPONENT_TEMPLATE_NAME - template name (required)
  • COMPONENT_PARAMS - array with component call parameters (required)
• WRAPPER - array with component settings bitrix:ui.sidepanel.wrapper This is system component, it's not described in documentation. (optional). Launches filter component. Supported settings:
  • USE_PADDING - false by default
  • PLAIN_VIEW - false by default
  • USE_UI_TOOLBAR - 'N' by default
• DATA_SETTINGS - array with available source fields (required)
• FIELDS - array with source fields to be displayed (numerical). Each element has the following structure:
  • id - field identifier
  • name - field name
  • type - node type, necessary for rendering (see \Bitrix\Landing\Node\Type)
  • additional parameters, required for the node (see the methods \Bitrix\Landing\Node::prepareFieldDefinition и \Bitrix\Landing\Node::validateFieldDefinition)
• ORDER - array with source fields for sorting (numerical). Each element has the following structure:
  • id - field ID
  • name - field name
• DATA_LOADER - full (with indicated namespace) name for descendant class \Bitrix\Landing\Source\DataLoader to pass the element details. Required
• SOURCE_FILTER - additional (unconfigured) filter for elements. Array, optional. For iblocks, for example, contain iblock ID and access permission keys.