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

This interface defines a grouping and sorting information for the view.

 Methods

Add a new information - optionally at the given position.

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

Parameters

$index

int

Target position for the new information.

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\GroupAndSortingInformationInterface

Delete an information from the collection.

delete(int $index) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\GroupAndSortingDefinitionInterface

Parameters

$index

int

Remove the information with the given index.

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\GroupAndSortingDefinitionInterface

Retrieve the information at the given position.

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

Parameters

$index

int

Position of the information.

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\GroupAndSortingInformationInterface

Retrieve the amount of information.

getCount() : int

Returns

int

Retrieve the name of the definition.

getName() : string

Returns

string

Set the name of the definition.

setName(string $name) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\GroupAndSortingDefinitionInterface

Parameters

$name

string

The name.

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\GroupAndSortingDefinitionInterface