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

Class ModelToLabelEvent.

This event gets emitted when a model shall be translated to an html representation.

 Methods

Retrieve the arguments to use when generating the final string representation using the format string.

getArgs() : array

Returns

array

Retrieve the label information instance.

getFormatter() : \ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\ModelFormatterConfigInterface

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\ModelFormatterConfigInterface

Get the label for the model.

getLabel() : string
This is a format string to use in vsprintf().

Returns

string

Set the arguments to use when generating the final string representation using the format string.

setArgs(array $args) : \ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\ModelToLabelEvent

Parameters

$args

array

The arguments.

Returns

\ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\ModelToLabelEvent

Set the label information instance.

setFormatter(\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\ModelFormatterConfigInterface $listLabel) : \ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\ModelToLabelEvent

Parameters

$listLabel

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\ModelFormatterConfigInterface

The label information instance.

Returns

\ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\ModelToLabelEvent

Set the label for the model.

setLabel(string $label) : \ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\ModelToLabelEvent
This is a format string to use in vsprintf().

Parameters

$label

string

The label string.

Returns

\ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\ModelToLabelEvent

 Properties

 

The arguments to use when building the label from the format string.

$args : array
 

The label for the model.

$label : string
This is a format string to use in vsprintf().
 

The label information instance.

$listLabel : \ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\ModelFormatterConfigInterface

 Constants

 

NAME

NAME