IVolumeIndicatorModule
Table of Contents
Methods
- getAttachedEntityList() : array<string|int, string>
- Returns entity list attached to disk object corresponding to module.
- getEntityList() : array<string|int, string>
- Returns entity list with user field corresponding to module.
- getEntityType() : array<string|int, string>
- Returns entity type list.
- getFolderList() : array<string|int, Folder>|array<string|int, mixed>
- Returns folder list corresponding to module.
- getIblockList() : array<string|int, mixed>
- Returns iblock list corresponding to module.
- getModuleId() : string
- Returns module identifier.
- getSpecialFolderCode() : array<string|int, string>
- Returns special folder code list.
- getSpecialFolderXmlId() : array<string|int, string>
- Returns special folder xml_id code list.
- getSpecific() : array<string|int, mixed>
- Returns entity specific corresponding to module.
- getStorageList() : array<string|int, Storage>|array<string|int, mixed>
- Returns storage corresponding to module.
- getUserTypeFieldList() : array<string|int, mixed>
- Returns list of user fields corresponding to entity.
- isMeasureAvailable() : bool
- Returns true if module installed and available to measure.
Methods
getAttachedEntityList()
Returns entity list attached to disk object corresponding to module.
public
getAttachedEntityList() : array<string|int, string>
Return values
array<string|int, string>getEntityList()
Returns entity list with user field corresponding to module.
public
getEntityList() : array<string|int, string>
Return values
array<string|int, string>getEntityType()
Returns entity type list.
public
static getEntityType() : array<string|int, string>
Return values
array<string|int, string>getFolderList()
Returns folder list corresponding to module.
public
getFolderList(Storage $storage) : array<string|int, Folder>|array<string|int, mixed>
Parameters
- $storage : Storage
-
Module's storage.
Return values
array<string|int, Folder>|array<string|int, mixed>getIblockList()
Returns iblock list corresponding to module.
public
getIblockList() : array<string|int, mixed>
Return values
array<string|int, mixed>getModuleId()
Returns module identifier.
public
static getModuleId() : string
Return values
stringgetSpecialFolderCode()
Returns special folder code list.
public
static getSpecialFolderCode() : array<string|int, string>
Return values
array<string|int, string>getSpecialFolderXmlId()
Returns special folder xml_id code list.
public
static getSpecialFolderXmlId() : array<string|int, string>
Return values
array<string|int, string>getSpecific()
Returns entity specific corresponding to module.
public
static getSpecific(Fragment $fragment) : array<string|int, mixed>
Parameters
- $fragment : Fragment
-
Entity object.
Return values
array<string|int, mixed>getStorageList()
Returns storage corresponding to module.
public
getStorageList() : array<string|int, Storage>|array<string|int, mixed>
Return values
array<string|int, Storage>|array<string|int, mixed>getUserTypeFieldList()
Returns list of user fields corresponding to entity.
public
getUserTypeFieldList(string $entityClass) : array<string|int, mixed>
Parameters
- $entityClass : string
-
Class name of entity.
Return values
array<string|int, mixed>isMeasureAvailable()
Returns true if module installed and available to measure.
public
isMeasureAvailable() : bool