HelpbarWidget Class Reference

Inheritance diagram for HelpbarWidget:

Collaboration diagram for HelpbarWidget:

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()

addElement	(	WidgetElement	$element,
			$index = null
	)

Add an element to the widget.

Parameters

WidgetElement	$element	The actual element
String	$index	Index/name of the element

Reimplemented from Widget.

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 Widget.

Here is the call graph for this function:

setIcon()

setIcon

(

$icon

)

Field Documentation

$icon

$icon = false

---

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

• lib/classes/helpbar/HelpbarWidget.php