Открытые члены
	__construct (array $config=[])

	getSourceFilterBaseUri ($module, $sourceId)

	getSourcesDescription ()

	findSource ($index)

	showSourceFilter ($index)

	showSourceFilterByRequest ()

	getSiteMode ()

	checkSiteMode (array $modeList)

	getModuleRestrictions ($module)

	getResultAction ()

	getDefaultLinkActions ()

Открытые статические члены
static	getSources (array $config=[])

static	getSourceNames (array $config=[])

static	getSourceIndex ($module, $sourceId)

Открытые атрибуты
const	SOURCE_PATH = '/bitrix/tools/landing/source.php'

const	EVENT_BUILD_SOURCE_LIST = 'OnBuildSourceList'

const	SITE_MODE_UNKNOWN = 'UNKNOWN'

const	SITE_MODE_SYSTEM = 'SYSTEM'

const	SITE_MODE_PAGE = 'PAGE'

const	SITE_MODE_STORE = 'STORE'

const	SITE_MODE_KNOWLEDGE = 'KNOWLEDGE'

const	SOURCE_TYPE_COMPONENT = 'C'

const	SOURCE_TYPE_PRESET = 'P'

const	ACTION_TYPE_EVENT = 'event'

const	ACTION_TYPE_SLIDER = 'slider'

const	ACTION_NAME = 'save'

Защищенные члены
	initSourceList ()

	setConfig (array $config)

	prepareConfig (array $config)

	clearFilter ($value)

	initSiteMode ()

	initRestrictions ()

	prepareSourceParameters ($module, $parameters)

	checkSystemSettings (array $settings)

	checkComponentSettings (array $settings)

	checkPresetSettings (array $settings)

	checkWrapperSettings (array $settings)

	checkDataSettings (array $settings)

	getBaseUrlParams ($index)

	getUrlSystemParams ()

	prepareOrderField (array $field)

	prepareStringValue (array $row, $name)

Защищенные статические члены
static	isNotEmptyField ($item)

Защищенные данные
	$config

	$siteMode = self::SITE_MODE_UNKNOWN

	$restrictions = null

	$sourceList = null

Подробное описание

См. определение в файле selector.php строка 11

Конструктор(ы)

◆ __construct()

__construct ( array $config = [] )

Selector constructor.

Аргументы

array $config Initialization parameters. The array must contain all or part of the elements of the \Bitrix\Landing\Source\Selector::$config.

Возвращает: void

См. определение в файле selector.php строка 61

Методы

◆ checkComponentSettings()

checkComponentSettings ( array $settings )

protected

Check settings for component filter.

Аргументы

array $settings

Возвращает: array|null

См. определение в файле selector.php строка 705

◆ checkDataSettings()

checkDataSettings ( array $settings )

protected

Checks the validity of the description of the source fields available.

Аргументы

array $settings

Возвращает: array|null

См. определение в файле selector.php строка 820

◆ checkPresetSettings()

checkPresetSettings ( array $settings )

protected

Check fixed block filter.

Аргументы

array $settings

Возвращает: array|null

См. определение в файле selector.php строка 747

◆ checkSiteMode()

checkSiteMode ( array $modeList )

Аргументы

array $modeList

Возвращает: bool

См. определение в файле selector.php строка 333

◆ checkSystemSettings()

checkSystemSettings ( array $settings )

protected

Check common settings.

Аргументы

array $settings

Возвращает: array

См. определение в файле selector.php строка 685

◆ checkWrapperSettings()

checkWrapperSettings ( array $settings )

protected

Check additional settings for component bitrix:ui.sidepanel.wrapper

Аргументы

array $settings

Возвращает: array

См. определение в файле selector.php строка 771

◆ clearFilter()

clearFilter ( $value )

protected

Filter for array_filter - remove items with NULL value.

Аргументы

mixed $value

Возвращает: bool

См. определение в файле selector.php строка 492

◆ findSource()

findSource ( $index )

Searches for source by index.

См. также: \Bitrix\Landing\Source\Selector::getSourceIndex

Аргументы

string $index

Возвращает: array|null

См. определение в файле selector.php строка 204

◆ getBaseUrlParams()

getBaseUrlParams ( $index )

protected

