IcingaApi Class Reference

Inherits IcingaApiConstantsInterface.

Inherited by IcingaApiCommand, IcingaApiConnection, IcingaApiResult, and IcingaApiSearch.

Collaboration diagram for IcingaApi:
[legend]

List of all members.

Public Member Functions

 __construct ()
 debug ($options=false)

Static Public Member Functions

static autoload ($className)
static getConnection ($type, $config)
static getCommandObject ()
static getCommandDispatcher ()
static getCommandCollection ()

Public Attributes

const ObjectsFileSuffix = '.php'

Protected Member Functions

 setIcingaType ($type)

Protected Attributes

 $debug = false
 $icingaType = false

Detailed Description

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

Constructor & Destructor Documentation

IcingaApi::__construct (  ) 

Member Function Documentation

static IcingaApi::autoload ( className  )  [static]

dynamically loads classes on demand

Parameters:
string $className name of class to load
Returns:
void
Author:
Christian Doebler <christian.doebler@netways.de>
IcingaApi::debug ( options = false  ) 

sets debugging levels

Parameters:
mixed $options debugging options (see constants
Returns:
IcingaAPI IcingaAPI object
Author:
Christian Doebler <christian.doebler@netways.de>
static IcingaApi::getCommandCollection (  )  [static]

calls initialization method for new command collection

Parameters:
void 
Returns:
IcingaApiCommandCollection command-collection object
Author:
Marius Hein <marius.hein@netways.de>

Here is the call graph for this function:

static IcingaApi::getCommandDispatcher (  )  [static]

calls initialization method for new command dispatcher

Parameters:
void 
Returns:
IcingaApiCommandDispatcher command-dispatcher object
Author:
Christian Doebler <christian.doebler@netways.de>
static IcingaApi::getCommandObject (  )  [static]

calls initialization method for new command

Parameters:
void 
Returns:
IcingaApiCommand command object
Author:
Christian Doebler <christian.doebler@netways.de>
static IcingaApi::getConnection ( type,
config 
) [static]

calls initialization method for new connection

Parameters:
string $type type of connection object
mixed $config configuration settings of connection object
Returns:
IcingaApiConnection connection object
Author:
Christian Doebler <christian.doebler@netways.de>
IcingaApi::setIcingaType ( type  )  [protected]

sets the icinga type for further generation of class names

Parameters:
string $type connection type
Returns:
void
Author:
Christian Doebler <christian.doebler@netways.de>

Member Data Documentation

IcingaApi::$debug = false [protected]

Reimplemented in IcingaApiSearch.

IcingaApi::$icingaType = false [protected]

Reimplemented in IcingaApiSearch.


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