Stud.IP  5.4
Sidebar Class Reference
Inheritance diagram for Sidebar:
WidgetContainer

Public Member Functions

 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

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

__construct ( )
protected

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

Member Function Documentation

◆ getTitle()

getTitle ( )

Returns the title of the sidebar.

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

◆ removeContextAvatar()

removeContextAvatar ( )

Removes a previously set context-indicator.

◆ removeTitle()

removeTitle ( )

Removes a previously set title.

◆ render()

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

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

◆ setTitle()

setTitle (   $title = true)

Set a title of the sidebar.

Parameters
String$titleThe title of the sidebar.

◆ setupSkipLinks()

setupSkipLinks ( Widget  $widget)
protected

Inspects a widget and will set appropriate skiplinks.

Parameters
Widget$widget

Field Documentation

◆ $context_avatar

$context_avatar = null
protected

◆ $title

$title = false
protected

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