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

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

 Methods

The grouping length is used for char or digit grouping.

getGroupingLength() : int
It defines how many chars or digits should be respected when group mode is GROUP_CHAR.

Returns

int

Return the grouping mode.

getGroupingMode() : string

Returns

string

Get the property name.

getProperty() : string

Returns

string

Return the list sorting mode.

getSortingMode() : string
This sorting is applied after grouping and could also be called "in-group sorting".

Returns

string

Retrieve the flag if this information is intended for manual sorting.

isManualSorting() : bool

Returns

bool

Set the grouping length.

setGroupingLength(int $value) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\GroupAndSortingInformationInterface

Parameters

$value

int

The new value.

Returns

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

Set the grouping mode.

setGroupingMode(string $value) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\GroupAndSortingInformationInterface

Parameters

$value

string

The new mode.

Returns

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

Set or reset the flag determining that this information is intended for manual sorting.

setManualSorting(bool $value) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\GroupAndSortingInformationInterface

Parameters

$value

bool

The value for the flag.

Returns

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

Set the name of the property.

setProperty(string $property) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\GroupAndSortingInformationInterface

Parameters

$property

string

The property name.

Returns

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

Set the list sorting mode.

setSortingMode(string $value) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\GroupAndSortingInformationInterface

Parameters

$value

string

The new value.

Returns

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

 Constants

 

Group by characters, the max char count depend on the mode length (which is 1 by default for char grouping).

GROUP_CHAR 
 

Sort by day from datetime property.

GROUP_DAY 
 

Group by digits, the max digit count depend on the mode length (which is infinity by default for digit grouping).

GROUP_DIGIT 
.
 

Sort by month from datetime property.

GROUP_MONTH 
 

Do not group.

GROUP_NONE 
 

Sort by week of the year from datetime property.

GROUP_WEEK 
 

Sort by week day from datetime property.

GROUP_WEEKDAY 
 

Sort by year from datetime property.

GROUP_YEAR 
 

Sort ascending.

SORT_ASC 
 

Sort descending.

SORT_DESC 
 

Shuffle all records instead of sorting.

SORT_RANDOM