Bitrix API

Selector

Table of Contents

Constants

ACTION_NAME  = 'save'
ACTION_TYPE_EVENT  = 'event'
ACTION_TYPE_SLIDER  = 'slider'
EVENT_BUILD_SOURCE_LIST  = 'OnBuildSourceList'
SITE_MODE_KNOWLEDGE  = 'KNOWLEDGE'
SITE_MODE_PAGE  = 'PAGE'
SITE_MODE_STORE  = 'STORE'
SITE_MODE_SYSTEM  = 'SYSTEM'
SITE_MODE_UNKNOWN  = 'UNKNOWN'
SOURCE_PATH  = '/bitrix/tools/landing/source.php'
SOURCE_TYPE_COMPONENT  = 'C'
SOURCE_TYPE_PRESET  = 'P'

Methods

__construct()  : void
Selector constructor.
checkSiteMode()  : bool
findSource()  : array<string|int, mixed>|null
Searches for source by index.
getDataLoader()  : DataLoader|null
getDefaultLinkActions()  : array<string|int, mixed>
getModuleRestrictions()  : array<string|int, mixed>|null
Returns a list of constraints that module sources must satisfy (for example, information block ID).
getResultAction()  : array<string|int, mixed>
getSiteMode()  : string
Returns current site mode for sources.
getSourceFilterBaseUri()  : Uri
Returns base uri for source filter form. Should be used to build page navigation when selecting items, filter operation.
getSourceIndex()  : string
getSourceNames()  : array<string|int, mixed>
Returns a short description of the sources: id and name
getSources()  : array<string|int, mixed>
Returns a full description of the sources: the URL to open the filter, a list of possible fields of elements, etc
getSourcesDescription()  : array<string|int, mixed>
Returns a full description of the sources: the URL to open the filter, a list of possible fields of elements, etc
showSourceFilter()  : void
Displays a source filter for selecting which items are shown.
showSourceFilterByRequest()  : void
Internal method for show a filter of source from request id.

Constants

ACTION_NAME

public mixed ACTION_NAME = 'save'

ACTION_TYPE_EVENT

public mixed ACTION_TYPE_EVENT = 'event'

ACTION_TYPE_SLIDER

public mixed ACTION_TYPE_SLIDER = 'slider'

EVENT_BUILD_SOURCE_LIST

public mixed EVENT_BUILD_SOURCE_LIST = 'OnBuildSourceList'

SITE_MODE_KNOWLEDGE

public mixed SITE_MODE_KNOWLEDGE = 'KNOWLEDGE'

SITE_MODE_PAGE

public mixed SITE_MODE_PAGE = 'PAGE'

SITE_MODE_STORE

public mixed SITE_MODE_STORE = 'STORE'

SITE_MODE_SYSTEM

public mixed SITE_MODE_SYSTEM = 'SYSTEM'

SITE_MODE_UNKNOWN

public mixed SITE_MODE_UNKNOWN = 'UNKNOWN'

SOURCE_PATH

public mixed SOURCE_PATH = '/bitrix/tools/landing/source.php'

SOURCE_TYPE_COMPONENT

public mixed SOURCE_TYPE_COMPONENT = 'C'

SOURCE_TYPE_PRESET

public mixed SOURCE_TYPE_PRESET = 'P'

Methods

__construct()

Selector constructor.

public __construct([array<string|int, mixed> $config = [] ]) : void
Parameters
$config : array<string|int, mixed> = []

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

checkSiteMode()

public checkSiteMode(array<string|int, mixed> $modeList) : bool
Parameters
$modeList : array<string|int, mixed>
Return values
bool

findSource()

Searches for source by index.

public findSource(string $index) : array<string|int, mixed>|null
Parameters
$index : string
Tags
see
Selector::getSourceIndex
Return values
array<string|int, mixed>|null

getDataLoader()

public getDataLoader(string $index, array<string|int, mixed> $parameters[, array<string|int, mixed> $options = [] ]) : DataLoader|null
Parameters
$index : string
$parameters : array<string|int, mixed>
$options : array<string|int, mixed> = []
Return values
DataLoader|null

getDefaultLinkActions()

public getDefaultLinkActions() : array<string|int, mixed>
Return values
array<string|int, mixed>

getModuleRestrictions()

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

public getModuleRestrictions(string $module) : array<string|int, mixed>|null
Parameters
$module : string
Return values
array<string|int, mixed>|null

getResultAction()

public getResultAction() : array<string|int, mixed>
Return values
array<string|int, mixed>

getSiteMode()

Returns current site mode for sources.

public getSiteMode() : string
Return values
string

getSourceFilterBaseUri()

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

public getSourceFilterBaseUri(string $module, string $sourceId) : Uri
Parameters
$module : string
$sourceId : string
Return values
Uri

getSourceIndex()

public static getSourceIndex(string $module, string $sourceId) : string
Parameters
$module : string
$sourceId : string
Return values
string

getSourceNames()

Returns a short description of the sources: id and name

public static getSourceNames([array<string|int, mixed> $config = [] ]) : array<string|int, mixed>
Parameters
$config : array<string|int, mixed> = []
Return values
array<string|int, mixed>

getSources()

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

public static getSources([array<string|int, mixed> $config = [] ]) : array<string|int, mixed>
Parameters
$config : array<string|int, mixed> = []
Return values
array<string|int, mixed>

getSourcesDescription()

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

public getSourcesDescription() : array<string|int, mixed>
Return values
array<string|int, mixed>

showSourceFilter()

Displays a source filter for selecting which items are shown.

public showSourceFilter(string $index) : void
Parameters
$index : string

showSourceFilterByRequest()

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

public showSourceFilterByRequest() : void 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results