Bitrix API

Filter extends Common

Table of Contents

Constants

ACCOMPLICE_PRESET  = 'filter_tasks_role_accomplice'
AUDITOR_PRESET  = 'filter_tasks_role_auditor'
ORIGINATOR_PRESET  = 'filter_tasks_role_originator'
REGULAR_PRESET  = 'filter_tasks_task_is_regular'
RESPONSIBLE_PRESET  = 'filter_tasks_role_responsible'
SCRUM_PRESET  = 'filter_tasks_scrum'

Methods

getAllPresets()  : array<string|int, mixed>
getAvailableFields()  : array<string|int, mixed>
Get available fields in filter.
getContext()  : string
getDefaultPresetKey()  : mixed
getDefaultRoleId()  : false|mixed|string|null
getFilters()  : array<string|int, mixed>
getId()  : string|null
getInstance()  : static
getListStateInstance()  : CTaskListState|null
getOptions()  : Options
getPresets()  : array<string|int, mixed>
getRegularPresets()  : array<string|int, mixed>
getRolePresets()  : array<string|int, mixed>
getUserId()  : int
isExactSearchApplied()  : bool
The method checks if the current filter is more accurate than presets.
isRolesEnabled()  : bool
isScrumProject()  : bool
process()  : array<string|int, mixed>
setContext()  : static
setFilterData()  : void
setGanttMode()  : static
setRolePresetsEnabledForMobile()  : void

Constants

ACCOMPLICE_PRESET

public mixed ACCOMPLICE_PRESET = 'filter_tasks_role_accomplice'

AUDITOR_PRESET

public mixed AUDITOR_PRESET = 'filter_tasks_role_auditor'

ORIGINATOR_PRESET

public mixed ORIGINATOR_PRESET = 'filter_tasks_role_originator'

REGULAR_PRESET

public mixed REGULAR_PRESET = 'filter_tasks_task_is_regular'

RESPONSIBLE_PRESET

public mixed RESPONSIBLE_PRESET = 'filter_tasks_role_responsible'

SCRUM_PRESET

public mixed SCRUM_PRESET = 'filter_tasks_scrum'

Methods

getAllPresets()

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

getAvailableFields()

Get available fields in filter.

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

getContext()

public getContext() : string
Return values
string

getDefaultPresetKey()

public getDefaultPresetKey() : mixed

getDefaultRoleId()

public getDefaultRoleId() : false|mixed|string|null
Return values
false|mixed|string|null

getFilters()

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

getId()

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

getInstance()

public static getInstance([int $userId = 0 ][, int|null $groupId = 0 ][, string|null $id = null ]) : static
Parameters
$userId : int = 0
$groupId : int|null = 0
$id : string|null = null
Return values
static

getListStateInstance()

public getListStateInstance() : CTaskListState|null
Return values
CTaskListState|null

getPresets()

public static getPresets([self $filterInstance = null ]) : array<string|int, mixed>
Parameters
$filterInstance : self = null
Return values
array<string|int, mixed>

getRegularPresets()

public static getRegularPresets([int $startSort = 0 ]) : array<string|int, mixed>
Parameters
$startSort : int = 0
Return values
array<string|int, mixed>

getRolePresets()

public static getRolePresets([bool $isScrumProject = false ]) : array<string|int, mixed>
Parameters
$isScrumProject : bool = false
Return values
array<string|int, mixed>

getUserId()

public getUserId() : int
Return values
int

isExactSearchApplied()

The method checks if the current filter is more accurate than presets.

public isExactSearchApplied() : bool
Return values
bool

isRolesEnabled()

public static isRolesEnabled() : bool
Return values
bool

isScrumProject()

public isScrumProject() : bool
Return values
bool

process()

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

setContext()

public setContext(string $context) : static
Parameters
$context : string
Return values
static

setFilterData()

public setFilterData(array<string|int, mixed> $filterData) : void
Parameters
$filterData : array<string|int, mixed>

setGanttMode()

public setGanttMode(bool $isGantt) : static
Parameters
$isGantt : bool
Return values
static

setRolePresetsEnabledForMobile()

public static setRolePresetsEnabledForMobile(bool $enabled) : void
Parameters
$enabled : bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results