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

Class GetGroupHeaderEvent.

Render the group header in the listing view.

 Methods

Create a new group header event.

__construct(\ContaoCommunityAlliance\DcGeneral\EnvironmentInterface $environment, \ContaoCommunityAlliance\DcGeneral\Data\ModelInterface $model, string $propertyName, mixed $propertyValue, string $groupingMode, int $groupingLength) 

Parameters

$environment

\ContaoCommunityAlliance\DcGeneral\EnvironmentInterface

The environment.

$model

\ContaoCommunityAlliance\DcGeneral\Data\ModelInterface

The model being used as group header.

$propertyName

string

The name of the property being rendered into the group header.

$propertyValue

mixed

The value of the property being rendered into the group header.

$groupingMode

string

The grouping mode currently active.

$groupingLength

int

The grouping length currently active.

Retrieve the property name to be rendered.

getGroupField() : string

Returns

string

Get the grouping length in use as defined in the listing config.

getGroupingLength() : int
see

Returns

int

Get the grouping mode in use as defined in the listing config.

getGroupingMode() : string
see

Returns

string

Retrieve the value to use in the group header.

getValue() : string

Returns

string

Set the value to use in the group header.

setValue(string $value) : \ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetGroupHeaderEvent

Parameters

$value

string

The value.

Returns

\ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetGroupHeaderEvent

 Properties

 

The current property to be rendered for the group header.

$groupField : string
 

The grouping length in use as defined in the listing config.

$groupingLength : int
see
 

The grouping mode in use as defined in the listing config.

$groupingMode : string
see
 

The value to be rendered.

$value : string

 Constants

 

NAME

NAME