IcingaApiSearchInterface Interface Reference
Inherited by IcingaApiSearch.
List of all members.
Detailed Description
- Author:
- Christian Doebler <christian.doebler@netways.de>
Member Function Documentation
IcingaApiSearchInterface::searchValid |
( |
|
) |
|
IcingaApiSearchInterface::setContact |
( |
$ |
contact |
) |
|
IcingaApiSearchInterface::setContactSource |
( |
$ |
source |
) |
|
IcingaApiSearchInterface::setResultType |
( |
$ |
type |
) |
|
IcingaApiSearchInterface::setSearchFilter |
( |
$ |
filter, |
|
|
$ |
value = false , |
|
|
$ |
defaultMatch = IcingaApi::MATCH_EXACT | |
|
) |
| | |
IcingaApiSearchInterface::setSearchFilterAppendix |
( |
$ |
statement, |
|
|
$ |
searchAggregator = self::SEARCH_AND | |
|
) |
| | |
IcingaApiSearchInterface::setSearchGroup |
( |
$ |
columns |
) |
|
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 |
) |
|
IcingaApiSearchInterface::setSearchType |
( |
$ |
type |
) |
|
The documentation for this interface was generated from the following file: