Search
public class Search
Method Summary | |
---|---|
void | |
void | find(str query, mixed mode) Searches the wiki for matches with the given query string. |
void | getDirectHit(mixed query) Returns the direct hit (if exists). |
void | getMode() Returns the query mode. |
void | Returns the query string. |
void | Returns the query results. |
void | hasDirectHit(mixed query) Returns if a direct hit exists. |
void | Returns if the query returned results. |
void | setMode(mixed value) Sets the query mode. |
void | setQueryString(mixed value) Sets the query string. |
public void __construct()
public void find(str query, mixed mode)
Searches the wiki for matches with the given query string. @param $query Query string. @param $mode Mode. @return Results.
public void getDirectHit(mixed query)
Returns the direct hit (if exists). @param $query Query string. @return Direct hit document. NULL, if no direct hit exists.
public void getMode()
Returns the query mode. @return Mode.
public void getQueryString()
Returns the query string. @return Query string.
public void getResults()
Returns the query results. @return Result as array of entry titles.
public void hasDirectHit(mixed query)
Returns if a direct hit exists. @param $query Query string. @return TRUE if a direct hit exists, otherwise FALSE.
public void hasResults()
Returns if the query returned results. @return TRUE if results have been returned, FALSE if the result set is empty.
public void setMode(mixed value)
Sets the query mode. @param value Mode.
public void setQueryString(mixed value)
Sets the query string. @param value Query string.
This class provides search capabilities.