IcingaApi Class Reference

Inherits IcingaApiConstantsInterface.

Inherited by IcingaApiConnection, IcingaApiResult, and IcingaApiSearch.

Collaboration diagram for IcingaApi:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 __construct ()
 debug ($options=false)

Static Public Member Functions

static autoload ($className)
static getConnection ($type, $config)

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::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:
boolean true on success, otherwise false
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 Fri Jul 3 08:52:11 2009 for ICINGA-API by  doxygen 1.5.8