Interface PanelRowCollectionInterface
This interface describes a panel row collection.
-
DcGeneral\DataDefinition\Definition\View\PanelRowCollectionInterface
implements
IteratorAggregate
Methods summary
public
array
|
#
getRows( )
Return rows of panel element names.
Return rows of panel element names.
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
|
public
DcGeneral\DataDefinition\Definition\View\PanelRowInterface
|
#
addRow( integer $index = -1 )
Add a new row - optionally at the given position.
Add a new row - optionally at the given position.
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
integer
$index Target position for the new row. Returns
|
public
DcGeneral\DataDefinition\Definition\View\PanelRowCollectionInterface
|
#
deleteRow( integer $index )
Delete a row from the collection.
Delete a row from the collection.
Parameters
- $index
integer
$index Remove the row with the given index. Returns
|
public
integer
|
#
getRowCount( )
Retrieve the amount of rows.
Retrieve the amount of rows.
Returns
integer
|
public
DcGeneral\DataDefinition\Definition\View\PanelRowInterface
|
#
getRow( integer $index )
Retrieve the row at the given position.
Retrieve the row at the given position.
If the given index is out of bounds (less than zero or greater than the
amount of rows) an exception is fired.
Parameters
- $index
integer
$index Position of the row. Returns
|
public
DcGeneral\DataDefinition\Definition\View\PanelRowInterface[]
|
#
getIterator( )
Retrieve an external iterator.
Retrieve an external iterator.
Returns
Link
Implementation of
IteratorAggregate::getIterator()
|