contao-community-alliance/dc-general
Back to top  

This interface describes a panel row collection.

 Methods

Add a new row - optionally at the given position.

addRow(int $index) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\PanelRowInterface
If the given position is zero or any other positive value, the new row will get placed at the given position. If the index is negative or greater than the total amount of rows present, the new row will get placed at the end of the list.

Parameters

$index

int

Target position for the new row.

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\PanelRowInterface

Delete a row from the collection.

deleteRow(int $index) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\PanelRowCollectionInterface

Parameters

$index

int

Remove the row with the given index.

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\PanelRowCollectionInterface

Retrieve the row at the given position.

getRow(int $index) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\PanelRowInterface
If the given index is out of bounds (less than zero or greater than the amount of rows) an exception is fired.

Parameters

$index

int

Position of the row.

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\PanelRowInterface

Retrieve the amount of rows.

getRowCount() : int

Returns

int

Return rows of panel element names.

getRows() : array
This will return the following for example: array(array('filter[prop1]', 'filter[prop2]'), array('search', 'limit')) Note that each panel element decides its name on its own.

Returns

array