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 CommandCollectionInterface

Interface CommandCollectionInterface.

This interface describes a collection of commands.

Direct known implementers

DcGeneral\DataDefinition\Definition\View\CommandCollection
Namespace: DcGeneral\DataDefinition\Definition\View
Package: DcGeneral\DataDefinition\Definition\View
Located at DataDefinition/Definition/View/CommandCollectionInterface.php
Methods summary
public DcGeneral\DataDefinition\Definition\View\CommandCollectionInterface
# clearCommands( )

Remove all commands from this collection.

Remove all commands from this collection.

Returns

DcGeneral\DataDefinition\Definition\View\CommandCollectionInterface
public DcGeneral\DataDefinition\Definition\View\CommandCollectionInterface
# setCommands( array $commands )

Set the commands of this collection.

Set the commands of this collection.

Parameters

$commands
DcGeneral\DataDefinition\Definition\View\CommandInterface[]|array
$commands The commands that shall be contained within the collection.

Returns

DcGeneral\DataDefinition\Definition\View\CommandCollectionInterface
public DcGeneral\DataDefinition\Definition\View\CommandCollectionInterface
# addCommands( array $commands )

Add commands to this collection.

Add commands to this collection.

Parameters

$commands
DcGeneral\DataDefinition\Definition\View\CommandInterface[]|array
$commands The commands that shall be added to the collection.

Returns

DcGeneral\DataDefinition\Definition\View\CommandCollectionInterface
public DcGeneral\DataDefinition\Definition\View\CommandCollectionInterface
# removeCommands( array $commands )

Remove commands from this collection.

Remove commands from this collection.

Parameters

$commands
DcGeneral\DataDefinition\Definition\View\CommandInterface[]|array
$commands The commands that shall be removed from the collection.

Returns

DcGeneral\DataDefinition\Definition\View\CommandCollectionInterface
public boolean
# hasCommand( DcGeneral\DataDefinition\Definition\View\CommandInterface $command )

Check if the command exists in this collection.

Check if the command exists in this collection.

Parameters

$command
DcGeneral\DataDefinition\Definition\View\CommandInterface
$command The command instance to search for.

Returns

boolean
public boolean
# hasCommandNamed( string $name )

Check if the command with a given name exists in this collection.

Check if the command with a given name exists in this collection.

Parameters

$name
string
$name The command name to search.

Returns

boolean
public DcGeneral\DataDefinition\Definition\View\CommandCollectionInterface
# addCommand( DcGeneral\DataDefinition\Definition\View\CommandInterface $command )

Add an command to this collection.

Add an command to this collection.

Parameters

$command
DcGeneral\DataDefinition\Definition\View\CommandInterface
$command The command to add.

Returns

DcGeneral\DataDefinition\Definition\View\CommandCollectionInterface
public DcGeneral\DataDefinition\Definition\View\CommandCollectionInterface
# removeCommand( DcGeneral\DataDefinition\Definition\View\CommandInterface $command )

Remove an command from this collection.

Remove an command from this collection.

Parameters

$command
DcGeneral\DataDefinition\Definition\View\CommandInterface
$command The command to remove.

Returns

DcGeneral\DataDefinition\Definition\View\CommandCollectionInterface
public DcGeneral\DataDefinition\Definition\View\CommandCollectionInterface
# removeCommandNamed( string $name )

Remove an command with given name from this collection.

Remove an command with given name from this collection.

Parameters

$name
string
$name The command name to remove.

Returns

DcGeneral\DataDefinition\Definition\View\CommandCollectionInterface
public DcGeneral\DataDefinition\Definition\View\CommandInterface
# getCommandNamed( string $name )

Get command with given name from this collection.

Get command with given name from this collection.

Parameters

$name
string
$name The command name to search.

Returns

DcGeneral\DataDefinition\Definition\View\CommandInterface

Throws

DcGeneral\Exception\DcGeneralInvalidArgumentException
If no command was found.
public DcGeneral\DataDefinition\Definition\View\CommandInterface[]|array
# getCommands( )

Get commands from this collection.

Get commands from this collection.

Returns

DcGeneral\DataDefinition\Definition\View\CommandInterface[]|array
contao-community-alliance/dc-general API documentation generated by ApiGen 2.8.0