Bitrix API

Address extends Base

Table of Contents

Constants

ERROR_DELETION_FAILED  = 'CRM_DELETION_FAILED'
ERROR_PERMISSION_DENIED  = 'CRM_PERMISSION_DENIED'
MAX_ENTITY_PER_INTERACTION  = 1000
MAX_FILE_PER_INTERACTION  = 1000

Methods

addFilter()  : $this
Sets filter parameters.
canBeFiltered()  : bool
Can filter applied to the indicator.
className()  : string
The fully qualified name of this class.
collectError()  : void
Adds an array of errors to the collection.
delFilterValue()  : void
Removes filter parameter by key.
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.
getDateSplitPeriod()  : array<string|int, mixed>
Returns date split period.
getDiskConnector()  : string|null
Returns entity list attached to disk object.
getDiskCount()  : float
Returns total amount of files on disk.
getDiskSize()  : float
Returns total volume size of file on disk.
getDroppedEntityCount()  : int
Returns dropped count of entities.
getDroppedFileCount()  : int
Returns dropped count of entity attachments.
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 corresponding to indicator.
getEventCount()  : int
Returns total amount of events and associated files.
getEventSize()  : int
Returns total volume size of events and associated files.
getFailCount()  : int
Returns error count.
getFileCount()  : int
Returns total amount of files corresponding to indicator.
getFileSize()  : int
Returns total volume size of files corresponding to indicator.
getFilter()  : array<string|int, mixed>
Gets filter parameters.
getFilterValue()  : mixed|null
Gets filter parameter by key.
getIndicator()  : IVolumeIndicator
Constructs and returns indicator type object.
getIndicatorId()  : string
The short indicator name of this class.
getLastError()  : Error|null
Returns errors list.
getListIndicator()  : array<string|int, mixed>
Returns indicator list available in library.
getLiveFeedConnector()  : string|null
Returns Socialnetwork log entity list attached to disk object.
getOwner()  : int|null
Gets owner id.
getProcessOffset()  : int
Returns process offset.
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 indicator.
getTotalSize()  : float
Returns total volume size.
getUserTypeFieldList()  : array<string|int, mixed>
Returns list of user fields corresponding to entity.
hasTimeLimitReached()  : bool
Tells true if time limit reached.
incrementDroppedEntityCount()  : void
Returns dropped count of entities.
incrementDroppedFileCount()  : void
Returns dropped count of entity attachments.
incrementFailCount()  : void
Returns error count.
isParticipatedTotal()  : bool
Tells that is is participated in the total volume.
loadTotals()  : array<string|int, float>
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.
prepareEntityFilter()  : bool
Setups filter params into query.
prepareFilter()  : bool
Setups filter params into query.
prepareQuery()  : Query
Returns query.
purify()  : self
Deletes objects selecting by filter.
setDateSplitPeriod()  : void
Sets date split period.
setDroppedEntityCount()  : void
Sets dropped count of entities.
setDroppedFileCount()  : void
Sets dropped count of entity attachments.
setFailCount()  : void
Sets error count.
setFilter()  : $this
Replace filter parameters.
setOwner()  : void
Sets owner id.
setProcessOffset()  : void
Setup process offset.
startTimer()  : void
Start up timer.

Constants

ERROR_DELETION_FAILED

public mixed ERROR_DELETION_FAILED = 'CRM_DELETION_FAILED'

ERROR_PERMISSION_DENIED

public mixed ERROR_PERMISSION_DENIED = 'CRM_PERMISSION_DENIED'

MAX_ENTITY_PER_INTERACTION

public mixed MAX_ENTITY_PER_INTERACTION = 1000

MAX_FILE_PER_INTERACTION

public mixed MAX_FILE_PER_INTERACTION = 1000

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 final static className() : string
Return values
string —

the fully qualified name of this class.

collectError()

Adds an array of errors to the collection.

public collectError(array<string|int, Error>|Error $errors) : void
Parameters
$errors : array<string|int, Error>|Error

Raised error.

delFilterValue()

Removes filter parameter by key.

public delFilterValue(string $key[, string $acceptedListModificators = '<>!=' ]) : void
Parameters
$key : string

Parameter name to filter.

$acceptedListModificators : string = '<>!='

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

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

getDateSplitPeriod()

Returns date split period.

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

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() : float
Return values
float

getDiskSize()

Returns total volume size of file on disk.

public getDiskSize() : float
Return values
float

getDroppedEntityCount()

Returns dropped count of entities.

public getDroppedEntityCount() : int
Tags
@implements

Volume\IVolumeClear

Return values
int

getDroppedFileCount()

Returns dropped count of entity attachments.

public getDroppedFileCount() : int
Tags
@implements

Volume\IVolumeClearFile

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 corresponding to indicator.

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

