Bitrix API

SumStatistics extends DataSource

Table of Contents

Constants

GROUP_BY_DATE  = 'DATE'
GROUP_BY_USER  = 'USER'
TYPE_NAME  = 'ACTIVITY_SUM_STATS'

Methods

__construct()  : mixed
applyFilterContext()  : void
Prepare filter extra params according to context data.
enablePermissionCheck()  : mixed
Enable or disable permission control
extractDetailsPageUrlParams()  : array<string|int, mixed>
Extract details page URL params from request.
getAttributes()  : array<string|int, mixed>
Returns special settings for source.
getCacheData()  : mixed
getDataContext()  : string
Get current data context
getDetailsPageUrl()  : string
Get details page URL.
getFilterContextData()  : array<string|int, mixed>
Get filtration context parameters dictionary
getFirst()  : array<string|int, mixed>
Get first entity from list.
getFirstValue()  : array<string|int, mixed>
Get field value of first entity from list.
getList()  : array<string|int, mixed>
Get entity list.
getPresetFullName()  : string
Get data preset full name (Data source name + preset name)
getPresetName()  : string
Get data preset name
getPresets()  : array<string|int, mixed>
getTypeName()  : string
Get Datasource type name.
getUserID()  : int
Get User ID.
initializeDemoData()  : array<string|int, mixed>
Initialize Demo data.
isPermissionCheckEnabled()  : bool
Check if permission control enabled.
parseUserInfo()  : mixed
prepareEntityListFilter()  : array<string|int, mixed>
Prepare entity list filter.
setCacheData()  : mixed
setFilterContextData()  : void
Set filtration context parameters dictionary

Constants

Methods

__construct()

public __construct(array<string|int, mixed> $settings[, mixed $userID = 0 ][, mixed $enablePermissionCheck = true ]) : mixed
Parameters
$settings : array<string|int, mixed>
$userID : mixed = 0
$enablePermissionCheck : mixed = true

applyFilterContext()

Prepare filter extra params according to context data.

public applyFilterContext(Filter $filter) : void
Parameters
$filter : Filter

enablePermissionCheck()

Enable or disable permission control

public enablePermissionCheck(bool $enable) : mixed
Parameters
$enable : bool

New value

extractDetailsPageUrlParams()

Extract details page URL params from request.

public static extractDetailsPageUrlParams(array<string|int, mixed> $request) : array<string|int, mixed>
Parameters
$request : array<string|int, mixed>

Source request params.

Tags
static
Return values
array<string|int, mixed>

getAttributes()

Returns special settings for source.

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

getCacheData()

public getCacheData(mixed $cacheID, mixed $filter) : mixed
Parameters
$cacheID : mixed
$filter : mixed

getDataContext()

Get current data context

public getDataContext() : string
Return values
string —

DataContext

getDetailsPageUrl()

Get details page URL.

public getDetailsPageUrl(array<string|int, mixed> $params) : string
Parameters
$params : array<string|int, mixed>

Parameters.

Tags
throws
ObjectNotFoundException
Return values
string

getFilterContextData()

Get filtration context parameters dictionary

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

getFirst()

Get first entity from list.

public getFirst(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed>

List params.

Return values
array<string|int, mixed>

getFirstValue()

Get field value of first entity from list.

public getFirstValue(array<string|int, mixed> $params, string $fieldName[, string $defaultValue = '' ]) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed>

List params.

$fieldName : string

Field name.

$defaultValue : string = ''

Default field value.

Return values
array<string|int, mixed>

getList()

Get entity list.

public getList(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed>
Tags
throws
ObjectNotFoundException
Return values
array<string|int, mixed>

getPresetFullName()

Get data preset full name (Data source name + preset name)

public getPresetFullName() : string
Return values
string

getPresetName()

Get data preset name

public getPresetName() : string
Return values
string

getPresets()

public static getPresets() : array<string|int, mixed>
Return values
array<string|int, mixed> —

Array of arrays

getTypeName()

Get Datasource type name.

public getTypeName() : string
Return values
string

getUserID()

Get User ID.

public getUserID() : int
Return values
int

initializeDemoData()

Initialize Demo data.

public initializeDemoData(array<string|int, mixed> $data, array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
$data : array<string|int, mixed>

Data.

$params : array<string|int, mixed>

Parameters.

Return values
array<string|int, mixed>

isPermissionCheckEnabled()

Check if permission control enabled.

public isPermissionCheckEnabled() : bool
Return values
bool

parseUserInfo()

public static parseUserInfo(mixed &$result, array<string|int, mixed> $aliases) : mixed
Parameters
$result : mixed
$aliases : array<string|int, mixed>

prepareEntityListFilter()

Prepare entity list filter.

public prepareEntityListFilter(array<string|int, mixed> $filterParams) : array<string|int, mixed>
Parameters
$filterParams : array<string|int, mixed>

Filter parameters.

Return values
array<string|int, mixed>

setCacheData()

public setCacheData(mixed $data) : mixed
Parameters
$data : mixed

setFilterContextData()

Set filtration context parameters dictionary

public setFilterContextData(array<string|int, mixed> $data) : void
Parameters
$data : array<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results