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 () |
IcingaApiSearchInterface::loadColumns | ( | $ | type | ) |
load columns according to given icinga type
string | $type current icinga type |
Implemented in IcingaApiSearch.
IcingaApiSearchInterface::searchValid | ( | ) |
check available search data
void |
Implemented in IcingaApiSearch.
IcingaApiSearchInterface::setConnectionObject | ( | IcingaApiConnectionInterface &$ | object | ) |
sets the connection object
IcingaApiConnectionInterface | $object connection object |
Implemented in IcingaApiSearch.
IcingaApiSearchInterface::setContact | ( | $ | contact | ) |
sets the current contact for further filtering
string | $contact contact to use as filter |
Implemented in IcingaApiSearch.
IcingaApiSearchInterface::setContactSource | ( | $ | source | ) |
set source to find current contact
string | $source source of contact |
Implemented in IcingaApiSearch.
IcingaApiSearchInterface::setResultColumns | ( | $ | columns | ) |
sets result columns for query
mixed | $columns array of columns or column as string |
Implemented in IcingaApiSearch.
IcingaApiSearchInterface::setResultType | ( | $ | type | ) |
sets the type of return data
string | $type type of data to return (object, array) |
Implemented in IcingaApiSearch.
IcingaApiSearchInterface::setSearchFilter | ( | $ | filter, | |
$ | value = false , |
|||
$ | defaultMatch = IcingaApi::MATCH_EXACT | |||
) |
sets search filter(s)
mixed | $filter filter key or associative array of key-value pairs defining filters | |
mixed | $value value to filter for |
Implemented in IcingaApiSearch.
IcingaApiSearchInterface::setSearchGroup | ( | $ | columns | ) |
sets columns to group query by
mixed | $columns array of columns or string of one or more comma-separated columns to group by |
Implemented in IcingaApiSearch.
IcingaApiSearchInterface::setSearchLimit | ( | $ | start, | |
$ | length = false | |||
) |
sets limits for query
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) |
Implemented in IcingaApiSearch.
IcingaApiSearchInterface::setSearchOrder | ( | $ | column, | |
$ | direction = false | |||
) |
sets columns and direction to sort by
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) |
Implemented in IcingaApiSearch.
IcingaApiSearchInterface::setSearchTarget | ( | $ | target | ) |
sets the search target
string | $target target to search for |
Implemented in IcingaApiSearch.
IcingaApiSearchInterface::setSearchType | ( | $ | type | ) |
sets the type of search
string | $type search type |
Implemented in IcingaApiSearch.