PropertyGridProvider extends BaseProvider
Grid provider.
Contains columns, actions, other options and parameters of the main.ui.grid component.
Table of Contents
Methods
- __construct() : mixed
- cleanFields() : array<string|int, mixed>
- Leaves only the fields available for this grid.
- getActionPanel() : array<string|int, mixed>|null
- Returns the description of the group action panel for the property grid.
- getColumns() : array<string|int, mixed>
- Columns.
- getFieldName() : string|null
- Field name.
- getId() : string
- Grid id.
- getPageSizes() : array<string|int, mixed>
- Available page sizes.
- prepareRow() : array<string|int, mixed>
- Prepare row.
- setNavObject() : void
- Pagination.
- setRows() : void
- Set rows. Rows should be in the final (prepared) state.
- toArray() : array<string|int, mixed>
- Convert provider to array.
Methods
__construct()
public
__construct(int $iblockId, LinksBuilder $linksBuilder) : mixed
Parameters
- $iblockId : int
- $linksBuilder : LinksBuilder
cleanFields()
Leaves only the fields available for this grid.
public
cleanFields(array<string|int, mixed> $fields) : array<string|int, mixed>
Parameters
- $fields : array<string|int, mixed>
-
Raw field list for grid description.
Return values
array<string|int, mixed>getActionPanel()
Returns the description of the group action panel for the property grid.
public
getActionPanel() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|nullgetColumns()
Columns.
public
getColumns() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>getFieldName()
Field name.
public
getFieldName(string $fieldId) : string|null
Parameters
- $fieldId : string
-
Field indentifier.
Return values
string|nullgetId()
Grid id.
public
getId() : string
Tags
Return values
stringgetPageSizes()
Available page sizes.
public
getPageSizes() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>prepareRow()
Prepare row.
public
prepareRow(array<string|int, mixed> $rawRow) : array<string|int, mixed>
Parameters
- $rawRow : array<string|int, mixed>
-
Row data from database.
Return values
array<string|int, mixed>setNavObject()
Pagination.
public
setNavObject(PageNavigation $pagination) : void
Parameters
- $pagination : PageNavigation
-
Pagination description.
setRows()
Set rows. Rows should be in the final (prepared) state.
public
setRows(array<string|int, mixed> $rows) : void
Parameters
- $rows : array<string|int, mixed>
-
Grid rows.
Tags
toArray()
Convert provider to array.
public
toArray() : array<string|int, mixed>
Corresponds to the parameters of the main.ui.grid component.