Bitrix API

IVolumeIndicator

Table of Contents

Methods

addFilter()  : static
Sets filter parameters.
addSelect()  : static
Sets select field.
className()  : string
getCorrespondingFileList()  : Result
Loads file list corresponding to indicator's filter.
getCorrespondingFolderList()  : Result
Loads folder list corresponding to indicator's filter.
getCorrespondingUnnecessaryVersionList()  : Result
Loads file version list corresponding to indicator's filter.
getDiskCount()  : int
Returns total amount of objects on disk.
getDiskSize()  : int
Returns total volume size of objects on disk.
getFilter()  : array<string|int, mixed>
Gets filter parameters.
getFilterId()  : int
Gets stored filter id.
getFilterValue()  : mixed|null
Gets filter parameter by key.
getFragment()  : Fragment
Finds entity object by filter.
getIndicatorId()  : string
getLimit()  : int
Gets limit result rows count.
getMeasurementResult()  : Result
Returns calculation result set.
getMeasureStages()  : array<string|int, string>
Returns measure process stages list.
getOffset()  : int
Gets offset in result.
getOrder()  : array<string|int, mixed>
Gets sort order parameters
getOwner()  : int
Gets owner id.
getPreviewCount()  : float
Returns total amount of preview files.
getPreviewSize()  : float
Returns total volume size of preview files.
getSelect()  : array<string|int, mixed>
Gets select fields.
getStage()  : string|null
Gets stage id.
getTitle()  : string|null
Returns title of the entity object.
getTotalAttached()  : int
Returns total amount of attached objects selecting by filter.
getTotalCount()  : int
Returns total amount of objects selecting by filter.
getTotalLink()  : int
Returns total amount of external links to objects selecting by filter.
getTotalSharing()  : int
Returns total number sharing of objects selecting by filter.
getTotalSize()  : int
Returns total volume size of objects selecting by filter.
getTotalVersion()  : int
Returns total amount of objects selecting by filter.
getUnnecessaryVersionCount()  : int
Returns total count of files without links and attached object.
getUnnecessaryVersionSize()  : int
Returns total amount of files without links and attached object.
getUpdateTime()  : DateTime|null
Returns last update time of the entity object.
isResultAvailable()  : bool
Tells true if total result is available.
loadTotals()  : array<string|int, int>
Returns total amount of objects selecting by filter.
measure()  : static
Runs measure test to get volumes of selecting objects.
prepareData()  : static
Preforms data preparation.
purify()  : static
Deletes objects selecting by filter.
recalculatePercent()  : static
Recalculates percent from total file size per row selected by filter.
resetMeasurementResult()  : static
Unset calculated values.
restoreFilter()  : static
Restores filter state from saved $measurement result.
setFilterId()  : static
Sets filter id.
setLimit()  : static
Sets limit result rows count.
setOffset()  : static
Sets offset in result.
setOrder()  : static
Sets sort order parameters.
setOwner()  : static
Sets owner id.
setStage()  : static
Sets current stage id.
unsetFilter()  : static
Clear filter parameters.

Methods

addFilter()

Sets filter parameters.

public addFilter(string $key, string $value) : static
Parameters
$key : string

Parameter name to filter.

$value : string

Parameter value.

Return values
static

addSelect()

Sets select field.

public addSelect(string $alias, string $statement) : static
Parameters
$alias : string

Parameter alias.

$statement : string

Parameter value.

Return values
static

className()

public static className() : string
Return values
string —

The fully qualified name of this class.

getCorrespondingFileList()

Loads file list corresponding to indicator's filter.

public getCorrespondingFileList([array<string|int, mixed> $additionalFilter = [] ]) : Result
Parameters
$additionalFilter : array<string|int, mixed> = []

Additional parameters to filter file list.

Return values
Result

getCorrespondingFolderList()

Loads folder list corresponding to indicator's filter.

public getCorrespondingFolderList([array<string|int, mixed> $additionalFilter = [] ]) : Result
Parameters
$additionalFilter : array<string|int, mixed> = []

Additional parameters to filter file list.

Return values
Result

getCorrespondingUnnecessaryVersionList()

Loads file version list corresponding to indicator's filter.

public getCorrespondingUnnecessaryVersionList([array<string|int, mixed> $additionalFilter = [] ]) : Result
Parameters
$additionalFilter : array<string|int, mixed> = []

Additional parameters to filter file list.

Return values
Result

getDiskCount()

Returns total amount of objects on disk.

public getDiskCount() : int
Return values
int

getDiskSize()

Returns total volume size of objects on disk.

public getDiskSize() : int
Return values
int

getFilter()

Gets filter parameters.

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

Default filter set.

Return values
array<string|int, mixed>

getFilterId()

Gets stored filter id.

public getFilterId() : int
Return values
int

