Class GetGroupHeaderEvent

Class GetGroupHeaderEvent.

Render the group header in the listing view.

Symfony\Component\EventDispatcher\Event

DcGeneral\Event\AbstractEnvironmentAwareEvent implements DcGeneral\EnvironmentAwareInterface

DcGeneral\Event\AbstractModelAwareEvent implements DcGeneral\ModelAwareInterface

DcGeneral\Contao\View\Contao2BackendView\Event\GetGroupHeaderEvent

Namespace: DcGeneral\Contao\View\Contao2BackendView\Event
Package: DcGeneral\Contao\View\Contao2BackendView\Event
Located at Contao/View/Contao2BackendView/Event/GetGroupHeaderEvent.php

Methods summary
`public`	# `__construct( DcGeneral\EnvironmentInterface $environment, DcGeneral\Data\ModelInterface $model, string $propertyName, mixed $propertyValue, string $groupingMode )` Create a new group header event. Create a new group header event. Parameters `$environment` `DcGeneral\EnvironmentInterface` $environment The environment. `$model` `DcGeneral\Data\ModelInterface` $model The model being used as group header. `$propertyName` `string` $propertyName The name of the property being rendered into the group header. `$propertyValue` `mixed` $propertyValue The value of the property being rendered into the group header. `$groupingMode` `string` $groupingMode The grouping mode currently active. Overrides `DcGeneral\Event\AbstractModelAwareEvent::__construct()`
`public string`	# `getGroupField( )` Retrieve the property name to be rendered. Retrieve the property name to be rendered. Returns `string`
`public string`	# `getGroupingMode( )` Get the grouping mode in use as defined in the listing config. Get the grouping mode in use as defined in the listing config. Returns `string` See `DcGeneral\DataDefinition\Definition\View\ListingConfigInterface`
`public DcGeneral\Contao\View\Contao2BackendView\Event\GetGroupHeaderEvent`	# `setValue( string $value )` Set the value to use in the group header. Set the value to use in the group header. Parameters `$value` `string` $value The value. Returns `DcGeneral\Contao\View\Contao2BackendView\Event\GetGroupHeaderEvent`
`public string`	# `getValue( )` Retrieve the value to use in the group header. Retrieve the value to use in the group header. Returns `string`

Methods inherited from DcGeneral\Event\AbstractModelAwareEvent
`getModel()`

Methods inherited from DcGeneral\Event\AbstractEnvironmentAwareEvent
`getEnvironment()`

Constants summary
`string`	`NAME`	`'dc-general.view.contao2backend.get-group-header'`	#

Properties summary
`protected string`	`$groupField`	# The current property to be rendered for the group header. The current property to be rendered for the group header.
`protected string`	`$groupingMode`	# The grouping mode in use as defined in the listing config. The grouping mode in use as defined in the listing config. See `DcGeneral\DataDefinition\Definition\View\ListingConfigInterface`
`protected string`	`$value`	# The value to be rendered. The value to be rendered.

Properties inherited from DcGeneral\Event\AbstractModelAwareEvent
`$model`

Properties inherited from DcGeneral\Event\AbstractEnvironmentAwareEvent
`$environment`

Namespaces

Classes

Class GetGroupHeaderEvent

Parameters

Overrides

Returns

Returns

See

Parameters

Returns

Returns

See