IcingaApiSearchIdoInterface Interface Reference

Inherited by IcingaApiSearchIdoMysql, IcingaApiSearchIdoOci, and IcingaApiSearchIdoPgsql.

List of all members.

Public Member Functions

 createQueryLimit ($searchLimit=false)
 createQueryGroup ($searchGroup=false, $resultColumns=false)
 postProcessQuery ($query, $resultColumnKeys, $searchOrder, $searchLimit)

Detailed Description

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

Member Function Documentation

IcingaApiSearchIdoInterface::createQueryGroup ( searchGroup = false,
resultColumns = false 
)

creates group information for query

Parameters:
array $searchGroup group information
array $resultColumns result columns (select columns)
Returns:
array group template and values
Author:
Christian Doebler <christian.doebler@netways.de>

Implemented in IcingaApiSearchIdoMysql, IcingaApiSearchIdoOci, and IcingaApiSearchIdoPgsql.

IcingaApiSearchIdoInterface::createQueryLimit ( searchLimit = false  ) 

creates limit information for query

Parameters:
array $searchLimit start and length of query limit
Returns:
array limit template and values
Author:
Christian Doebler <christian.doebler@netways.de>

Implemented in IcingaApiSearchIdoMysql, IcingaApiSearchIdoOci, and IcingaApiSearchIdoPgsql.

IcingaApiSearchIdoInterface::postProcessQuery ( query,
resultColumnKeys,
searchOrder,
searchLimit 
)

provides post-processing for query generator

Parameters:
string $query query to post process
array $resultColumnKeys keys of result columns (select columns)
string $searchOrder columns of 'order by' statement
array $searchLimit limit values of query
Returns:
string post processed query
Author:
Christian Doebler <christian.doebler@netways.de>

Implemented in IcingaApiSearchIdoMysql, IcingaApiSearchIdoOci, and IcingaApiSearchIdoPgsql.


The documentation for this interface was generated from the following file:

Generated on Thu Jan 14 15:06:46 2010 for ICINGA-API by  doxygen 1.6.1