MyCoursesSearch Class Reference

Inheritance diagram for MyCoursesSearch:

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 StandardSearch
	__construct ($search, $search_settings=[])
	getTitle ()
	includePath ()
Public Member Functions inherited from SQLSearch
	__construct ($query, $title="", $avatarLike="")
	getTitle ()
	getAvatar ($id)
	getAvatarImageTag ($id, $size=Avatar::SMALL, $options=[])
	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
Protected Attributes inherited from SQLSearch
	$sql
	$avatarLike
	$title

Additional Inherited Members
Static Public Member Functions inherited from SQLSearch
static	get ()
Data Fields inherited from StandardSearch
	$search
	$search_settings
Data Fields inherited from SearchType
	$extendedLayout = false

Constructor & Destructor Documentation

__construct()

__construct	(		$search,
			$perm_level = 'dozent',
			$parameters = [],
			$additional_sql_conditions = ''
	)

Parameters

string	$search
string	$perm_level
string	$additional_sql_conditions	An additional SQL snippet consisting of conditions. This snippet is appended to the default conditions.

Returns

void

Member Function Documentation

getResults()

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	$input	the search-word(s)
array	$contextual_data	an associative array with more variables
int	$limit	maximum number of results (default: all)
int	$offset	return results starting from this row (default: 0)

Returns

array: array(array(), ...)

getTitle()

getTitle

(

)

returns the title/description of the searchfield

Returns

string title/description

includePath()

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

$additional_sql_conditions

protected

---

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

• lib/classes/searchtypes/MyCoursesSearch.php