IcingaApiSearch Class Reference

Inherits IcingaApi, and IcingaApiSearchInterface.

Inherited by IcingaApiSearchFile, IcingaApiSearchIdo, IcingaApiSearchIdoMysql, IcingaApiSearchIdoOci, IcingaApiSearchIdoPgsql, IcingaApiSearchLivestatus, and IcingaApiSearchLivestatusSocket.

Collaboration diagram for IcingaApiSearch:
[legend]

List of all members.

Public Member Functions

 __construct ()
 setDebug ($debug=false)
 setConnectionObject (IcingaApiConnectionInterface &$object)
 setResultType ($type)
 setSearchType ($type)
 setSearchTarget ($target)
 setSearchFilter ($filter, $value=false, $defaultMatch=IcingaApi::MATCH_EXACT)
 setSearchFilterAppendix ($statement, $searchAggregator=self::SEARCH_AND)
 setSearchGroup ($columns)
 setSearchOrder ($column, $direction= 'asc')
 setSearchLimit ($start, $length=false)
 setContactSource ($source)
 setContact ($contact)
 searchValid ()
 loadInterfaceClass ($sourceType, $dbType=false)
 fetch ()

Public Attributes

 $connectionObject = false

Protected Attributes

 $debug = false
 $resultType = false
 $resultColumnKeys = array()
 $resultColumns = array()
 $resultColumnsNoAliases = array()
 $columnsProcessed = array()
 $joinTables = array()
 $searchTarget = false
 $searchType = false
 $searchFilter = array()
 $searchFilterAppend = array()
 $searchGroup = array()
 $searchOrder = array()
 $searchLimit = false
 $ifSettings = false
 $icingaType = null
 $columns = false

Detailed Description

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

Constructor & Destructor Documentation

IcingaApiSearch::__construct (  ) 

class constructor

Parameters:
void 
Returns:
IcingaApiSearch instance of IcingaApiSearch object
Author:
Christian Doebler <christian.doebler@netways.de>

Reimplemented from IcingaApi.

Reimplemented in IcingaApiSearchFile, IcingaApiSearchIdo, and IcingaApiSearchLivestatus.


Member Function Documentation

IcingaApiSearch::fetch (  ) 

initializes result object and returns it

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

Reimplemented in IcingaApiSearchFile, IcingaApiSearchIdo, and IcingaApiSearchLivestatus.

Here is the call graph for this function:

IcingaApiSearch::loadInterfaceClass ( sourceType,
dbType = false 
)

loads additional database/ interface settings (base queries, columns, etc.)

void

Returns:
boolean true on success, otherwise false
Author:
Christian Doebler <christian.doebler@netways.de>
IcingaApiSearch::searchValid (  ) 

(non-PHPdoc)

See also:
objects/search/IcingaApiSearchInterfacecheckSearch()

Implements IcingaApiSearchInterface.

IcingaApiSearch::setConnectionObject ( IcingaApiConnectionInterface &$  object  ) 

(non-PHPdoc)

See also:
objects/search/IcingaApiSearchInterfacesetConnectionObject()
Author:
Christian Doebler <christian.doebler@netways.de>

Implements IcingaApiSearchInterface.

IcingaApiSearch::setContact ( contact  ) 

(non-PHPdoc)

See also:
objects/search/IcingaApiSearchInterfacesetContact()

Implements IcingaApiSearchInterface.

Here is the call graph for this function:

IcingaApiSearch::setContactSource ( source  ) 

(non-PHPdoc)

See also:
objects/search/IcingaApiSearchInterfacesetContactSource()

Implements IcingaApiSearchInterface.

Here is the call graph for this function:

IcingaApiSearch::setDebug ( debug = false  ) 

sets debugging

Parameters:
integer $debug debugging options
array $debugData debugging data
Returns:
void
Author:
Christian Doebler <christian.doebler@netways.de>

Here is the call graph for this function:

IcingaApiSearch::setResultType ( type  ) 

(non-PHPdoc)

See also:
objects/search/IcingaApiSearchInterfacesetResultType()

Implements IcingaApiSearchInterface.

IcingaApiSearch::setSearchFilter ( filter,
value = false,
defaultMatch = IcingaApi::MATCH_EXACT 
)

(non-PHPdoc)

See also:
objects/search/IcingaApiSearchInterfacesetSearchFilter()

Implements IcingaApiSearchInterface.

IcingaApiSearch::setSearchFilterAppendix ( statement,
searchAggregator = self::SEARCH_AND 
)

(non-PHPdoc)

See also:
objects/search/IcingaApiSearchInterfacesetSearchFilterAppend($statement, $searchAggregator)

Implements IcingaApiSearchInterface.

IcingaApiSearch::setSearchGroup ( columns  ) 

(non-PHPdoc)

See also:
objects/search/IcingaApiSearchInterfacesetSearchGroup()

Implements IcingaApiSearchInterface.

IcingaApiSearch::setSearchLimit ( start,
length = false 
)

(non-PHPdoc)

See also:
objects/search/IcingaApiSearchInterfacesetSearchLimit()

Implements IcingaApiSearchInterface.

IcingaApiSearch::setSearchOrder ( column,
direction = 'asc' 
)

(non-PHPdoc)

See also:
objects/search/IcingaApiSearchInterfacesetSearchOrder()

Implements IcingaApiSearchInterface.

IcingaApiSearch::setSearchTarget ( target  ) 

(non-PHPdoc)

See also:
objects/search/IcingaApiSearchInterfacesetSearchTarget()

Implements IcingaApiSearchInterface.

IcingaApiSearch::setSearchType ( type  ) 

(non-PHPdoc)

See also:
objects/search/IcingaApiSearchInterfacesetSearchType()

Implements IcingaApiSearchInterface.


Member Data Documentation

IcingaApiSearch::$columns = false [protected]
IcingaApiSearch::$columnsProcessed = array() [protected]
IcingaApiSearch::$connectionObject = false
IcingaApiSearch::$debug = false [protected]

Reimplemented from IcingaApi.

IcingaApiSearch::$icingaType = null [protected]

Reimplemented from IcingaApi.

IcingaApiSearch::$ifSettings = false [protected]
IcingaApiSearch::$joinTables = array() [protected]
IcingaApiSearch::$resultColumnKeys = array() [protected]
IcingaApiSearch::$resultColumns = array() [protected]
IcingaApiSearch::$resultColumnsNoAliases = array() [protected]
IcingaApiSearch::$resultType = false [protected]
IcingaApiSearch::$searchFilter = array() [protected]
IcingaApiSearch::$searchFilterAppend = array() [protected]
IcingaApiSearch::$searchGroup = array() [protected]
IcingaApiSearch::$searchLimit = false [protected]
IcingaApiSearch::$searchOrder = array() [protected]
IcingaApiSearch::$searchTarget = false [protected]
IcingaApiSearch::$searchType = false [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