Documentation

Common extends Base

in package

• Default

Class constructs grids

Table of Contents

$createButtonEndpoint  : string

Endpoint for create button

$deleteButton  : bool

Do we need to add delete button

$listDescription  : string

List description

$listTitle  : string

List title

$updateButton  : bool

Do we need to add update button

$noItemsTemplateName  : string

Name of the template for the empty records list

$customActions  : string

Custom actions for each record

$customHeaderActions  : string

Custom header actions

$fields  : array<string|int, mixed>

Fields

$listBuilderAdapter  : ListBuilderAdapter

Service logic adapter

$noItemsView  : string

No items block name

$recordTransformer  : array<string|int, mixed>

List item transformation callback

__construct()  : mixed

Constructor

getFields()  : array<string|int, mixed>

Method returns fields

listingForm()  : string

Method compiles listing form

setCustomActions()  : void

Method sets custom actions

setCustomHeaderActions()  : void

Method sets custom header actions

setNoItemsView()  : void

Method sets field $noItemsView

setRecordTransformer()  : void

Setting record transformer

getListBuilderAdapter()  : ListBuilderAdapter

Method returns list builder adapter

getNoItemsContent()  : string

Method returns content for the case when no items were found

listingHeaderCells()  : string

Method compiles header cells

listingItemsCells()  : string

Method compiles listing items cells

transformRecord()  : object

Method transforms database record

getCreatePageEndpoint()  : string

Method returns end point for the create page form

listingHeader()  : string

Method compiles listing header

listingHeaderContent()  : string

Method returns listing header content

listingItems()  : string

Method compiles listing items

listingNoItems()  : string

Method shows "no records" message instead of listing

listingRowActions()  : string

Method compiles row actions

listOfButtons()  : string

Method displays list of possible buttons

needActions()  : bool

Need to display actions in list