Manager
Table of Contents
Constants
- configPath = "/bitrix/modules/mobile/.tab_config.php"
- maxCount = 5
- maxSortValue = 1000
- tabDirectoryPath = "/bitrix/modules/mobile/tabs/"
Methods
- __construct() : mixed
- Manager constructor.
- defaultConfig() : mixed
- getActiveTabs() : array<string|int, mixed>
- Return list of active tabs
- getActiveTabsData() : array<string|int, mixed>
- Return data of active tabs
- getAllTabIDs() : mixed
- getPresetConfig() : array<string|int, mixed>|null
- Return configuration of current preset
- getPresetList() : array<string|int, mixed>
- Return list of available presets
- getPresetName() : string
- Return name of current preset
- getRequiredTabs() : mixed
- Return list of required tabs, which must be always active
- getTabAvailabilityState() : bool
- Return available state by tab identifier
- getTabInstance() : Tabable
- Return instance of tab class
- setCustomConfig() : array<string|int, mixed>|SystemException
- Set up custom preset of tab list
- setPresetName() : array<string|int, mixed>|null
- Set up preset by name
Constants
configPath
public
mixed
configPath
= "/bitrix/modules/mobile/.tab_config.php"
maxCount
public
mixed
maxCount
= 5
maxSortValue
public
mixed
maxSortValue
= 1000
tabDirectoryPath
public
mixed
tabDirectoryPath
= "/bitrix/modules/mobile/tabs/"
Methods
__construct()
Manager constructor.
public
__construct([mixed $context = null ]) : mixed
Parameters
- $context : mixed = null
Tags
defaultConfig()
public
defaultConfig() : mixed
getActiveTabs()
Return list of active tabs
public
getActiveTabs() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>getActiveTabsData()
Return data of active tabs
public
getActiveTabsData([array<string|int, mixed> $ids = [] ]) : array<string|int, mixed>
Parameters
- $ids : array<string|int, mixed> = []
Tags
Return values
array<string|int, mixed>getAllTabIDs()
public
getAllTabIDs([mixed $includeUnavailable = false ]) : mixed
Parameters
- $includeUnavailable : mixed = false
getPresetConfig()
Return configuration of current preset
public
getPresetConfig() : array<string|int, mixed>|null
Tags
Return values
array<string|int, mixed>|nullgetPresetList()
Return list of available presets
public
getPresetList() : array<string|int, mixed>
Return values
array<string|int, mixed>getPresetName()
Return name of current preset
public
getPresetName() : string
Tags
Return values
stringgetRequiredTabs()
Return list of required tabs, which must be always active
public
getRequiredTabs() : mixed
getTabAvailabilityState()
Return available state by tab identifier
public
getTabAvailabilityState([null $tabId = null ]) : bool
Parameters
- $tabId : null = null
Return values
boolgetTabInstance()
Return instance of tab class
public
getTabInstance([string $id = null ]) : Tabable
Parameters
- $id : string = null
Return values
TabablesetCustomConfig()
Set up custom preset of tab list
public
setCustomConfig([array<string|int, mixed> $config = [] ]) : array<string|int, mixed>|SystemException
Parameters
- $config : array<string|int, mixed> = []
Tags
Return values
array<string|int, mixed>|SystemExceptionsetPresetName()
Set up preset by name
public
setPresetName([string $name = "default" ]) : array<string|int, mixed>|null
Parameters
- $name : string = "default"