StandardSearch Class Reference

Inheritance diagram for StandardSearch:

Public Member Functions
	__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 ()

Data Fields
	$search
	$search_settings
Data Fields inherited from SearchType
	$extendedLayout = false

Additional Inherited Members
Static Public Member Functions inherited from SQLSearch
static	get ()
Protected Attributes inherited from SQLSearch
	$sql
	$avatarLike
	$title

Detailed Description

Class of type SearchType used for searches with QuickSearch (lib/classes/QuickSearch.class.php). You can search with a sql-syntax in the database. You just need to give in a query like for a PDB-prepare statement and at least the variable ":input" in the query (the :input will be replaced with the input of the QuickSearch userinput. [code] $search = new SQLSearch("username"); [/code]

Author

Rasmus Fuhse

Constructor & Destructor Documentation

__construct()

__construct	(		$search,
			$search_settings = []
	)

Parameters

string	$search	The search type.
Array	$search_settings	Settings for the selected seach type. Depending on the search type different settings are possible which can change the output or the display of the output of the search. The array must be an associative array with the setting as array key. The following settings are implemented: Search type 'room': display_seats: If set to true, the seats will be displayed after the name of the room.

Returns

void

Member Function Documentation

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

$search

$search

$search_settings

$search_settings

---

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

• lib/classes/searchtypes/StandardSearch.class.php