Class GetOperationButtonEvent

Class GetOperationButtonEvent.

This event gets emitted when an operation button is rendered.

Symfony\Component\EventDispatcher\Event

DcGeneral\Event\AbstractEnvironmentAwareEvent implements DcGeneral\EnvironmentAwareInterface

DcGeneral\Contao\View\Contao2BackendView\Event\BaseButtonEvent

DcGeneral\Contao\View\Contao2BackendView\Event\GetOperationButtonEvent

Namespace: DcGeneral\Contao\View\Contao2BackendView\Event
Package: DcGeneral\Contao\View\Contao2BackendView\Event
Located at Contao/View/Contao2BackendView/Event/GetOperationButtonEvent.php

Methods summary
`public mixed`	# `setCommand( DcGeneral\DataDefinition\Definition\View\CommandInterface $objCommand )` Set the attached command. Set the attached command. Parameters `$objCommand` `DcGeneral\DataDefinition\Definition\View\CommandInterface` $objCommand The command. Returns `mixed` $this
`public DcGeneral\DataDefinition\Definition\View\CommandInterface`	# `getCommand( )` Retrieve the attached command. Retrieve the attached command. Returns `DcGeneral\DataDefinition\Definition\View\CommandInterface`
`public mixed`	# `setChildRecordIds( array $childRecordIds )` Set the ids of the child records of the current model. Set the ids of the child records of the current model. Parameters `$childRecordIds` `array` $childRecordIds The list of ids. Returns `mixed` $this
`public array`	# `getChildRecordIds( )` Retrieve the ids of the child records of the current model. Retrieve the ids of the child records of the current model. Returns `array`
`public mixed`	# `setCircularReference( boolean $circularReference )` Set determinator if there exists a circular reference. Set determinator if there exists a circular reference. This flag determines if there exists a circular reference between the item currently in the clipboard and the current model. A circular reference is of relevance when performing a cut and paste operation for example. Parameters `$circularReference` `boolean` $circularReference The flag. Returns `mixed` $this
`public boolean`	# `getCircularReference( )` Get determinator if there exists a circular reference. Get determinator if there exists a circular reference. This flag determines if there exists a circular reference between the item currently in the clipboard and the current model. A circular reference is of relevance when performing a cut and paste operation for example. Returns `boolean`
`public mixed`	# `setNext( DcGeneral\Data\ModelInterface $next )` Set the next model in the list, succeeding the current model. Set the next model in the list, succeeding the current model. Parameters `$next` `DcGeneral\Data\ModelInterface` $next The successor. Returns `mixed` $this
`public DcGeneral\Data\ModelInterface`	# `getNext( )` Get the next model in the list, succeeding the current model. Get the next model in the list, succeeding the current model. Returns `DcGeneral\Data\ModelInterface`
`public mixed`	# `setPrevious( DcGeneral\Data\ModelInterface $previous )` Set the previous model in the list, preceding the current model. Set the previous model in the list, preceding the current model. Parameters `$previous` `DcGeneral\Data\ModelInterface` $previous The id of the predecessor. Returns `mixed` $this
`public DcGeneral\Data\ModelInterface`	# `getPrevious( )` Get the previous model in the list, preceding the current model. Get the previous model in the list, preceding the current model. Returns `DcGeneral\Data\ModelInterface`
`public mixed`	# `setHref( string $href )` Set the href for the button. Set the href for the button. Parameters `$href` `string` $href The href. Returns `mixed` $this
`public string`	# `getHref( )` Retrieve the href for the button. Retrieve the href for the button. Returns `string`
`public mixed`	# `setObjModel( DcGeneral\Data\ModelInterface $model )` Set the model currently in scope. Set the model currently in scope. Parameters `$model` `DcGeneral\Data\ModelInterface` $model The model. Returns `mixed` $this
`public DcGeneral\Data\ModelInterface`	# `getModel( )` Get the model currently in scope. Get the model currently in scope. Returns `DcGeneral\Data\ModelInterface`

Methods inherited from DcGeneral\Contao\View\Contao2BackendView\Event\BaseButtonEvent
`getAttributes(), getHtml(), getKey(), getLabel(), getTitle(), setAttributes(), setHtml(), setKey(), setLabel(), setTitle()`

Methods inherited from DcGeneral\Event\AbstractEnvironmentAwareEvent
`__construct(), getEnvironment()`

Constants inherited from DcGeneral\Contao\View\Contao2BackendView\Event\BaseButtonEvent
`NAME`

Properties summary
`protected DcGeneral\DataDefinition\Definition\View\CommandInterface`	`$command`	# The command for which the button is being rendered. The command for which the button is being rendered.
`protected DcGeneral\Data\ModelInterface`	`$model`	# The model to which the command shall be applied to. The model to which the command shall be applied to.
`protected array`	`$childRecordIds`	# The ids of any child records of the model. The ids of any child records of the model.
`protected boolean`	`$circularReference`	# Determinator if there is a circular reference from an item in the clipboard to the current model. Determinator if there is a circular reference from an item in the clipboard to the current model.
`protected ModelInterface`	`$next`	# The next model succeeding the current model. The next model succeeding the current model.
`protected ModelInterface`	`$previous`	# The model preceeding the current model. The model preceeding the current model.
`protected string`	`$href`	# The href for the command. The href for the command.

Properties inherited from DcGeneral\Contao\View\Contao2BackendView\Event\BaseButtonEvent
`$attributes, $html, $key, $label, $title`

Properties inherited from DcGeneral\Event\AbstractEnvironmentAwareEvent
`$environment`

Namespaces

Classes

Class GetOperationButtonEvent

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns