Класс Grid

Граф наследования:Grid:

Открытые члены
	__construct (Settings $settings)
	getId ()
	getSettings ()
	getOptions ()
	getColumns ()
	getRows ()
	getPanel ()
	getFilter ()
	getPagination ()
	initPagination (int $totalRowsCount, ?string $navId=null)
	setRawRows (iterable $rawValue)
	prepareRows ()
	prepareColumns ()
	processRequest (?HttpRequest $request=null)
	getOrmParams ()
	getOrmSelect ()
	getOrmFilter ()
	getOrmOrder ()
	getVisibleColumnsIds ()

Защищенные члены
	getRawRows ()
	getActions ()
	getActionById (string $id)
	processGridActionsRequest (GridRequest $request)
	getPageSizes ()
	getDefaultSorting ()
	createColumns ()
	createRows ()
	createPanel ()
	createFilter ()

Защищенные данные
GridRequestFactory	$gridRequestFactory
GridResponseFactory	$gridResponseFactory

Подробное описание

Grid object.

Contains all the necessary information to work with the grid: columns, settings, actions. There is no work with the filter here, there is a separate Filter class for this.

См. также

\Bitrix\Main\Filter\Filter

Usage example:

//
// create instances for grid and filter
//
$settings = new \Bitrix\Main\Grid\Settings([
    'ID' => 'test-grid',
]);
$grid = new Grid($settings);
 
//
// init pagination (if using)
//
$totalCount = Entity::getCount(
    $grid->getOrmFilter() ?? []
);
$grid->initPagination($totalCount);
 
//
// processing grid actions from current request
//
$grid->processRequest();
 
//
// fill grid rows with raw data
// It is important to do this AFTER processing the request, because the handlers could change the data.
//
$grid->setRawRows(
    Entity::getList($grid->getOrmParams())
);
 
//
// render component
//
$APPLICATION->IncludeComponent(
    'bitrix:main.ui.grid',
    '',
    \Bitrix\Main\Grid\Component\ComponentParams::get($grid, [
        // additional params
    ])
);

См. определение в файле grid.php строка 73

Конструктор(ы)

__construct()

__construct

(

Settings

$settings

)

Аргументы

Settings

$settings

required for all childs!

См. определение в файле grid.php строка 96

Методы

createColumns()

createColumns ( )

abstractprotected

Create columns collection.

Возвращает

Columns

Переопределяется в ProductGrid.

createFilter()

createFilter ( )

protected

Create filter.

Возвращает

Filter|null

Переопределяется в ProductGrid.

См. определение в файле grid.php строка 602

createPanel()

createPanel ( )

protected

Create panel.

Возвращает

Panel|null

Переопределяется в ProductGrid.

См. определение в файле grid.php строка 592

createRows()

createRows ( )

protected

Create rows collection.

Возвращает

Rows

Переопределяется в ProductGrid.

См. определение в файле grid.php строка 576

getActionById()

getActionById ( string $id )

finalprotected

Grid action.

Аргументы

string

$id

Возвращает

Action|null

См. определение в файле grid.php строка 446

getActions()

getActions ( )

protected

Grid actions.

These are the actions of the grid itself, and not its component parts (rows, panel, ...).

Возвращает

Action[]

См. определение в файле grid.php строка 426

getColumns()

getColumns ( )

final

Grid columns.

Возвращает

Columns

См. определение в файле grid.php строка 142

getDefaultSorting()

getDefaultSorting ( )

protected

Default sorting.

Возвращает

array

См. определение в файле grid.php строка 557

getFilter()

getFilter ( )

final

Grid filter.

Возвращает

Filter|null

См. определение в файле grid.php строка 178

getId()

getId ( )

final

Grid id.

Возвращает

string

См. определение в файле grid.php строка 110

getOptions()

getOptions ( )

final

User options.

Возвращает

Options

См. определение в файле grid.php строка 130

getOrmFilter()

getOrmFilter

(

)

Filter for ORM and getList method.

См. также

\Bitrix\Main\ORM\Data\DataManager method getList

Возвращает

array|null is filter not setted, returns null

Переопределяется в ProductGrid.

См. определение в файле grid.php строка 389

getOrmOrder()

getOrmOrder

(

)

Order for ORM and getList method.

См. также

\Bitrix\Main\ORM\Data\DataManager method getList

Возвращает

array

См. определение в файле grid.php строка 407

getOrmParams()

getOrmParams

(

)

Params for ORM and getList method.

См. также

\Bitrix\Main\ORM\Data\DataManager method getList

Возвращает

array

См. определение в файле grid.php строка 345

getOrmSelect()

getOrmSelect

(

)

Select for ORM and getList method.

См. также

\Bitrix\Main\ORM\Data\DataManager method getList

Возвращает

array

См. определение в файле grid.php строка 375

getPageSizes()

getPageSizes ( )

protected

Available page sizes.

Возвращает

int[]

См. определение в файле grid.php строка 541

getPagination()

getPagination ( )

final

Grid pagination.

Возвращает

PageNavigation|null

См. определение в файле grid.php строка 190

getPanel()

getPanel ( )

final

Grid footer actions panel.

Возвращает

Panel|null

См. определение в файле grid.php строка 166

getRawRows()

getRawRows ( )

finalprotected

Get raw rows.

Возвращает

array

См. определение в файле grid.php строка 251

getRows()

getRows ( )

final

Grid rows.

Возвращает

Rows

См. определение в файле grid.php строка 154

getSettings()

getSettings ( )

final

Configuration settings.

Возвращает

Settings

См. определение в файле grid.php строка 120

getVisibleColumnsIds()

getVisibleColumnsIds

(

)

Ids of visible columns.

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

Возвращает

string[] columns ids

См. определение в файле grid.php строка 517

initPagination()

initPagination	(	int	$totalRowsCount,
		?string	$navId = null )

Init pagination.

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

Ideally, call it immediately after creating the grid instance.

Аргументы

int	$totalRowsCount
string | null	$navId

Возвращает

void

См. определение в файле grid.php строка 208

prepareColumns()

prepareColumns

(

)

Gets columns prepared for output.

Возвращает

Column[]

Переопределяется в ProductGrid.

См. определение в файле grid.php строка 271

prepareRows()

prepareRows

(

)

Gets rows prepared for output.

Возвращает

array[]

См. определение в файле grid.php строка 261

processGridActionsRequest()

processGridActionsRequest ( GridRequest $request )

protected

Processing only grid actions.

См. также

::processRequest for processing all actions (grid, rows and panel).

Аргументы

GridRequest

$request

Возвращает

GridResponse|null

См. определение в файле grid.php строка 475

processRequest()

processRequest

(

?HttpRequest

$request = null

)

Processing all actions of the grid.

Handles actions of the grid, panel, and rows.

Аргументы

HttpRequest | null

$request

Возвращает

void

См. определение в файле grid.php строка 292

setRawRows()

setRawRows

(

iterable

$rawValue

)

Set raw rows (only data after ORM calling).

Аргументы

iterable

$rawValue

Возвращает

void

См. определение в файле grid.php строка 236

Данные класса

$gridRequestFactory

GridRequestFactory $gridRequestFactory

protected

См. определение в файле grid.php строка 90

$gridResponseFactory

GridResponseFactory $gridResponseFactory

protected

См. определение в файле grid.php строка 91