Класс BaseProvider

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

Открытые члены
	getId ()
	getColumns ()
	setRows (array $rows)
	setNavObject (PageNavigation $pagination)
	getPageSizes ()
	prepareRow (array $rawRow)
	cleanFields (array $fields)
	toArray ()

Защищенные члены
	getTemplateRow ()
	getRows ()
	getNavObject ()
	getDefaultPageSize ()
	getDefaultSort ()
	getActionPanel ()
	getAjaxId ()
	getRowIdColumn ()
	isEditable (array $row)
	getRowColumns (array $row)
	getRowActions (array $row, bool $isEditable)

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

Grid provider.

Contains columns, actions, other options and parameters of the main.ui.grid component.

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

Методы

cleanFields()

cleanFields

(

array

$fields

)

Leaves only the fields available for this grid.

Аргументы

array

$fields

Raw field list for grid description.

Возвращает

array

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

getActionPanel()

getActionPanel ( )

protected

Action panel.

Возвращает

array|null

Переопределяется в PropertyGridProvider, DirectoryItemsProvider и ListValuesProvider.

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

getAjaxId()

getAjaxId ( )

protected

AJAX id.

Возвращает

string

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

getColumns()

getColumns ( )

abstract

Columns.

Возвращает

array

Переопределяется в PropertyGridProvider, DirectoryItemsProvider и ListValuesProvider.

getDefaultPageSize()

getDefaultPageSize ( )

protected

Default page size.

Возвращает

int

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

getDefaultSort()

getDefaultSort ( )

protected

Default sort.

Возвращает

array|null

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

getId()

getId ( )

abstract

Grid id.

Возвращает

string

Переопределяется в PropertyGridProvider, DirectoryItemsProvider и ListValuesProvider.

getNavObject()

getNavObject ( )

protected

Pagination.

Возвращает

PageNavigation|null

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

getPageSizes()

getPageSizes

(

)

Available page sizes.

См. также

\Bitrix\Iblock\Integration\UI\Grid\General\PageSizes contains frequent values

Возвращает

array

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

getRowActions()

getRowActions ( array $row, bool $isEditable )

protected

Row actions.

Аргументы

array	$row
bool	$isEditable

Возвращает

array

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

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

getRowColumns()

getRowColumns ( array $row )

protected

Row columns.

Values that are displayed when viewing.

Аргументы

array

$row

Возвращает

array

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

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

getRowIdColumn()

getRowIdColumn ( )

protected

Column name with identifier row.

Возвращает

string

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

getRows()

getRows ( )

protected

Rows.

Возвращает

array

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

getTemplateRow()

getTemplateRow ( )

protected

Template row.

Using for creating new rows.

Возвращает

array|null

Переопределяется в DirectoryItemsProvider и ListValuesProvider.

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

isEditable()

isEditable ( array $row )

protected

Row is editable.

Аргументы

array

$row

Возвращает

bool

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

prepareRow()

prepareRow

(

array

$rawRow

)

Prepare row.

Аргументы

array

$rawRow

Raw data for grid row.

Возвращает

array

Переопределяется в PropertyGridProvider и DirectoryItemsProvider.

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

setNavObject()

setNavObject

(

PageNavigation

$pagination

)

Pagination.

Аргументы

PageNavigation

$pagination

Pagination description.

Возвращает

void

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

setRows()

setRows

(

array

$rows

)

Set rows. Rows should be in the final (prepared) state.

См. также

::prepareRow

Аргументы

array

$rows

Grid rows.

Возвращает

void

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

toArray()

toArray

(

)

Convert provider to array.

Corresponds to the parameters of the main.ui.grid component.

Возвращает

array

Переопределяется в DirectoryItemsProvider и ListValuesProvider.

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

---

Объявления и описания членов класса находятся в файле:

• C:/bitrix/modules/iblock/lib/Integration/UI/Grid/General/BaseProvider.php