IcingaApiCommandCollection Class Reference

Inherits IcingaApiCommand.

Collaboration diagram for IcingaApiCommandCollection:
[legend]

List of all members.

Public Member Functions

 __construct ()
 getCommandNameById ($id=false)
 getCommandIdByName ($commandName=false)
 getCommandFields ($commandName=false)
 getCommandFieldDefinition ($commandField=false)

Static Public Member Functions

static getInstance ()

Protected Member Functions

 __clone ()

Detailed Description

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

Constructor & Destructor Documentation

IcingaApiCommandCollection::__construct (  ) 

class constructor

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

Reimplemented from IcingaApiCommand.


Member Function Documentation

IcingaApiCommandCollection::__clone (  )  [protected]
IcingaApiCommandCollection::getCommandFieldDefinition ( commandField = false  ) 

returns a command field's definition

Parameters:
string $commandField command field
Returns:
array command field's definition or boolean false on error
Author:
Christian Doebler <christian.doebler@netways.de>
IcingaApiCommandCollection::getCommandFields ( commandName = false  ) 

returns a command's fields

Parameters:
string $commandName command name
Returns:
array command fields or boolean false on error
Author:
Christian Doebler <christian.doebler@netways.de>
IcingaApiCommandCollection::getCommandIdByName ( commandName = false  ) 

returns a command's id determined by its name

Parameters:
string $commandName command name
Returns:
integer command id or boolean false on error
Author:
Christian Doebler <christian.doebler@netways.de>
IcingaApiCommandCollection::getCommandNameById ( id = false  ) 

returns a command's name determined by its id

Parameters:
integer $id command id
Returns:
string command name or boolean false on error
Author:
Christian Doebler <christian.doebler@netways.de>
static IcingaApiCommandCollection::getInstance (  )  [static]

Singleton instance method Creates a new instance if needed and returns the object by ref

Returns:
IcingaApiCommandCollection instance of the class
Author:
Marius Hein <marius.hein@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