Bitrix API

User extends Counter

Class Counter

Table of Contents

Methods

get()  : bool|int|mixed
getCommentsCount()  : array<string|int, mixed>
getCounters()  : array<string|int, mixed>|array<string|int, array<string|int, mixed>>
getGlobalLimit()  : int
getInstance()  : static
getRawCounters()  : array<string|int, mixed>
getTaskCounters()  : array<string|int, mixed>
hasMajorForeignExpired()  : bool
isReady()  : bool
isSonetEnable()  : bool
onAfterTaskAdd()  : mixed
onAfterTaskDelete()  : mixed
onAfterTaskUpdate()  : mixed
onAfterTaskViewedFirstTime()  : mixed
onBeforeTaskAdd()  : mixed
onBeforeTaskDelete()  : mixed
onBeforeTaskUpdate()  : mixed
onBeforeTaskViewedFirstTime()  : mixed
processRecalculate()  : void
saveCounters()  : mixed

Methods

get()

public get(mixed $name[, int $entityId = 0 ]) : bool|int|mixed
Parameters
$name : mixed
$entityId : int = 0

(either group_id or flow_id)

Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
bool|int|mixed

getCommentsCount()

public getCommentsCount(array<string|int, mixed> $taskIds) : array<string|int, mixed>
Parameters
$taskIds : array<string|int, mixed>
Return values
array<string|int, mixed>

getCounters()

public getCounters(mixed $role[, int $groupId = 0 ][, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>|array<string|int, array<string|int, mixed>>
Parameters
$role : mixed
$groupId : int = 0
$params : array<string|int, mixed> = []
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
array<string|int, mixed>|array<string|int, array<string|int, mixed>>

getGlobalLimit()

public static getGlobalLimit() : int
Return values
int

getInstance()

public static getInstance(mixed $userId[, mixed $groupId = 0 ]) : static
Parameters
$userId : mixed
$groupId : mixed = 0
Return values
static

getRawCounters()

public getRawCounters([string $meta = CounterDictionary::META_PROP_ALL ]) : array<string|int, mixed>
Parameters
$meta : string = CounterDictionary::META_PROP_ALL
Return values
array<string|int, mixed>

getTaskCounters()

public getTaskCounters(int $taskId) : array<string|int, mixed>
Parameters
$taskId : int
Return values
array<string|int, mixed>

hasMajorForeignExpired()

public hasMajorForeignExpired([string $mode = CounterDictionary::META_PROP_SONET ]) : bool
Parameters
$mode : string = CounterDictionary::META_PROP_SONET
Return values
bool

isReady()

public static isReady(mixed $userId) : bool
Parameters
$userId : mixed
Return values
bool

isSonetEnable()

public static isSonetEnable() : bool
Return values
bool

onAfterTaskAdd()

public static onAfterTaskAdd(array<string|int, mixed> $fields) : mixed
Parameters
$fields : array<string|int, mixed>

onAfterTaskDelete()

public static onAfterTaskDelete(mixed $fields) : mixed
Parameters
$fields : mixed

onAfterTaskUpdate()

public static onAfterTaskUpdate(mixed $fields, mixed $newFields) : mixed
Parameters
$fields : mixed
$newFields : mixed

onAfterTaskViewedFirstTime()

public static onAfterTaskViewedFirstTime(mixed $taskId, mixed $userId, mixed $onTaskAdd) : mixed
Parameters
$taskId : mixed
$userId : mixed
$onTaskAdd : mixed

onBeforeTaskAdd()

public static onBeforeTaskAdd() : mixed

onBeforeTaskDelete()

public static onBeforeTaskDelete() : mixed

onBeforeTaskUpdate()

public static onBeforeTaskUpdate() : mixed

onBeforeTaskViewedFirstTime()

public static onBeforeTaskViewedFirstTime() : mixed

processRecalculate()

public processRecalculate(Collection $counterNamesCollection) : void

since tasks 20.800.0

Parameters
$counterNamesCollection : Collection
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException

Kept due to backward compatibility

saveCounters()

public saveCounters() : mixed

        
On this page

Search results