Helpbar Class Reference

Inheritance diagram for Helpbar:

Collaboration diagram for Helpbar:

Public Member Functions
	__construct ()
	loadContent ()
	setVariables ($variables)
	load ($identifier, $variables=array(), $language=null)
	addPlainText ($label, $text, $icon=null)
	addText ($label, $id)
	addLink ($label, $url, $icon=false, $target=false, $attributes=array())
	insertLink ($label, $url, $icon=false, $target=false, $attributes=array())
	open ($state=true)
	shouldRender ($state=true)
	render ()
Public Member Functions inherited from WidgetContainer
	addWidget (Widget $widget, $index=null)
	insertWidget (Widget $widget, $before_index, $index=null)
	getWidget ($index)
	removeWidget ($index)
	hasWidgets ()

Protected Member Functions
	interpolate ($string, $variables=array())

Protected Attributes
	$json_directory
	$open = false
	$should_render = true
	$variables = array()
Protected Attributes inherited from WidgetContainer
	$widgets = array()

Additional Inherited Members
Static Public Member Functions inherited from WidgetContainer
static	Get ()
Static Protected Attributes inherited from WidgetContainer
static	$instances = null

Detailed Description

Help section

Author

Jan-Hendrik Willms tleil.nosp@m.ax+s.nosp@m.tudip.nosp@m.@gma.nosp@m.il.co.nosp@m.m GPL 2 or later

Since

3.1

Constructor & Destructor Documentation

__construct

(

)

Private constructor to ensure that the singleton Get() method is always used.

See Also

WidgetContainer::Get

Reimplemented from WidgetContainer.

Member Function Documentation

addLink	(		$label,
			$url,
			$icon = false,
			$target = false,
			$attributes = array()
	)

Here is the call graph for this function:

Here is the caller graph for this function:

addPlainText	(		$label,
			$text,
			$icon = null
	)

Here is the call graph for this function:

Here is the caller graph for this function:

addText	(		$label,
			$id
	)

Here is the call graph for this function:

insertLink	(		$label,
			$url,
			$icon = false,
			$target = false,
			$attributes = array()
	)

Here is the call graph for this function:

interpolate (   $string,   $variables = array()  )

protected

Here is the caller graph for this function:

load	(		$identifier,
			$variables = array(),
			$language = null
	)

Todo:

Adjust this to db BEFORE release

Here is the call graph for this function:

loadContent

(

)

load help content from db

Here is the call graph for this function:

Here is the caller graph for this function:

open

(

$state = true

)

render

(

)

Renders the help bar. The helpbar will only be rendered if it actually contains any widgets. It will use the template "helpbar.php" located at "templates/helpbar". A notification is dispatched before and after the actual rendering process.

Returns

String The HTML code of the rendered helpbar.

Reimplemented from WidgetContainer.

Here is the call graph for this function:

setVariables

(

$variables

)

set variables for help content

shouldRender

(

$state = true

)

Field Documentation

$json_directory

protected

$open = false

protected

$should_render = true

protected

$variables = array()

protected

---

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

• lib/classes/helpbar/Helpbar.php