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

Class AbstractReturningPropertyCallbackListener.

Abstract base class for a callback listener.

 Methods

Set the restrictions for this callback.

setRestrictions(null|string $dataContainerName, null|string $propertyName) : void

Parameters

$dataContainerName

nullstring

The name of the data container to limit execution on.

$propertyName

nullstring

The name of the property to limit execution on.

Check the restrictions against the information within the event and determine if the callback shall be executed.

wantToExecute(\ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\BuildWidgetEvent|\ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\DecodePropertyValueForWidgetEvent|\ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\EncodePropertyValueFromWidgetEvent|\ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetPropertyOptionsEvent $event) : bool
codingStandardsIgnoreStart
codingStandardsIgnoreEnd

Parameters

$event

\ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\BuildWidgetEvent\ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\DecodePropertyValueForWidgetEvent\ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\EncodePropertyValueFromWidgetEvent\ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetPropertyOptionsEvent

The Event for which the callback shall be invoked.

Returns

bool

 Properties

 

The name of the property to limit execution on.

$propertyName : null | string