Stud.IP  4.2 Revision
GlobalSearchFiles Class Reference
Inheritance diagram for GlobalSearchFiles:
Inheritance graph
Collaboration diagram for GlobalSearchFiles:
Collaboration graph

Static Public Member Functions

static getName ()
 
static getSQL ($search)
 
static filter ($data, $search)
 
static enable ()
 
static disable ()
 
static getFulltextSearch ($search)
 
- 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)
 
static getActiveSearchModules ()
 

Member Function Documentation

◆ disable()

static disable ( )
static

Disables fulltext (MATCH AGAINST) search by removing the corresponding indices.

Implements GlobalSearchFulltext.

Here is the call graph for this function:

◆ enable()

static enable ( )
static

Enables fulltext (MATCH AGAINST) search by creating the corresponding indices.

Implements GlobalSearchFulltext.

Here is the call graph for this function:

◆ 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: Icon according to file mimetype
Parameters
Array$fileref
$search
Returns
mixed
Here is the call graph for this function:

◆ getFulltextSearch()

static getFulltextSearch (   $search)
static

Executes a fulltext (MATCH AGAINST) search in database for the given search term.

Parameters
string$searchthe term to search for.
Returns
string SQL query.

Implements GlobalSearchFulltext.

Here is the call graph for this function:

◆ getName()

static getName ( )
static

Returns the displayname for this module

Returns
mixed

◆ getSQL()

static getSQL (   $search)
static

Transforms the search request into an sql statement, that provides the id (same as getId) as type and the object id, that is later passed to the filter.

This function is required to make use of the mysql union parallelism

File search isn't that trivial, as not everything that is found can also be seen/downloaded by the current user. So we fetch thrice the number of entries we need, hoping something downloadable will remain.

Parameters
$searchthe input query string
Returns
String SQL Query to discover elements for the search
Here is the call graph for this function:

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