GlobalSearchModules Class Reference
Inheritance diagram for GlobalSearchModules:
Collaboration diagram for GlobalSearchModules:
Static Public Member Functions | |
| static | getName () |
| static | getSQL ($search) |
| static | filter ($module_data, $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) |
| static | getActiveSearchModules () |
Detailed Description
GlobalSearchModule for modules
- Since
- 4.1
Member Function Documentation
◆ filter()
|
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
-
$id $search
- Returns
- array
Here is the call graph for this function:
◆ getName()
|
static |
Returns the displayname for this module
- Returns
- string
◆ getSearchURL()
|
static |
Returns the url to the global modules search populated with the current search term.
- Parameters
-
string $searchterm what to search for?
Here is the call graph for this function:
◆ getSQL()
|
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
-
$search the 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:
- lib/classes/globalsearch/GlobalSearchModules.php
