IcingaApiResult Class Reference

Inherits IcingaApi, and IcingaApiResultInterface.

Inherited by IcingaApiResultFile, IcingaApiResultIdo, and IcingaApiResultLivestatus.

Collaboration diagram for IcingaApiResult:
[legend]

List of all members.

Public Member Functions

 __construct ()
 __get ($name)
 __call ($name, $arguments=array())
 get ($searchField=false)
 getAll ()
 getRow ()
 setSearchObject (&$object)
 setResultType ($type)
 current ()
 key ()
 valid ()
 getResultCount ()
 setDbType ($type)

Protected Attributes

 $searchObject = false
 $resultType = self::RESULT_OBJECT
 $resultArray = false
 $resultRow = false
 $numResults = false
 $offset = false
 $dbType = false

Detailed Description

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

Constructor & Destructor Documentation

IcingaApiResult::__construct (  ) 

class constructor

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

Reimplemented from IcingaApi.

Reimplemented in IcingaApiResultFile, IcingaApiResultIdo, and IcingaApiResultLivestatus.


Member Function Documentation

IcingaApiResult::__call ( name,
arguments = array() 
)

(non-PHPdoc)

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

Implements IcingaApiResultInterface.

IcingaApiResult::__get ( name  ) 

(non-PHPdoc)

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

Implements IcingaApiResultInterface.

IcingaApiResult::current (  ) 

returns current result object

Parameters:
void 
Returns:
mixed
Author:
Christian Doebler <christian.doebler@netways.de>
IcingaApiResult::get ( searchField = false  ) 

(non-PHPdoc)

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

Implements IcingaApiResultInterface.

IcingaApiResult::getAll (  )  [abstract]

returns complete result set

Parameters:
void 
Returns:
mixed complete result set
Author:
Christian Doebler <christian.doebler@netways.de>

Reimplemented in IcingaApiResultIdo, and IcingaApiResultLivestatus.

IcingaApiResult::getResultCount (  ) 

(non-PHPdoc)

See also:
objects/result/IcingaApiResultInterfacegetResultCount()

Implements IcingaApiResultInterface.

IcingaApiResult::getRow (  ) 

(non-PHPdoc)

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

Implements IcingaApiResultInterface.

IcingaApiResult::key (  ) 

returns current offset

Parameters:
void 
Returns:
scalar
Author:
Christian Doebler <christian.doebler@netways.de>
IcingaApiResult::setDbType ( type  ) 

sets the database type (mysql, oci, etc.)

Parameters:
string $type type of database
Returns:
void
Author:
Christian Doebler <christian.doebler@netways.de>
IcingaApiResult::setResultType ( type  ) 

(non-PHPdoc)

See also:
objects/result/IcingaApiResultInterfacesetResultType()

Implements IcingaApiResultInterface.

IcingaApiResult::setSearchObject ( &$  object  )  [abstract]

sets the search object

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

Reimplemented in IcingaApiResultFile, IcingaApiResultIdo, and IcingaApiResultLivestatus.

IcingaApiResult::valid (  ) 

checks whether there's a result row left

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

Member Data Documentation

IcingaApiResult::$dbType = false [protected]
IcingaApiResult::$numResults = false [protected]
IcingaApiResult::$offset = false [protected]
IcingaApiResult::$resultArray = false [protected]
IcingaApiResult::$resultRow = false [protected]
IcingaApiResult::$resultType = self::RESULT_OBJECT [protected]
IcingaApiResult::$searchObject = false [protected]

Reimplemented from IcingaApi.


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