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

Public Member Functions

 __construct (array $excluded=[])
 
 getTitle ()
 
 getResults ($keyword, $contextual_data=[], $limit=PHP_INT_MAX, $offset=0)
 
 includePath ()
 
- Public Member Functions inherited from SearchType
 getTitle ()
 
 getAvatar ($id)
 
 getAvatarImageTag ($id)
 
 getResults ($keyword, $contextual_data=[], $limit=PHP_INT_MAX, $offset=0)
 
 __toString ()
 
 includePath ()
 

Protected Attributes

 $excluded = []
 

Detailed Description

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

Constructor & Destructor Documentation

__construct ( array  $excluded = [])

Member Function Documentation

getResults (   $keyword,
  $contextual_data = [],
  $limit = PHP_INT_MAX,
  $offset = 0 
)

Returns the results to a given keyword. To get the results is the job of this routine and it does not even need to come from a database. The results should be an array in the form array ( array($key, $name), array($key, $name), ... ) where $key is an identifier like user_id and $name is a displayed text that should appear to represent that ID.

Parameters
keyword,:string
array$contextual_dataan associative array with more variables
int$limitmaximum number of results (default: all)
int$offsetreturn results starting from this row (default: 0)
Returns
array
getTitle ( )

title of the search like "search for courses" or just "courses"

Returns
string
includePath ( )

Returns the path to this file, so that this class can be autoloaded and is always available when necessary. Should be: "return __file__;"

Returns
string path to this file

Field Documentation

$excluded = []
protected

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