GlobalSearchResources Class Reference

Inheritance diagram for GlobalSearchResources:

Collaboration diagram for GlobalSearchResources:

Static Public Member Functions
static	getName ()
static	getSQL ($search)
static	filter ($res, $search)
static	getSearchURL ($searchterm)
Static Public Member Functions inherited from GlobalSearchModule
static	getName ()
static	getSQL ($search)
static	filter ($data, $search)
static	getSearchURL ($searchterm)
static	mark ($string, $query, $longtext=false, $filename=true)

Member Function Documentation

filter()

static filter (   $data,   $search  )

static

Returns an array of information for the found element. Following informations (key: description) are necessary

• name: The name of the object
• url: The url to send the user to when he clicks the link

Additional informations are:

• additional: Subtitle for the hit
• expand: Url if the user further expands the search
• img: Avatar for the

Parameters

$data	One row returned from getSQL SQL Query
$search	The searchstring (Use for markup e.g. self::mark)

Returns

mixed Information Array

Reimplemented from GlobalSearchModule.

Here is the call graph for this function:

getName()

static getName ( )

static

Returns the displayname for this module

Returns

mixed

Reimplemented from GlobalSearchModule.

getSearchURL()

static getSearchURL (   $searchterm )

static

Returns the URL that can be called for a full search.

This could become obsolete when we have a real global search page.

Parameters

string

$searchterm

what to search for?

Reimplemented from GlobalSearchModule.

Here is the call graph for this function:

getSQL()

static getSQL (   $search )

static

Has to return a SQL Query that discovers all objects. All retrieved data is passed row by row to getGlobalSearchFilter

Parameters

$search

the input query string

Returns

String SQL Query to discover elements for the search

Reimplemented from GlobalSearchModule.

Here is the call graph for this function:

---

The documentation for this class was generated from the following file:

• lib/classes/globalsearch/GlobalSearchResources.php