SearchType Class Reference

Inheritance diagram for SearchType:

Public Member Functions
	getTitle ()
	getAvatar ($id)
	getAvatarImageTag ($id)
	getResults ($keyword, $contextual_data=[], $limit=PHP_INT_MAX, $offset=0)
	__toString ()
	includePath ()

Data Fields
	$extendedLayout = false

Detailed Description

A class-structure for alle search-objects in Stud.IP. It is (mainly?) used in QuickSearch to display searchresults and the layout of them.

Author

Rasmus Fuhse

Member Function Documentation

__toString()

__toString

(

)

getAvatar()

getAvatar

(

$id

)

Returns an URL to a picture of that type. Return "" for nothing found. For example: "return CourseAvatar::getAvatar($id)->getURL(Avatar::SMALL)".

Parameters

string

$id

Returns

: string URL to a picture

getAvatarImageTag()

getAvatarImageTag

(

$id

)

Returns an HTML-Tag of a picture of that type. Return "" for nothing found. For example: "return CourseAvatar::getAvatar($id)->getImageTag(Avatar::SMALL)".

Parameters

string

$id

Returns

string HTML of a picture

getResults()

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

string	$keyword
string	$contextual_data
int	$limit	maximum number of results (default: all)
int	$offset	return results starting from this row (default: 0)

Returns

array

getTitle()

getTitle

(

)

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

Returns

string

includePath()

includePath ( )

abstract

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

$extendedLayout

$extendedLayout = false

---

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

• lib/classes/searchtypes/SearchType.php