Bitrix API

Helper

Table of Contents

Constants

FILTER_PREFIX  = 'KANBAN_V11_'
UI Filter prefix.

Methods

getCategoryId()  : int
Get category id.
getDefaultFilterKey()  : array<string|int, mixed>
Get default key of filter for Kanban.
getFilter()  : array<string|int, mixed>
Get filter for Kanban.
getGrid()  : CGridOptions
Get instance of grid.
getGridId()  : string
Get id of grid.
getPresets()  : array<string|int, mixed>
Get filter presets for Kanban.
setCategoryId()  : void
Set new category id.

Constants

FILTER_PREFIX

UI Filter prefix.

public mixed FILTER_PREFIX = 'KANBAN_V11_'

Methods

getCategoryId()

Get category id.

public static getCategoryId() : int
Return values
int

getDefaultFilterKey()

Get default key of filter for Kanban.

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

Type of entity.

Return values
array<string|int, mixed>

getFilter()

Get filter for Kanban.

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

Type of entity.

Return values
array<string|int, mixed>

getGrid()

Get instance of grid.

public static getGrid(string $type) : CGridOptions
Parameters
$type : string

Type of entity.

Return values
CGridOptions

getGridId()

Get id of grid.

public static getGridId(string $type) : string
Parameters
$type : string

Type of entity.

Return values
string

getPresets()

Get filter presets for Kanban.

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

Type of entity.

Return values
array<string|int, mixed>

setCategoryId()

Set new category id.

public static setCategoryId(int $id) : void
Parameters
$id : int

New category id.


        
On this page

Search results