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

Public Member Functions

 __construct ($search, $perm_level= 'dozent', $parameters=[], $additional_sql_conditions= '')
 
 getTitle ()
 
 getResults ($input, $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

 $additional_sql_conditions
 

Additional Inherited Members

- Data Fields inherited from SearchType
 $extendedLayout = false
 

Constructor & Destructor Documentation

__construct (   $search,
  $perm_level = 'dozent',
  $parameters = [],
  $additional_sql_conditions = '' 
)
Parameters
string$search
string$perm_level
string$additional_sql_conditionsAn additional SQL snippet consisting of conditions. This snippet is appended to the default conditions.
Returns
void

Member Function Documentation

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

returns the results of a search Use the contextual_data variable to send more variables than just the input to the SQL. QuickSearch for example sends all other variables of the same <form>-tag here.

Parameters
string$inputthe search-word(s)
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: array(array(), ...)
getTitle ( )

returns the title/description of the searchfield

Returns
string title/description
includePath ( )

A very simple overwrite of the same method from SearchType class. returns the absolute path to this class for autoincluding this class.

Returns
: path to this class

Field Documentation

$additional_sql_conditions
protected

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