Sidebar Class Reference

Inheritance diagram for Sidebar:

Public Member Functions
	setImage ($image)
	getImage ()
	removeImage ()
	setTitle ($title=true)
	getTitle ()
	removeTitle ()
	setContextAvatar (Avatar $avatar)
	removeContextAvatar ()
	render ()
Public Member Functions inherited from WidgetContainer
	addWidget (Widget $widget, $index=null)
	insertWidget (Widget $widget, $before_index, $index=null)
	getWidget ($index)
	getWidgets ()
	removeWidget ($index)
	countWidgets (string $widget_class=null)
	hasWidgets ()
	hasWidget ($index)
	render ()

Protected Member Functions
	__construct ()
	setupSkipLinks (Widget $widget)
Protected Member Functions inherited from WidgetContainer
	__construct ()

Protected Attributes
	$image = false
	$title = false
	$context_avatar = null
Protected Attributes inherited from WidgetContainer
	$widgets = []

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

Detailed Description

The sidebar supersedes the pretty static infobox of Stud.IP.

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

protected

Constructor, tries to automagically set the sidebar's title.

Member Function Documentation

getImage

(

)

Returns the image for the sidebar.

Returns

mixed Either the previously set image or false if no image has been set.

getTitle

(

)

Returns the title of the sidebar.

Returns

mixed Either the previously set title or false if no title has been set

removeContextAvatar

(

)

Removes a previously set context-indicator.

removeImage

(

)

Removes a previously set image.

removeTitle

(

)

Removes a previously set title.

render

(

)

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

Returns

String The HTML code of the rendered sidebar.

setContextAvatar

(

Avatar

$avatar

)

Sets an avatar as a context-indicator. For example in a course a course- avatar will indicate which course teh user is navigating in.

Parameters

Avatar

$avatar

: the avatar object of the context

setImage

(

$image

)

Set an image for the sidebar.

Parameters

String

$image

The image relative to assets/images

setTitle

(

$title = true

)

Set a title of the sidebar.

Parameters

String

$title

The title of the sidebar.

setupSkipLinks ( Widget  $widget )

protected

Inspects a widget and will set appropriate skiplinks.

Parameters

Widget

$widget

Field Documentation

$context_avatar = null

protected

$image = false

protected

Contains an optional image for the container.

$title = false

protected

---

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

• lib/classes/sidebar/Sidebar.php