Bitrix API

ExternalSourceGrid extends Grid

FinalYes

Grid object.

Table of Contents

Methods

__construct()  : mixed
getColumns()  : Columns
Grid columns.
getFilter()  : Filter|null
Grid filter.
getId()  : string
Grid id.
getOptions()  : Options
User options.
getOrmFilter()  : array<string|int, mixed>|null
Filter for ORM and `getList` method.
getOrmOrder()  : array<string|int, mixed>
Order for ORM and `getList` method.
getOrmParams()  : array<string|int, mixed>
Params for ORM and `getList` method.
getOrmSelect()  : array<string|int, mixed>
Select for ORM and `getList` method.
getPagination()  : PageNavigation|null
Grid pagination.
getPanel()  : Panel|null
Grid footer actions panel.
getRows()  : Rows
Grid rows.
getSettings()  : ExternalSourceSettings
Configuration settings.
getVisibleColumnsIds()  : array<string|int, string>
Ids of visible columns.
initPagination()  : void
prepareColumns()  : array<string|int, Column>
Gets columns prepared for output.
prepareRows()  : array<string|int, array<string|int, mixed>>
Gets rows prepared for output.
processRequest()  : void
Processing all actions of the grid.
setRawRows()  : void
Set raw rows (only data).

Methods

getFilter()

Grid filter.

public final getFilter() : Filter|null
Return values
Filter|null

getId()

Grid id.

public final getId() : string
Return values
string

getOrmFilter()

Filter for ORM and `getList` method.

public getOrmFilter() : array<string|int, mixed>|null
Tags
see
DataManager

method getList

Return values
array<string|int, mixed>|null —

is filter not setted, returns null

getOrmOrder()

Order for ORM and `getList` method.

public getOrmOrder() : array<string|int, mixed>
Tags
see
DataManager

method getList

Return values
array<string|int, mixed>

getOrmParams()

Params for ORM and `getList` method.

public getOrmParams() : array<string|int, mixed>
Tags
see
DataManager

method getList

Return values
array<string|int, mixed>

getOrmSelect()

Select for ORM and `getList` method.

public getOrmSelect() : array<string|int, mixed>
Tags
see
DataManager

method getList

Return values
array<string|int, mixed>

getPanel()

Grid footer actions panel.

public final getPanel() : Panel|null
Return values
Panel|null

getRows()

Grid rows.

public final getRows() : Rows
Return values
Rows

getVisibleColumnsIds()

Ids of visible columns.

public getVisibleColumnsIds() : array<string|int, string>

If the user's display options are filled in, they are used. Otherwise, used default columns.

Return values
array<string|int, string> —

columns ids

initPagination()

public initPagination(int $totalRowsCount[, string|null $navId = null ]) : void

use createPagination method.

Init pagination.

If you use pagination, you need to call this method before getting the ORM parameters (getOrmParams method).

Parameters
$totalRowsCount : int
$navId : string|null = null

prepareColumns()

Gets columns prepared for output.

public prepareColumns() : array<string|int, Column>
Return values
array<string|int, Column>

prepareRows()

Gets rows prepared for output.

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

processRequest()

Processing all actions of the grid.

public processRequest([HttpRequest|null $request = null ]) : void

Handles actions of the grid, panel, and rows.

Parameters
$request : HttpRequest|null = null

setRawRows()

Set raw rows (only data).

public setRawRows(iterable<string|int, mixed> $rawValue) : void
Parameters
$rawValue : iterable<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results