Stud.IP  4.0
 All Data Structures Namespaces Files Functions Variables Groups
GlobalSearchModules Class Reference
Inheritance diagram for GlobalSearchModules:
GlobalSearchModule

Static Public Member Functions

static getName ()
 
static getSQL ($search, $filter, $limit)
 
static filter ($module_data, $search)
 
static getSearchURL ($searchterm)
 
- Static Public Member Functions inherited from GlobalSearchModule
static getName ()
 
static getSQL ($search, $filter, $limit)
 
static filter ($data, $search)
 
static getFilters ()
 
static getSearchURL ($searchterm)
 
static mark ($string, $query, $longtext=false, $filename=false)
 
static getInstituteIdsForSQL ($institute_id)
 
static getSeminarTypesForSQL ($sem_class)
 
static getActiveSearchModules ()
 

Detailed Description

GlobalSearchModule for modules

Author
Jan-Hendrik Willms tleil.nosp@m.ax+s.nosp@m.tudip.nosp@m.@gma.nosp@m.il.co.nosp@m.m GPL2 or any later version
Since
4.1

Member Function Documentation

static filter (   $module_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
array$module_data
string$search
Returns
array
static getName ( )
static

Returns the displayname for this module

Returns
string
static getSearchURL (   $searchterm)
static

Returns the url to the global modules search populated with the current search term.

Parameters
string$searchtermwhat to search for?
Returns
string URL to the full search, containing the searchterm and the category
static getSQL (   $search,
  $filter,
  $limit 
)
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.

Parameters
strinig$searchthe input query string
array$filteran array with search limiting filter information (e.g. 'category', 'semester', etc.)
Returns
string SQL Query to discover elements for the search

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