Returns required parameters for base url.

Аргументы

string $index

Возвращает: array

См. определение в файле selector.php строка 892

◆ getDefaultLinkActions()

getDefaultLinkActions ( )

Возвращает: array

См. определение в файле selector.php строка 391

◆ getModuleRestrictions()

getModuleRestrictions ( $module )

Returns a list of constraints that module sources must satisfy (for example, information block ID).

Аргументы

string $module

Возвращает: array|null

См. определение в файле selector.php строка 347

◆ getResultAction()

getResultAction ( )

Возвращает: array

См. определение в файле selector.php строка 380

◆ getSiteMode()

getSiteMode ( )

Returns current site mode for sources.

Возвращает: string

См. определение в файле selector.php строка 324

◆ getSourceFilterBaseUri()

getSourceFilterBaseUri	(		$module,
			$sourceId )

Returns base uri for source filter form. Should be used to build page navigation when selecting items, filter operation.

Аргументы

string	$module
string	$sourceId

Возвращает: Main\Web\Uri

См. определение в файле selector.php строка 143

◆ getSourceIndex()

static getSourceIndex	(		$module,
			$sourceId )

static

Аргументы

string	$module
string	$sourceId

Возвращает: string

См. определение в файле selector.php строка 372

◆ getSourceNames()

static getSourceNames ( array $config = [] )

static

Returns a short description of the sources: id and name

Аргументы

array $config

Возвращает: array

См. определение в файле selector.php строка 305

◆ getSources()

static getSources ( array $config = [] )

static

Returns a full description of the sources: the URL to open the filter, a list of possible fields of elements, etc

Аргументы

array $config

Возвращает: array

См. определение в файле selector.php строка 293

◆ getSourcesDescription()

getSourcesDescription ( )

Returns a full description of the sources: the URL to open the filter, a list of possible fields of elements, etc

Возвращает: array

См. определение в файле selector.php строка 155

◆ getUrlSystemParams()

getUrlSystemParams ( )

protected

Returns system parameters (language, site, template) for urls.

Возвращает: array

См. определение в файле selector.php строка 907

◆ initRestrictions()

initRestrictions ( )

protected

Load constraints that sources must satisfy (for example, information block ID).

Возвращает: void

См. определение в файле selector.php строка 532

◆ initSiteMode()

initSiteMode ( )

protected

Load current landing mode

Возвращает: void

См. определение в файле selector.php строка 502

◆ initSourceList()

initSourceList ( )

protected

Getting a list of sources. Calls the event handlers and processes their results (checks the accuracy of the data returned by the handlers).

Возвращает: void

См. определение в файле selector.php строка 74

◆ isNotEmptyField()

static isNotEmptyField ( $item )

staticprotected

Аргументы

mixed $item

Возвращает: bool

См. определение в файле selector.php строка 933

◆ prepareConfig()

prepareConfig ( array $config )

protected

Checks selector config.

Аргументы

array $config

Возвращает: array

См. определение в файле selector.php строка 428

◆ prepareOrderField()

prepareOrderField ( array $field )

protected

Аргументы

array $field

Возвращает: array|null

См. определение в файле selector.php строка 942

◆ prepareSourceParameters()

prepareSourceParameters	(		$module,
			$parameters )

protected

Check source description.

Аргументы

string	$module
array	$parameters

Возвращает: array|null

См. определение в файле selector.php строка 565

◆ prepareStringValue()

prepareStringValue	(	array	$row,
			$name )

protected

Аргументы

array	$row
string	$name

Возвращает: string|null

См. определение в файле selector.php строка 964

◆ setConfig()

setConfig ( array $config )

protected

Set/update selector config.

Аргументы

array $config

Возвращает: void

См. определение в файле selector.php строка 413

◆ showSourceFilter()

showSourceFilter ( $index )

Displays a source filter for selecting which items are shown.

Аргументы

string $index

Возвращает: void

См. определение в файле selector.php строка 220

◆ showSourceFilterByRequest()

showSourceFilterByRequest ( )

Internal method for show a filter of source from request id.

Возвращает: void

См. определение в файле selector.php строка 251

Данные класса

◆ $config

$config

protected

Инициализатор

