Stud.IP  5.4
RoomSearchWidget Class Reference
Inheritance diagram for RoomSearchWidget:
SidebarWidget Widget

Public Member Functions

 resetSearch ()
 
 __construct ($action_link='')
 
 searchRequested ()
 
 searchResetRequested ()
 
 getResults ()
 
 setActionLink ($action_link='')
 
 getActionLink ()
 
 getSelectedCriteria ()
 
 render ($variables=[])
 
- Public Member Functions inherited from SidebarWidget
 __construct ()
 
 setId (string $id)
 
 getId ()
 
 setTitle ($title)
 
 getTitle ()
 
 removeTitle ()
 
 setExtra ($extra)
 
 getExtra ()
 
 removeExtra ()
 
 setAdditionalAttribute (string $key, $value)
 
 setAdditionalAttributes (array $attributes)
 
 removeAdditionalAttribute (string $key)
 
 render ($variables=[])
 
- 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=[])
 
 __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
 
 $semesters
 
- Protected Attributes inherited from SidebarWidget
 $additional_attributes = []
 
- Protected Attributes inherited from Widget
 $elements = []
 
 $template = 'widgets/widget'
 
 $template_variables = []
 
 $layout = 'widgets/widget-layout'
 
 $forced_rendering = false
 
 $layout_css_classes = []
 

Detailed Description

A special search widget that provides a room search.

Constructor & Destructor Documentation

◆ __construct()

__construct (   $action_link = '')

Member Function Documentation

◆ getActionLink()

getActionLink ( )

◆ getResults()

getResults ( )

◆ getSelectedCriteria()

getSelectedCriteria ( )

◆ handleSearchRequest()

handleSearchRequest ( )
protected

◆ render()

render (   $variables = [])

◆ resetSearch()

resetSearch ( )

◆ restoreSearchFromSession()

restoreSearchFromSession ( )
protected

◆ search()

search ( )
protected

◆ searchRequested()

searchRequested ( )

◆ searchResetRequested()

searchResetRequested ( )

◆ setActionLink()

setActionLink (   $action_link = '')

◆ setupSearchParameters()

setupSearchParameters ( )
protected

Field Documentation

◆ $action_link

$action_link
protected

◆ $criteria

$criteria
protected

◆ $defined_properties

$defined_properties
protected

◆ $selected_criteria

$selected_criteria
protected

◆ $semesters

$semesters
protected

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