getFilterValue()

Gets filter parameter by key.

public getFilterValue(string $key[, string $acceptedListModificators = '=<>!@%' ]) : mixed|null
Parameters
$key : string

Parameter name to filter.

$acceptedListModificators : string = '=<>!@%'

List of accepted filter modificator. Defaults are '=<>!@%'.

Return values
mixed|null

getFragment()

Finds entity object by filter.

public static getFragment(array<string|int, string> $filter) : Fragment
Parameters
$filter : array<string|int, string>

Array filter set to find entity object.

Return values
Fragment

getIndicatorId()

public static getIndicatorId() : string
Return values
string —

The short indicator name of this class.

getLimit()

Gets limit result rows count.

public getLimit() : int
Return values
int

getMeasurementResult()

Returns calculation result set.

public getMeasurementResult([array<string|int, mixed> $collectedData = [] ]) : Result
Parameters
$collectedData : array<string|int, mixed> = []

List types of collected data to return.

Return values
Result

getMeasureStages()

Returns measure process stages list.

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

getOffset()

Gets offset in result.

public getOffset() : int
Return values
int

getOrder()

Gets sort order parameters

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

getPreviewCount()

Returns total amount of preview files.

public getPreviewCount() : float
Return values
float

getPreviewSize()

Returns total volume size of preview files.

public getPreviewSize() : float
Return values
float

getSelect()

Gets select fields.

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

getStage()

Gets stage id.

public getStage() : string|null
Return values
string|null

getTitle()

Returns title of the entity object.

public static getTitle(Fragment $fragment) : string|null
Parameters
$fragment : Fragment

Entity object.

Return values
string|null

getTotalAttached()

Returns total amount of attached objects selecting by filter.

public getTotalAttached() : int
Return values
int

getTotalCount()

Returns total amount of objects selecting by filter.

public getTotalCount() : int
Return values
int

getTotalLink()

Returns total amount of external links to objects selecting by filter.

public getTotalLink() : int
Return values
int

getTotalSharing()

Returns total number sharing of objects selecting by filter.

public getTotalSharing() : int
Return values
int

getTotalSize()

Returns total volume size of objects selecting by filter.

public getTotalSize() : int
Return values
int

getTotalVersion()

Returns total amount of objects selecting by filter.

public getTotalVersion() : int
Return values
int

getUnnecessaryVersionCount()

Returns total count of files without links and attached object.

public getUnnecessaryVersionCount() : int
Return values
int

getUnnecessaryVersionSize()

Returns total amount of files without links and attached object.

public getUnnecessaryVersionSize() : int
Return values
int

isResultAvailable()

Tells true if total result is available.

public isResultAvailable() : 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>

measure()

Runs measure test to get volumes of selecting objects.

public measure([array<string|int, mixed> $collectData = [] ]) : static
Parameters
$collectData : array<string|int, mixed> = []

List types data to collect.

Return values
static

prepareData()

Preforms data preparation.

public prepareData() : static
Return values
static

purify()

Deletes objects selecting by filter.

public purify() : static
Return values
static

recalculatePercent()

Recalculates percent from total file size per row selected by filter.

public recalculatePercent(string|IVolumeIndicator $totalSizeIndicator, string|IVolumeIndicator $excludeSizeIndicator) : static
Parameters
$totalSizeIndicator : string|IVolumeIndicator

Use this indicator as total volume.

$excludeSizeIndicator : string|IVolumeIndicator

Exclude indicator's volume from total volume.

Return values
static

resetMeasurementResult()

Unset calculated values.

public resetMeasurementResult() : static
Return values
static

restoreFilter()

Restores filter state from saved $measurement result.

public restoreFilter(int|array<string|int, mixed> $measurementResult) : static
Parameters
$measurementResult : int|array<string|int, mixed>

The id of result row or row from table.

Return values
static

setFilterId()

Sets filter id.

public setFilterId(int $filterId) : static
Parameters
$filterId : int

Stored filter id.

Return values
static

setLimit()

Sets limit result rows count.

public setLimit(int $limit) : static
Parameters
$limit : int

Limit value.

Return values
static

setOffset()

Sets offset in result.

public setOffset(int $offset) : static
Parameters
$offset : int

Offset value.

Return values
static

setOrder()

Sets sort order parameters.

public setOrder(array<string|int, string> $order) : static
Parameters
$order : array<string|int, string>

Sort order parameters and directions.

Return values
static

setOwner()

Sets owner id.

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

User id.

Return values
static

setStage()

Sets current stage id.

public setStage(string|null $stageId) : static
Parameters
$stageId : string|null

Stage id.

Return values
static

unsetFilter()

Clear filter parameters.

public unsetFilter([string $key = '' ]) : static
Parameters
$key : string = ''

Parameter name to unset.

Return values
static 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results