Overview

Namespaces

  • DcGeneral
    • Clipboard
    • Contao
      • Callback
      • Compatibility
      • DataDefinition
        • Definition
      • Dca
        • Builder
          • Legacy
        • Definition
        • Palette
        • Populator
      • Event
      • View
        • Contao2BackendView
          • Event
    • Controller
    • Data
    • DataDefinition
      • Builder
      • Definition
        • Properties
        • View
          • Panel
      • ModelRelationship
      • Palette
        • Builder
          • Event
        • Condition
          • Palette
          • Property
    • EnvironmentPopulator
    • Event
    • Exception
    • Factory
      • Event
    • Panel
    • View
      • Event

Classes

  • Command
  • CommandCollection
  • CutCommand
  • DefaultListingConfig
  • DefaultModelFormatterConfig
  • DefaultPanelLayout
  • DefaultPanelRow
  • DefaultPanelRowCollection

Interfaces

  • CommandCollectionInterface
  • CommandInterface
  • CutCommandInterface
  • ListingConfigInterface
  • ModelFormatterConfigInterface
  • PanelLayoutInterface
  • PanelRowCollectionInterface
  • PanelRowInterface
  • Overview
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Todo

Interface CommandInterface

Interface CommandInterface.

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

Direct known implementers

DcGeneral\DataDefinition\Definition\View\Command, DcGeneral\DataDefinition\Definition\View\CutCommandInterface

Indirect known implementers

DcGeneral\DataDefinition\Definition\View\CutCommand
Namespace: DcGeneral\DataDefinition\Definition\View
Package: DcGeneral\DataDefinition\Definition\View
Located at DataDefinition/Definition/View/CommandInterface.php
Methods summary
public DcGeneral\DataDefinition\Definition\View\CommandInterface
# setName( string $name )

Set the name of the command.

Set the name of the command.

Parameters

$name
string
$name The name of the command.

Returns

DcGeneral\DataDefinition\Definition\View\CommandInterface
public string
# getName( )

Return the name of the command.

Return the name of the command.

Returns

string
public DcGeneral\DataDefinition\Definition\View\CommandInterface
# setParameters( ArrayObject $parameters )

Set the action properties of the command.

Set the action properties of the command.

Parameters

$parameters
ArrayObject
$parameters The parameters.

Returns

DcGeneral\DataDefinition\Definition\View\CommandInterface
public ArrayObject
# getParameters( )

Return the action properties of the command.

Return the action properties of the command.

Returns

ArrayObject
public DcGeneral\DataDefinition\Definition\View\CommandInterface
# setLabel( string $label )

Set the label of the command.

Set the label of the command.

Parameters

$label
string
$label The label text.

Returns

DcGeneral\DataDefinition\Definition\View\CommandInterface
public array
# getLabel( )

Return the label of the command.

Return the label of the command.

Returns

array
public DcGeneral\DataDefinition\Definition\View\CommandInterface
# setDescription( string $description )

Set the description of the command.

Set the description of the command.

Parameters

$description
string
$description The description text.

Returns

DcGeneral\DataDefinition\Definition\View\CommandInterface
public array
# getDescription( )

Return the description of the command.

Return the description of the command.

Returns

array
public DcGeneral\DataDefinition\Definition\View\CommandInterface
# setExtra( ArrayObject $extra )

Set extra information.

Set extra information.

Parameters

$extra
ArrayObject
$extra The extra data.

Returns

DcGeneral\DataDefinition\Definition\View\CommandInterface
public ArrayObject
# getExtra( )

Fetch extra information.

Fetch extra information.

Returns

ArrayObject
public mixed
# setDisabled( boolean $disabled = true )

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

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

Parameters

$disabled
boolean
$disabled The flag.

Returns

mixed
$this
public boolean
# isDisabled( )

Determine if the command is disabled.

Determine if the command is disabled.

Returns

boolean
contao-community-alliance/dc-general API documentation generated by ApiGen 2.8.0