Stud.IP  4.0
 All Data Structures Namespaces Files Functions Variables Groups
HelpbarWidget Class Reference
Inheritance diagram for HelpbarWidget:
Widget HelpbarTourWidget

Public Member Functions

 addElement (WidgetElement $element, $index=null)
 
 setIcon ($icon)
 
 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)
 

Data Fields

 $icon = false
 

Additional Inherited Members

- Protected Member Functions inherited from Widget
 guessIndex (WidgetElement $element)
 
- Protected Attributes inherited from Widget
 $elements = []
 
 $template = 'widgets/widget'
 
 $template_variables = []
 
 $layout = 'widgets/widget-layout'
 
 $forced_rendering = false
 
 $layout_css_classes = []
 

Member Function Documentation

addElement ( WidgetElement  $element,
  $index = null 
)
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
setIcon (   $icon)

Field Documentation

$icon = false

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