.

ICommand Interface Reference
[Interfaces]

Interface for commands. More...

Inheritance diagram for ICommand:
IAction ISerializable CommandBase CommandDelegate CallbackCommand ClearCacheCommand CommandChain CommandComposite CommandTransactional CookieDeleteCommand CookieSetCommand ExecuteShellCommand MailBaseCommand TriggerEventCommand DelegateCommandImpl StatusCommand

List of all members.

Public Member Functions

  can_execute ($user)
  Returns TRUE, if the command can be executed by given user.
  execute ()
  Executes commands.
  get_name_serialized ()
  Returns a name that has parameters build in.
  get_params ()
  Return parameters.
  get_result ()
  Return result of command.
  get_success_message ()
  Returns success message for this command.
  undo ()
  Revert execution.

Detailed Description

Interface for commands.

Author:
Gerd Riesselmann

Definition at line 11 of file icommand.cls.php.


Member Function Documentation

ICommand::can_execute ( user  ) 

Returns TRUE, if the command can be executed by given user.

Implemented in CommandBase, CommandChain, CommandComposite, CommandDelegate, MailBaseCommand, and TriggerEventCommand.

ICommand::get_name_serialized (  ) 

Returns a name that has parameters build in.

Returns:
string

Implemented in CommandBase, and CommandDelegate.

ICommand::get_params (  ) 

Return parameters.

Returns:
mixed

Implemented in CommandBase, CommandDelegate, and StatusAnyCommand.

ICommand::get_result (  ) 

Return result of command.

Returns:
mixed

Implemented in CommandBase, and CommandDelegate.

ICommand::get_success_message (  ) 

Returns success message for this command.

Implemented in CommandBase, and CommandDelegate.

ICommand::undo (  ) 

Revert execution.

Implemented in CommandBase, CommandChain, CommandComposite, and CommandDelegate.


The documentation for this interface was generated from the following file: