WeakWiki


WeakWiki\Search
lib\engine.library.php at line 458

Class Search

Search

public class Search

This class provides search capabilities.


Method Summary
void

__construct()

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

getQueryString()

Returns the query string.

void

getResults()

Returns the query results.

void

hasDirectHit(mixed query)

Returns if a direct hit exists.

void

hasResults()

Returns if the query returned results.

void

setMode(mixed value)

Sets the query mode.

void

setQueryString(mixed value)

Sets the query string.

Method Detail

lib\engine.library.php at line 479

__construct

public void __construct()

lib\engine.library.php at line 564

find

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.


lib\engine.library.php at line 553

getDirectHit

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.


lib\engine.library.php at line 510

getMode

public void getMode()

Returns the query mode. @return Mode.


lib\engine.library.php at line 494

getQueryString

public void getQueryString()

Returns the query string. @return Query string.


lib\engine.library.php at line 526

getResults

public void getResults()

Returns the query results. @return Result as array of entry titles.


lib\engine.library.php at line 544

hasDirectHit

public void hasDirectHit(mixed query)

Returns if a direct hit exists. @param $query Query string. @return TRUE if a direct hit exists, otherwise FALSE.


lib\engine.library.php at line 535

hasResults

public void hasResults()

Returns if the query returned results. @return TRUE if results have been returned, FALSE if the result set is empty.


lib\engine.library.php at line 518

setMode

public void setMode(mixed value)

Sets the query mode. @param value Mode.


lib\engine.library.php at line 502

setQueryString

public void setQueryString(mixed value)

Sets the query string. @param value Query string.


WeakWiki