Class GetOperationButtonEvent.
This event gets emitted when an operation button is rendered.
Methods
Retrieve the ids of the child records of the current model.
getChildRecordIds() : array
Get determinator if there exists a circular reference.
getCircularReference() : boolean
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.
| deprecated |
Use isCircularReference(). |
| SuppressWarnings |
(PHPMD.BooleanGetMethodName) |
Returns
boolean
Retrieve the href for the button.
getHref() : string
Get determinator if there exists a circular reference.
isCircularReference() : boolean
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
Determine if the command is disabled.
isDisabled() : boolean
Set the ids of the child records of the current model.
setChildRecordIds(array $childRecordIds) : \ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetOperationButtonEvent
| fluent |
This method is part of a fluent interface and will return the same instance |
Parameters
$childRecordIds
arrayThe list of ids.
Returns
\ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetOperationButtonEvent
Set determinator if there exists a circular reference.
setCircularReference(boolean $circularReference) : \ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetOperationButtonEvent
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.
| fluent |
This method is part of a fluent interface and will return the same instance |
Parameters
$circularReference
booleanThe flag.
Returns
\ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetOperationButtonEvent
Set the attached command.
setCommand(\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\CommandInterface $objCommand) : \ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetOperationButtonEvent
| fluent |
This method is part of a fluent interface and will return the same instance |
Parameters
Returns
\ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetOperationButtonEvent
Set the button enabled or disabled (true means disabled).
setDisabled(boolean $disabled) : \ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetOperationButtonEvent
| fluent |
This method is part of a fluent interface and will return the same instance |
Parameters
$disabled
booleanThe flag.
Returns
\ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetOperationButtonEvent
Set the href for the button.
setHref(string $href) : \ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetOperationButtonEvent
| fluent |
This method is part of a fluent interface and will return the same instance |
Parameters
Returns
\ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetOperationButtonEvent
Set the next model in the list, succeeding the current model.
setNext(\ContaoCommunityAlliance\DcGeneral\Data\ModelInterface $next) : \ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetOperationButtonEvent
| fluent |
This method is part of a fluent interface and will return the same instance |
Parameters
Returns
\ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetOperationButtonEvent
Set the model currently in scope.
setObjModel(\ContaoCommunityAlliance\DcGeneral\Data\ModelInterface $model) : \ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetOperationButtonEvent
| fluent |
This method is part of a fluent interface and will return the same instance |
Parameters
Returns
\ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetOperationButtonEvent
Set the previous model in the list, preceding the current model.
setPrevious(\ContaoCommunityAlliance\DcGeneral\Data\ModelInterface $previous) : \ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetOperationButtonEvent
| fluent |
This method is part of a fluent interface and will return the same instance |
Parameters
Returns
\ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\GetOperationButtonEvent
Properties
The ids of any child records of the model.
$childRecordIds : array
Determinator if there is a circular reference from an item in the clipboard to the current model.
$circularReference : bool
Disabled state of the button.
$disabled : bool
The href for the command.
$href : string
Constants