Bitrix API

KanbanDataProvider extends ClientDataProvider

Table of Contents

Methods

__construct()  : mixed
addFieldsToSelect()  : void
Add fields to be selected for contact/company
appendResult()  : void
Add values of client fields to $items result in kanban compatible format
getDisplayFields()  : array<string|int, Field>
Get list of visible client fields
getHeadersSections()  : array<string|int, mixed>
getPopupFields()  : array<string|int, mixed>
getPriorityEntityTypeId()  : int
prepareExportHeaders()  : void
Add extra multifields columns for export
prepareFieldValue()  : string
prepareFilter()  : void
Prepare ui.filter params for client user fields
prepareSelect()  : void
Remove client fields from $select, except CONTACT_ID / COMPANY_ID
removeUnavailableUserFields()  : bool
Remove deleted user fields from visible grid columns
setExportMode()  : self
setGridId()  : self

Methods

__construct()

public __construct(int $clientEntityTypeId) : mixed
Parameters
$clientEntityTypeId : int

addFieldsToSelect()

Add fields to be selected for contact/company

public addFieldsToSelect(array<string|int, mixed> $fields) : void
Parameters
$fields : array<string|int, mixed>

appendResult()

Add values of client fields to $items result in kanban compatible format

public appendResult(array<string|int, mixed> &$items, array<string|int, mixed> $fieldsToAdd) : void
Parameters
$items : array<string|int, mixed>
$fieldsToAdd : array<string|int, mixed>

getDisplayFields()

Get list of visible client fields

public getDisplayFields() : array<string|int, Field>
Return values
array<string|int, Field>

getHeadersSections()

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

getPopupFields()

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

getPriorityEntityTypeId()

public static getPriorityEntityTypeId() : int
Return values
int

prepareExportHeaders()

Add extra multifields columns for export

public prepareExportHeaders(array<string|int, mixed> &$headers) : void
Parameters
$headers : array<string|int, mixed>

prepareFieldValue()

public prepareFieldValue(string $fieldId, string $value) : string
Parameters
$fieldId : string
$value : string
Return values
string

prepareFilter()

Prepare ui.filter params for client user fields

public prepareFilter(array<string|int, mixed> &$filterFields, array<string|int, mixed> $arFilter) : void
Parameters
$filterFields : array<string|int, mixed>
$arFilter : array<string|int, mixed>

prepareSelect()

Remove client fields from $select, except CONTACT_ID / COMPANY_ID

public prepareSelect(array<string|int, mixed> &$select) : void
Parameters
$select : array<string|int, mixed>

removeUnavailableUserFields()

Remove deleted user fields from visible grid columns

public removeUnavailableUserFields(mixed &$fields) : bool
Parameters
$fields : mixed
Return values
bool

setExportMode()

public setExportMode(bool $isExportMode) : self
Parameters
$isExportMode : bool
Return values
self

setGridId()

public setGridId(string $gridId) : self
Parameters
$gridId : string
Return values
self 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results