RoomSearchWidget Class Reference

Inheritance diagram for RoomSearchWidget:

Collaboration diagram for RoomSearchWidget:

Public Member Functions
	resetSearch ()
	__construct ($action_link='')
	searchRequested ()
	searchResetRequested ()
	getResults ()
	setActionLink ($action_link='')
	getActionLink ()
	getSelectedCriteria ()
	render ($variables=[])
Public Member Functions inherited from SidebarWidget
	__construct ()
	setTitle ($title)
	getTitle ()
	removeTitle ()
	setExtra ($extra)
	getExtra ()
	removeExtra ()
	render ($variables=array())
Public Member Functions inherited from Widget
	addElement (WidgetElement $element, $index=null)
	insertElement (WidgetElement $element, $before_index, $index=null)
	getElement ($index)
	getElements ()
	removeElement ($index)
	hasElements ()
	hasElement ($index)
	forceRendering ($state=true)
	addLayoutCSSClass ($css_class)
	removeLayoutCSSClass ($css_class)
	render ($variables=array())
	__isset ($offset)
	__get ($offset)
	__set ($offset, $value)
	__unset ($offset)

Protected Member Functions
	setupSearchParameters ()
	handleSearchRequest ()
	restoreSearchFromSession ()
	search ()
Protected Member Functions inherited from Widget
	guessIndex (WidgetElement $element)

Protected Attributes
	$action_link
	$criteria
	$selected_criteria
	$defined_properties
Protected Attributes inherited from Widget
	$elements = array()
	$template = 'widgets/widget'
	$template_variables = array()
	$layout = 'widgets/widget-layout'
	$forced_rendering = false
	$layout_css_classes = array()

Detailed Description

A special search widget that provides a room search.

Constructor & Destructor Documentation

__construct()

__construct

(

$action_link = ''

)

Here is the call graph for this function:

Member Function Documentation

getActionLink()

getActionLink

(

)

getResults()

getResults

(

)

getSelectedCriteria()

getSelectedCriteria

(

)

handleSearchRequest()

handleSearchRequest ( )

protected

Here is the call graph for this function:

Here is the caller graph for this function:

render()

render

(

$variables = []

)

Renders the widget. The widget will only be rendered if it contains at least one element.

Returns

String The THML code of the rendered sidebar widget

Reimplemented from SidebarWidget.

resetSearch()

resetSearch

(

)

Here is the caller graph for this function:

restoreSearchFromSession()

restoreSearchFromSession ( )

protected

Here is the caller graph for this function:

search()

search ( )

protected

Here is the call graph for this function:

Here is the caller graph for this function:

searchRequested()

searchRequested

(

)

Here is the call graph for this function:

Here is the caller graph for this function:

searchResetRequested()

searchResetRequested

(

)

Here is the call graph for this function:

Here is the caller graph for this function:

setActionLink()

setActionLink

(

$action_link = ''

)

setupSearchParameters()

setupSearchParameters ( )

protected

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$action_link

$action_link

protected

$criteria

$criteria

protected

$defined_properties

$defined_properties

protected

$selected_criteria

$selected_criteria

protected

---

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

• lib/classes/sidebar/RoomSearchWidget.class.php