IcingaApiConnection Class Reference

Inherits IcingaApi.

Inherited by IcingaApiConnectionDatabase, IcingaApiConnectionFile, and IcingaApiConnectionLivestatus.

Collaboration diagram for IcingaApiConnection:
[legend]

List of all members.

Public Member Functions

 __construct ()
 checkConfig ($config)
 setDefaultSearchFilter ($filter, $value=false, $defaultMatch=IcingaApi::MATCH_EXACT)

Protected Attributes

 $config = false
 $connectionObject = false
 $connectionResultSet = false
 $searchFilterDefault = array()

Detailed Description

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

Constructor & Destructor Documentation

IcingaApiConnection::__construct (  ) 

class constructor

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

Reimplemented from IcingaApi.

Reimplemented in IcingaApiConnectionDatabase, IcingaApiConnectionFile, IcingaApiConnectionIdo, and IcingaApiConnectionLivestatus.


Member Function Documentation

IcingaApiConnection::checkConfig ( config  ) 

checks the database configuration

Parameters:
array $config associative array storing configuration
Returns:
boolean true if configuration is OK, false on error(s)
Author:
Christian Doebler <christian.doebler@netways.de>
IcingaApiConnection::setDefaultSearchFilter ( filter,
value = false,
defaultMatch = IcingaApi::MATCH_EXACT 
)

sets default search filter(s)

Parameters:
mixed $filter filter key or associative array of key-value pairs defining filters
mixed $value value to filter for
Returns:
IcingaApiSearchInterface
Author:
Christian Doebler <christian.doebler@netways.de>

Member Data Documentation

IcingaApiConnection::$config = false [protected]
IcingaApiConnection::$connectionObject = false [protected]
IcingaApiConnection::$connectionResultSet = false [protected]
IcingaApiConnection::$searchFilterDefault = array() [protected]

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