Bitrix API

Idle extends QueryBuilder

Idle counter.

Counts entities without activities and without wait entities.

Table of Contents

Constants

SELECT_TYPE_ENTITIES  = 'ENTY'
SELECT_TYPE_QUANTITY  = 'QTY'

Methods

__construct()  : mixed
build()  : Query
buildCompatible()  : Query
getCounterLimit()  : int|null
getSelectType()  : string
isUseDistinct()  : bool
needExcludeUsers()  : bool
setCounterLimit()  : self
setExcludeUsers()  : self
setSelectType()  : self
setUseDistinct()  : self
setUseUncompletedActivityTable()  : self
useUncompletedActivityTable()  : bool

Constants

SELECT_TYPE_ENTITIES

public mixed SELECT_TYPE_ENTITIES = 'ENTY'

SELECT_TYPE_QUANTITY

public mixed SELECT_TYPE_QUANTITY = 'QTY'

Methods

__construct()

public __construct(int $entityTypeId[, array<string|int, mixed> $userIds = [] ]) : mixed
Parameters
$entityTypeId : int
$userIds : array<string|int, mixed> = []

getCounterLimit()

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

getSelectType()

public getSelectType() : string
Return values
string

isUseDistinct()

public isUseDistinct() : bool
Return values
bool

needExcludeUsers()

public needExcludeUsers() : bool
Return values
bool

setCounterLimit()

public setCounterLimit(int|null $counterLimit) : self
Parameters
$counterLimit : int|null
Return values
self

setExcludeUsers()

public setExcludeUsers(bool $needExcludeUsers) : self
Parameters
$needExcludeUsers : bool
Return values
self

setSelectType()

public setSelectType(string $selectType) : self
Parameters
$selectType : string
Return values
self

setUseDistinct()

public setUseDistinct(bool $useDistinct) : self
Parameters
$useDistinct : bool
Return values
self

setUseUncompletedActivityTable()

public setUseUncompletedActivityTable(bool $useUncompletedActivityTable) : self
Parameters
$useUncompletedActivityTable : bool
Return values
self

useUncompletedActivityTable()

public useUncompletedActivityTable() : bool
Return values
bool

        
On this page

Search results