= [
        'SOURCE_EVENT_ID' => self::EVENT_BUILD_SOURCE_LIST, 
        'SOURCE_PATH' => self::SOURCE_PATH, 
        'RESULT_ACTION_TYPE' => self::ACTION_TYPE_SLIDER, 
        'RESULT_ACTION_NAME' => self::ACTION_NAME
    ]

См. определение в файле selector.php строка 37

◆ $restrictions

$restrictions = null

protected

См. определение в файле selector.php строка 48

◆ $siteMode

$siteMode = self::SITE_MODE_UNKNOWN

protected

См. определение в файле selector.php строка 45

◆ $sourceList

$sourceList = null

protected

См. определение в файле selector.php строка 51

◆ ACTION_NAME

const ACTION_NAME = 'save'

См. определение в файле selector.php строка 34

◆ ACTION_TYPE_EVENT

const ACTION_TYPE_EVENT = 'event'

См. определение в файле selector.php строка 31

◆ ACTION_TYPE_SLIDER

const ACTION_TYPE_SLIDER = 'slider'

См. определение в файле selector.php строка 32

◆ EVENT_BUILD_SOURCE_LIST

const EVENT_BUILD_SOURCE_LIST = 'OnBuildSourceList'

См. определение в файле selector.php строка 17

◆ SITE_MODE_KNOWLEDGE

const SITE_MODE_KNOWLEDGE = 'KNOWLEDGE'

См. определение в файле selector.php строка 24

◆ SITE_MODE_PAGE

const SITE_MODE_PAGE = 'PAGE'

См. определение в файле selector.php строка 22

◆ SITE_MODE_STORE

const SITE_MODE_STORE = 'STORE'

См. определение в файле selector.php строка 23

◆ SITE_MODE_SYSTEM

const SITE_MODE_SYSTEM = 'SYSTEM'

См. определение в файле selector.php строка 21

◆ SITE_MODE_UNKNOWN

const SITE_MODE_UNKNOWN = 'UNKNOWN'

См. определение в файле selector.php строка 20

◆ SOURCE_PATH

const SOURCE_PATH = '/bitrix/tools/landing/source.php'

См. определение в файле selector.php строка 14

◆ SOURCE_TYPE_COMPONENT

const SOURCE_TYPE_COMPONENT = 'C'

См. определение в файле selector.php строка 27

◆ SOURCE_TYPE_PRESET

const SOURCE_TYPE_PRESET = 'P'

См. определение в файле selector.php строка 28

Bitrix-D7 23.9

Открытые члены

Открытые статические члены

Открытые атрибуты

Защищенные члены

Защищенные статические члены

Защищенные данные

Подробное описание

Конструктор(ы)

◆ __construct()

Методы

◆ checkComponentSettings()

◆ checkDataSettings()

◆ checkPresetSettings()

◆ checkSiteMode()

◆ checkSystemSettings()

◆ checkWrapperSettings()

◆ clearFilter()

◆ findSource()

◆ getBaseUrlParams()

◆ getDefaultLinkActions()

◆ getModuleRestrictions()

◆ getResultAction()

◆ getSiteMode()

◆ getSourceFilterBaseUri()

◆ getSourceIndex()

◆ getSourceNames()

◆ getSources()

◆ getSourcesDescription()

◆ getUrlSystemParams()

◆ initRestrictions()

◆ initSiteMode()

◆ initSourceList()

◆ isNotEmptyField()

◆ prepareConfig()

◆ prepareOrderField()

◆ prepareSourceParameters()

◆ prepareStringValue()

◆ setConfig()

◆ showSourceFilter()

◆ showSourceFilterByRequest()

Данные класса

◆ $config

◆ $restrictions

◆ $siteMode

◆ $sourceList

◆ ACTION_NAME

◆ ACTION_TYPE_EVENT

◆ ACTION_TYPE_SLIDER

◆ EVENT_BUILD_SOURCE_LIST

◆ SITE_MODE_KNOWLEDGE

◆ SITE_MODE_PAGE

◆ SITE_MODE_STORE

◆ SITE_MODE_SYSTEM

◆ SITE_MODE_UNKNOWN

◆ SOURCE_PATH

◆ SOURCE_TYPE_COMPONENT

◆ SOURCE_TYPE_PRESET