IcingaApiConnectionDatabase Class Reference

Inherits IcingaApiConnection, and IcingaApiConnectionInterface.

Inherited by IcingaApiConnectionIdo.

Collaboration diagram for IcingaApiConnectionDatabase:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 __construct ()
 createSearch ()
 checkConfig (array $config)
 setConfig (array $config)
 connect ()
 query ($query, $queryParams=array())

Public Attributes

 $connectionStatement = false


Detailed Description

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

Constructor & Destructor Documentation

IcingaApiConnectionDatabase::__construct (  ) 

class constructor

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

Reimplemented from IcingaApiConnection.

Reimplemented in IcingaApiConnectionIdo, and IcingaApiConnectionIdoAbstraction.


Member Function Documentation

IcingaApiConnectionDatabase::checkConfig ( array $  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>

IcingaApiConnectionDatabase::connect (  ) 

connects to database

Parameters:
array $config associative array storing database connection settings
Returns:
IcingaApiConnectionDatabase database object
Author:
Christian Doebler <christian.doebler@netways.de>

Implements IcingaApiConnectionInterface.

IcingaApiConnectionDatabase::createSearch (  )  [abstract]

calls initialization method for new search

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

Reimplemented in IcingaApiConnectionIdo.

IcingaApiConnectionDatabase::query ( query,
queryParams = array() 
)

queries database using PDOs

Parameters:
string $query query to execute
array $queryParams query parameters to use with query
Returns:
IcingaApiConnectionDatabase database object
Author:
Christian Doebler <christian.doebler@netways.de>

Implements IcingaApiConnectionInterface.

IcingaApiConnectionDatabase::setConfig ( array $  config  ) 

assembles the database DSN

Parameters:
array $config associative array storing database connection settings
Returns:
mixed DSN string on success otherwise boolean false
Author:
Christian Doebler <christian.doebler@netways.de>

Implements IcingaApiConnectionInterface.

Here is the call graph for this function:


Member Data Documentation

IcingaApiConnectionDatabase::$connectionStatement = false


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