You are here

public function SearchApiQueryInterface::getKeys in Search API 7

Retrieves the search keys for this query.

Return value

array|string|null This object's search keys - either a string or an array specifying a complex search expression. An array will contain a '#conjunction' key specifying the conjunction type, and search strings or nested expression arrays at numeric keys. Additionally, a '#negation' key might be present, which means – unless it maps to a FALSE value – that the search keys contained in that array should be negated, i.e. not be present in returned results. The negation works on the whole array, not on each contained term individually – i.e., with the "AND" conjunction and negation, only results that contain all the terms in the array should be excluded; with the "OR" conjunction and negation, all results containing one or more of the terms in the array should be excluded.

See also

keys()

1 method overrides SearchApiQueryInterface::getKeys()
SearchApiQuery::getKeys in includes/query.inc
Retrieves the search keys for this query.

File

includes/query.inc, line 288
Contains SearchApiQueryInterface and SearchApiQuery.

Class

SearchApiQueryInterface
Interface representing a search query on an Search API index.

Code

public function &getKeys();