getFailCount()

Returns error count.

public getFailCount() : int
Tags
@implements

Volume\IVolumeClear

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 corresponding to indicator.

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 ][, string $acceptedListModificators = '<>!=' ]) : mixed|null
Parameters
$key : string

Parameter name to filter.

$defaultValue : mixed|null = null

Default value.

$acceptedListModificators : string = '<>!='

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

Return values
mixed|null

getIndicator()

Constructs and returns indicator type object.

public final static getIndicator(string $indicatorId) : IVolumeIndicator
Parameters
$indicatorId : string

Indicator class name.

Tags
throws
ObjectException
throws
ArgumentNullException
Return values
IVolumeIndicator

getIndicatorId()

The short indicator name of this class.

public final static getIndicatorId() : string
Return values
string —

The short indicator name of this class.

getLastError()

Returns errors list.

public getLastError() : Error|null
Tags
@implements

Volume\IVolumeClear

Return values
Error|null

getListIndicator()

Returns indicator list available in library.

public final static getListIndicator() : array<string|int, mixed>
Return values
array<string|int, mixed>

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

getOwner()

Gets owner id.

public getOwner() : int|null
Return values
int|null

getProcessOffset()

Returns process offset.

public getProcessOffset() : int
Tags
@implements

Volume\IVolumeClear

p
Return values
int

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>
Tags
throws
SqlQueryException
Return values
array<string|int, string>

getTitle()

Returns title of the indicator.

public getTitle() : string
Return values
string

getTotalSize()

Returns total volume size.

public getTotalSize() : float
Return values
float

getUserTypeFieldList()

Returns list of user fields corresponding to entity.

public getUserTypeFieldList(string $entity) : array<string|int, mixed>
Parameters
$entity : string

Class name of entity.

Return values
array<string|int, mixed>

hasTimeLimitReached()

Tells true if time limit reached.

public hasTimeLimitReached() : bool
Tags
@implements

Volume\IVolumeClear

Return values
bool

incrementDroppedEntityCount()

Returns dropped count of entities.

public incrementDroppedEntityCount([int $count = 1 ]) : void
Parameters
$count : int = 1

Amount to increment.

Tags
@implements

Volume\IVolumeClear

incrementDroppedFileCount()

Returns dropped count of entity attachments.

public incrementDroppedFileCount([int $count = 1 ]) : void
Parameters
$count : int = 1

Amount to increment.

Tags
@implements

Volume\IVolumeClearFile

incrementFailCount()

Returns error count.

public incrementFailCount([int $count = 1 ]) : void
Parameters
$count : int = 1

Amount to increment.

Tags
@implements

Volume\IVolumeClearEvent

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, float>
Return values
array<string|int, float>

measure()

Runs measure test.

public measure() : self
Return values
self

measureEntity()

Runs measure test for tables.

public measureEntity() : self
Return values
self

measureFiles()

Runs measure test for files.

public measureFiles() : self
Tags
throws
SqlQueryException
throws
LoaderException
Return values
self

prepareEntityFilter()

Setups filter params into query.

public prepareEntityFilter(Query $query, Entity $entity[, string $entityAlias = '' ]) : bool
Parameters
$query : Query

Query.

$entity : Entity

Use only this entity fields.

$entityAlias : string = ''

Table alias.

Return values
bool

prepareFilter()

Setups filter params into query.

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

Query.

Return values
bool

prepareQuery()

Returns query.

public prepareQuery() : Query
Return values
Query

purify()

Deletes objects selecting by filter.

public purify() : self
Return values
self

setDateSplitPeriod()

Sets date split period.

public setDateSplitPeriod(array<string|int, mixed> $dateSplitPeriod) : void
Parameters
$dateSplitPeriod : array<string|int, mixed>

Value and units.

setDroppedEntityCount()

Sets dropped count of entities.

public setDroppedEntityCount(int $count) : void
Parameters
$count : int

Amount to set.

Tags
@implements

Volume\IVolumeClear

setDroppedFileCount()

Sets dropped count of entity attachments.

public setDroppedFileCount(int $count) : void
Parameters
$count : int

Amount to set.

Tags
@implements

Volume\IVolumeClearFile

setFailCount()

Sets error count.

public setFailCount(int $count) : void
Parameters
$count : int

Amount to set.

Tags
@implements

Volume\IVolumeClear

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.

setProcessOffset()

Setup process offset.

public setProcessOffset(int $offset) : void
Parameters
$offset : int

Offset position.

Tags
@implements

Volume\IVolumeClear

startTimer()

Start up timer.

public startTimer([int $timeLimit = 25 ]) : void
Parameters
$timeLimit : int = 25

Time limit.

Tags
@implements

Volume\IVolumeClear


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results