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

Interface CommandInterface.

This interface describes a command that can be applied to a model.

 Methods

Return the description of the command.

getDescription() : array

Returns

array

Fetch extra information.

getExtra() : \ArrayObject

Returns

\ArrayObject

Return the label of the command.

getLabel() : array

Returns

array

Return the name of the command.

getName() : string

Returns

string

Return the action properties of the command.

getParameters() : \ArrayObject

Returns

\ArrayObject

Determine if the command is disabled.

isDisabled() : boolean

Returns

boolean

Set the description of the command.

setDescription(string $description) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\CommandInterface

Parameters

$description

string

The description text.

Returns

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

Set the command enabled or disabled (true means disabled).

setDisabled(boolean $disabled) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\CommandInterface
fluent This method is part of a fluent interface and will return the same instance

Parameters

$disabled

boolean

The flag.

Returns

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

Set extra information.

setExtra(\ArrayObject $extra) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\CommandInterface

Parameters

$extra

\ArrayObject

The extra data.

Returns

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

Set the label of the command.

setLabel(string $label) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\CommandInterface

Parameters

$label

string

The label text.

Returns

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

Set the name of the command.

setName(string $name) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\CommandInterface

Parameters

$name

string

The name of the command.

Returns

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

Set the action properties of the command.

setParameters(\ArrayObject $parameters) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\CommandInterface

Parameters

$parameters

\ArrayObject

The parameters.

Returns

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