Bitrix API

IVolumeIndicator

Table of Contents

Methods

addFilter()  : $this
Sets filter parameters.
canBeFiltered()  : bool
Can filter applied to the indicator.
className()  : string
The fully qualified name of this class.
getActionList()  : array<string|int, mixed>
Component action list for measure process.
getActivityCount()  : int
Returns total amount of activities and associated files.
getActivitySize()  : int
Returns total volume size of activities and associated files.
getDiskConnector()  : string|null
Returns entity list attached to disk object.
getDiskCount()  : int
Returns total amount of files on disk.
getDiskSize()  : int
Returns total volume size of files on disk.
getEntityCount()  : int
Returns total count of entities corresponding to indicator.
getEntityList()  : array<string|int, string>
Returns entity list.
getEntitySize()  : int
Returns total volume size of tables.
getEventCount()  : int
Returns total amount of events and associated files.
getEventSize()  : int
Returns total volume size of events and associated files.
getFileCount()  : int
Returns total amount of files corresponding to indicator.
getFileSize()  : int
Returns total volume size of files.
getFilter()  : array<string|int, mixed>
Gets filter parameters.
getFilterValue()  : mixed|null
Gets filter parameter by key.
getIndicatorId()  : string
The short indicator name of this class.
getLiveFeedConnector()  : string|null
Returns Socialnetwork log entity list attached to disk object.
getOwner()  : int
Gets owner id.
getSpecialFolderList()  : array<string|int, Folder>|null
Returns special folder list.
getTableList()  : array<string|int, string>
Returns table list corresponding to indicator.
getTitle()  : string
Returns title of the entity object.
getTotalSize()  : int
Returns total volume size.
getUserTypeFieldList()  : array<string|int, mixed>
Returns list of user fields corresponding to entity.
isParticipatedTotal()  : bool
Tells that is is participated in the total volume.
loadTotals()  : array<string|int, int>
Returns total amount of objects selecting by filter.
measure()  : self
Runs measure test.
measureEntity()  : self
Runs measure test for tables.
measureFiles()  : self
Runs measure test for files.
prepareFilter()  : bool
Setups filter params into query.
prepareQuery()  : Query
Returns query.
purify()  : self
Deletes objects selecting by filter.
setFilter()  : $this
Replace filter parameters.
setOwner()  : void
Sets owner id.

Methods

addFilter()

Sets filter parameters.

public addFilter(string $key, string|array<string|int, string> $value) : $this
Parameters
$key : string

Parameter name to filter.

$value : string|array<string|int, string>

Parameter value.

Return values
$this

canBeFiltered()

Can filter applied to the indicator.

public canBeFiltered() : bool
Return values
bool

className()

The fully qualified name of this class.

public static className() : string
Return values
string

getActionList()

Component action list for measure process.

public getActionList(array<string|int, mixed> $componentCommandAlias) : array<string|int, mixed>
Parameters
$componentCommandAlias : array<string|int, mixed>

Command alias.

Return values
array<string|int, mixed>

getActivityCount()

Returns total amount of activities and associated files.

public getActivityCount() : int
Return values
int

getActivitySize()

Returns total volume size of activities and associated files.

public getActivitySize() : int
Return values
int

getDiskConnector()

Returns entity list attached to disk object.

public static getDiskConnector(string $entityClass) : string|null
Parameters
$entityClass : string

Class name of entity.

Return values
string|null

getDiskCount()

Returns total amount of files on disk.

public getDiskCount() : int
Return values
int

getDiskSize()

Returns total volume size of files on disk.

public getDiskSize() : int
Return values
int

getEntityCount()

Returns total count of entities corresponding to indicator.

public getEntityCount() : int
Return values
int

getEntityList()

Returns entity list.

public static getEntityList() : array<string|int, string>
Return values
array<string|int, string>

getEntitySize()

Returns total volume size of tables.

public getEntitySize() : int
Return values
int

getEventCount()

Returns total amount of events and associated files.

public getEventCount() : int
Return values
int

getEventSize()

Returns total volume size of events and associated files.

public getEventSize() : int
Return values
int

getFileCount()

Returns total amount of files corresponding to indicator.

public getFileCount() : int
Return values
int

getFileSize()

Returns total volume size of files.

public getFileSize() : int
Return values
int

getFilter()

Gets filter parameters.

public getFilter([array<string|int, string> $defaultFilter = array() ]) : array<string|int, mixed>
Parameters
$defaultFilter : array<string|int, string> = array()

Default filter set.

Return values
array<string|int, mixed>

getFilterValue()

Gets filter parameter by key.

public getFilterValue(string $key[, mixed|null $defaultValue = null ]) : mixed|null
Parameters
$key : string

Parameter name to filter.

$defaultValue : mixed|null = null

Default value.

Return values
mixed|null

getIndicatorId()

The short indicator name of this class.

public static getIndicatorId() : string
Return values
string

getLiveFeedConnector()

Returns Socialnetwork log entity list attached to disk object.

public static getLiveFeedConnector(string $entityClass) : string|null
Parameters
$entityClass : string

Class name of entity.

Return values
string|null

getSpecialFolderList()

Returns special folder list.

public getSpecialFolderList() : array<string|int, Folder>|null
Return values
array<string|int, Folder>|null

getTableList()

Returns table list corresponding to indicator.

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

getTitle()

Returns title of the entity object.

public getTitle() : string
Return values
string

getTotalSize()

Returns total volume size.

public getTotalSize() : int
Return values
int

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>

isParticipatedTotal()

Tells that is is participated in the total volume.

public isParticipatedTotal() : bool
Return values
bool

loadTotals()

Returns total amount of objects selecting by filter.

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

measureEntity()

Runs measure test for tables.

public measureEntity() : self
Return values
self

measureFiles()

Runs measure test for files.

public measureFiles() : self
Return values
self

prepareFilter()

Setups filter params into query.

public prepareFilter(Query $query) : bool
Parameters
$query : Query

Query.

Return values
bool

purify()

Deletes objects selecting by filter.

public purify() : self
Return values
self

setFilter()

Replace filter parameters.

public setFilter(array<string|int, mixed> $filter) : $this
Parameters
$filter : array<string|int, mixed>

Filter key = value pair.

Return values
$this

setOwner()

Sets owner id.

public setOwner(int $ownerId) : void
Parameters
$ownerId : int

User id.


        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results