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

Class EncodePropertyValueFromWidgetEvent.

This event is issued when a property value has to be converted from data understood by the widget into the native data (presented by the data provider).

 Methods

Create a new model aware event.

__construct(\ContaoCommunityAlliance\DcGeneral\EnvironmentInterface $environment, \ContaoCommunityAlliance\DcGeneral\Data\ModelInterface $model, \ContaoCommunityAlliance\DcGeneral\Data\PropertyValueBagInterface $propertyValues) 

Parameters

$environment

\ContaoCommunityAlliance\DcGeneral\EnvironmentInterface

The environment.

$model

\ContaoCommunityAlliance\DcGeneral\Data\ModelInterface

The model attached to the event.

$propertyValues

\ContaoCommunityAlliance\DcGeneral\Data\PropertyValueBagInterface

The property value bag the property value originates from.

Retrieve the name of the property.

getProperty() : string

Returns

string

Retrieve the property value bag where values are stored.

getPropertyValueBag() : \ContaoCommunityAlliance\DcGeneral\Data\PropertyValueBagInterface

Returns

\ContaoCommunityAlliance\DcGeneral\Data\PropertyValueBagInterface

Retrieve the value from the event.

getValue() : mixed

Returns

mixed

Set the name of the property.

setProperty(string $property) : \ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\EncodePropertyValueFromWidgetEvent

Parameters

$property

string

The name of the property.

Returns

\ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\EncodePropertyValueFromWidgetEvent

Set the value in the event.

setValue(mixed $value) : \ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\EncodePropertyValueFromWidgetEvent

Parameters

$value

mixed

The new value.

Returns

\ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\EncodePropertyValueFromWidgetEvent

 Properties

 

The name of the property for which the data shall be decoded.

$property : string
 

The property value bag where values are to be retrieved from.

$propertyValues : \ContaoCommunityAlliance\DcGeneral\Data\PropertyValueBagInterface
 

The value of the data.

$value : mixed

 Constants

 

NAME

NAME