IcingaApiCommand Class Reference

Inherits IcingaApi.

Inherited by IcingaApiCommandCollection, IcingaApiCommandDispatcher, IcingaApiCommandDispatcherException, and IcingaApiCommandSend.

Collaboration diagram for IcingaApiCommand:
[legend]

List of all members.

Public Member Functions

 __construct ()
 setCommand ($command=false)
 setTarget ($key=false, $value=false)
 checkFields ()
 getCommandLine ()

Detailed Description

Author:
Christian Doebler <christian doebler@netways.de>

Constructor & Destructor Documentation

IcingaApiCommand::__construct (  ) 

class constructor

Parameters:
void 
Returns:
IcingaApiCommand instance of IcingaApiCommand object
Author:
Christian Doebler <christian.doebler@netways.de>

Reimplemented from IcingaApi.

Reimplemented in IcingaApiCommandCollection.


Member Function Documentation

IcingaApiCommand::checkFields (  ) 

checks fields (command parameter values)

Parameters:
void 
Returns:
boolean true if fields are ok otherwise false
Author:
Christian Doebler <christian.doebler@netways.de>
IcingaApiCommand::getCommandLine (  ) 

returns the command line which will be sent to icinga

Parameters:
void 
Returns:
string command line
Author:
Christian Doebler <christian.doebler@netways.de>
IcingaApiCommand::setCommand ( command = false  ) 

sets an icinga command

Parameters:
mixed $command command id (integer) or command name (string)
Returns:
IcingaApiCommand the current object
Author:
Christian Doebler <christian.doebler@netways.de>

Reimplemented in IcingaApiCommandDispatcher.

IcingaApiCommand::setTarget ( key = false,
value = false 
)

sets command target (command parameter)

Parameters:
string $key command key
mixed $value command value
Returns:
IcingaApiCommand instance of IcingaApiCommand object
Author:
Christian Doebler <christian.doebler@netways.de>

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

Generated on Thu Jan 14 15:06:46 2010 for ICINGA-API by  doxygen 1.6.1