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

Public Member Functions

 __construct (array $root_resources=[], $title='', $parameter_name=null)
- Public Member Functions inherited from ResourceTreeWidget
 __construct (array $root_resources=[], $title='', $parameter_name='tree_selected_resource')
 render ($variables=[])
 setCurrentResource (Resource $resource)
 setCurrentResourceId ($resource_id=null)
 setFoldable ($foldable=false)
 isFoldable ()
- 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)

Additional Inherited Members

- Protected Member Functions inherited from Widget
 guessIndex (WidgetElement $element)
- Protected Attributes inherited from ResourceTreeWidget
 $root_resources = []
 $parameter_name = ''
 $foldable = false
 $current_resource_id = null
- 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

This class provides a resource tree view for the room search sidebar.

Timo Hartge GNU General Public License v2 or later.

Constructor & Destructor Documentation

◆ __construct()

__construct ( array  $root_resources = [],
  $title = '',
  $parameter_name = null 

This widget must be initialised by providing at least one Resource object in an array.

array$root_resourcesThe root resource objects which will be displayed by this tree view.
string$titleThe title of this widget.
string | null$parameter_nameThe name of the URL parameter which will be set when one of the resources in the tree is selected. If parameter_name is set to null the items in the resource tree widget will link to the resource's details page.

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