IcingaApiSearchInterface Interface Reference

Inherited by IcingaApiSearch.

List of all members.

Public Member Functions

 loadColumns ($type)
 setConnectionObject (IcingaApiConnectionInterface &$object)
 setResultType ($type)
 setSearchType ($type)
 setResultColumns ($columns)
 setSearchTarget ($target)
 setSearchFilter ($filter, $value=false, $defaultMatch=IcingaApi::MATCH_EXACT)
 setSearchGroup ($columns)
 setSearchOrder ($column, $direction=false)
 setSearchLimit ($start, $length=false)
 setContactSource ($source)
 setContact ($contact)
 searchValid ()


Detailed Description

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

Member Function Documentation

IcingaApiSearchInterface::loadColumns ( type  ) 

load columns according to given icinga type

Parameters:
string $type current icinga type
Returns:
IcingaApiSearchInterface
Author:
Christian Doebler <christian.doebler@netways.de>

Implemented in IcingaApiSearch.

IcingaApiSearchInterface::searchValid (  ) 

check available search data

Parameters:
void 
Returns:
boolean true if search data is valid otherwise false
Author:
Christian Doebler <christian.doebler@netways.de>

Implemented in IcingaApiSearch.

IcingaApiSearchInterface::setConnectionObject ( IcingaApiConnectionInterface &$  object  ) 

sets the connection object

Parameters:
IcingaApiConnectionInterface $object connection object
Returns:
void
Author:
Christian Doebler <christian.doebler@netways.de>

Implemented in IcingaApiSearch.

IcingaApiSearchInterface::setContact ( contact  ) 

sets the current contact for further filtering

Parameters:
string $contact contact to use as filter
Returns:
IcingaApiSearchInterface
Author:
Christian Doebler <christian.doebler@netways.de>

Implemented in IcingaApiSearch.

IcingaApiSearchInterface::setContactSource ( source  ) 

set source to find current contact

Parameters:
string $source source of contact
Returns:
IcingaApiSearchInterface
Author:
Christian Doebler <christian.doebler@netways.de>

Implemented in IcingaApiSearch.

IcingaApiSearchInterface::setResultColumns ( columns  ) 

sets result columns for query

Parameters:
mixed $columns array of columns or column as string
Returns:
IcingaApiSearchInterface
Author:
Christian Doebler <christian.doebler@netways.de>

Implemented in IcingaApiSearch.

IcingaApiSearchInterface::setResultType ( type  ) 

sets the type of return data

Parameters:
string $type type of data to return (object, array)
Returns:
IcingaApiSearchInterface
Author:
Christian Doebler <christian.doebler@netways.de>

Implemented in IcingaApiSearch.

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

sets 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>

Implemented in IcingaApiSearch.

IcingaApiSearchInterface::setSearchGroup ( columns  ) 

sets columns to group query by

Parameters:
mixed $columns array of columns or string of one or more comma-separated columns to group by
Returns:
IcingaApiSearchInterface
Author:
Christian Doebler <christian.doebler@netways.de>

Implemented in IcingaApiSearch.

IcingaApiSearchInterface::setSearchLimit ( start,
length = false 
)

sets limits for query

Parameters:
mixed $start start row as integer or string containing start and length separated by a comma (NOTE: if $length is missing $start will use as $length instead!)
integer $length number of rows to query for (optional)
Returns:
IcingaApiSearchInterface
Author:
Christian Doebler <christian.doebler@netways.de>

Implemented in IcingaApiSearch.

IcingaApiSearchInterface::setSearchOrder ( column,
direction = false 
)

sets columns and direction to sort by

Parameters:
mixed $column array of columns or string of one or more comma-separated columns including optional directions to sort by
string $direction sort direction (asc|desc; optional)
Returns:
IcingaApiSearchInterface
Author:
Christian Doebler <christian.doebler@netways.de>

Implemented in IcingaApiSearch.

IcingaApiSearchInterface::setSearchTarget ( target  ) 

sets the search target

Parameters:
string $target target to search for
Returns:
IcingaApiSearchInterface
Author:
Christian Doebler <christian.doebler@netways.de>

Implemented in IcingaApiSearch.

IcingaApiSearchInterface::setSearchType ( type  ) 

sets the type of search

Parameters:
string $type search type
Returns:
IcingaApiSearchInterface
Author:
Christian Doebler <christian.doebler@netways.de>

Implemented in IcingaApiSearch.


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

Generated on Fri Jul 3 08:52:13 2009 for ICINGA-API by  doxygen 1.5.8