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

Class ContainerGlobalButtonCallbackListener.

Handler for the global buttons.

 Methods

Retrieve the arguments for the callback.

getArgs(\ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetGlobalButtonEvent $event) : array

Parameters

$event

\ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetGlobalButtonEvent

The event being emitted.

Returns

array

Set the restrictions for this callback.

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

Parameters

$dataContainerName

nullstring

The name of the data container to limit execution on.

$operationName

nullstring

The name of the operation button to limit execution on.

Update the event with the information returned by the callback.

update(\ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetGlobalButtonEvent $event, string $value) : void

Parameters

$event

\ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetGlobalButtonEvent

The event being emitted.

$value

string

The HTML representation of the button.

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

wantToExecute(\ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetGlobalButtonEvent $event) : bool

Parameters

$event

\ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetGlobalButtonEvent

The Event for which the callback shall be invoked.

Returns

bool

 Properties

 

The name of the operation button to limit execution on.

$operationName : null | string