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

Class ModelOperationButtonCallbackListener.

Handle the button_callbacks.

 Methods

Retrieve the arguments for the callback.

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

Parameters

$event

\ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetOperationButtonEvent

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.

Set the value in the event.

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

Parameters

$event

\ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetOperationButtonEvent

The event being emitted.

$value

string

The value returned by the callback.

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

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

Parameters

$event

\ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetOperationButtonEvent

The Event for which the callback shall be invoked.

Returns

bool

Build reduced href required by legacy callbacks.

buildHref(\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\CommandInterface $command) : string

Parameters

$command

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\CommandInterface

The command for which the href shall get built.

Returns

string

 Properties

 

The name of the operation button to limit execution on.

$operationName : null | string