Interface PanelRowInterface

This interface describes a panel row definition.

DcGeneral\DataDefinition\Definition\View\PanelRowInterface implements IteratorAggregate

Direct known implementers

DcGeneral\DataDefinition\Definition\View\DefaultPanelRow

Namespace: DcGeneral\DataDefinition\Definition\View
Package: DcGeneral\DataDefinition\Definition\View
Located at DataDefinition/Definition/View/PanelRowInterface.php

Methods summary
`public array`	# `getElements( )` Return the names of the contained panel elements. Return the names of the contained panel elements. This will return the following for example: array('filter[prop1]', 'filter[prop2]', 'search', 'limit') Returns `array`
`public DcGeneral\DataDefinition\Definition\View\PanelRowInterface`	# `addElement( DcGeneral\DataDefinition\Definition\View\Panel\ElementInformationInterface $element, integer $index = -1 )` Add an element at the end of the row or - optionally - at the given position. Add an element at the end of the row or - optionally - at the given position. If the given position is zero or any other positive value, the element will get placed at the given position. If the index is negative or greater than the total amount of rows present, the new element will get placed at the end of the list. Parameters `$element` `DcGeneral\DataDefinition\Definition\View\Panel\ElementInformationInterface` $element The element to add. `$index` `integer` $index Target position for the element. Returns `DcGeneral\DataDefinition\Definition\View\PanelRowInterface`
`public DcGeneral\DataDefinition\Definition\View\PanelRowInterface`	# `deleteElement( integer\|string\|DcGeneral\DataDefinition\Definition\View\Panel\ElementInformationInterface $indexOrNameOrInstance )` Remove the element with the given index (if numeric) or name (if string). Remove the element with the given index (if numeric) or name (if string). Parameters `$indexOrNameOrInstance` `integer\|string\|DcGeneral\DataDefinition\Definition\View\Panel\ElementInformationInterface` $indexOrNameOrInstance Element name or numeric index in the row. Returns `DcGeneral\DataDefinition\Definition\View\PanelRowInterface`
`public boolean`	# `hasElement( DcGeneral\DataDefinition\Definition\View\Panel\ElementInformationInterface\|string $instanceOrName )` Check if the given element instance or an element with the given name is in the row. Check if the given element instance or an element with the given name is in the row. Throws an exception when an invalid value has been passed. Parameters `$instanceOrName` `DcGeneral\DataDefinition\Definition\View\Panel\ElementInformationInterface\|string` $instanceOrName The element instance or the name of an element to check. Returns `boolean`
`public integer`	# `getCount( )` Retrieve the amount of elements. Retrieve the amount of elements. Returns `integer`
`public DcGeneral\DataDefinition\Definition\View\Panel\ElementInformationInterface`	# `getElement( integer\|string $indexOrName )` Retrieve the element with the given index (if numeric) or name (if string). Retrieve the element with the given index (if numeric) or name (if string). Parameters `$indexOrName` `integer\|string` $indexOrName Element name or numeric index in the row. Returns `DcGeneral\DataDefinition\Definition\View\Panel\ElementInformationInterface`
`public DcGeneral\DataDefinition\Definition\View\Panel\ElementInformationInterface[]`	# `getIterator( )` Retrieve an external iterator. Retrieve an external iterator. Returns `DcGeneral\DataDefinition\Definition\View\Panel\ElementInformationInterface[]` Link http://php.net/manual/en/iteratoraggregate.getiterator.php Implementation of `IteratorAggregate::getIterator()`

Namespaces

Classes

Interfaces

Interface PanelRowInterface

Direct known implementers

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Link

Implementation of