Stud.IP  4.0
 All Data Structures Namespaces Files Functions Variables Groups
ContentBar Class Reference

Public Member Functions

 __construct (TOCItem $toc, string $info= '', Icon $icon=null, ActionMenu $actionMenu=null)
 
 setInfo (string $info)
 
 setIcon (Icon $icon)
 
 setTOC (TOCItem $toc)
 
 setActionMenu (ActionMenu $actionMenu)
 
 render ()
 
 __toString ()
 

Data Fields

 $infoText = ''
 
 $icon = ''
 
 $toc = null
 
 $actionMenu = null
 

Detailed Description

Class ContentBar ContentBar for page, with optional ActionMenu, Table of contents and breadcrumbs.

Author
Thomas Hackl hackl.nosp@m.@dat.nosp@m.a-que.nosp@m.st.d.nosp@m.e GPL2 or any later version
Since
Stud.IP 5.0

Constructor & Destructor Documentation

__construct ( TOCItem  $toc,
string  $info = '',
Icon  $icon = null,
ActionMenu  $actionMenu = null 
)

ContentBar constructor.

Note: An icon for consumer mode is always shown, this would have to be changed via template.

Parameters
TOCItem$tocTable of contents object.
string$infoSome information to show, like creation date, author etc.
Icon | null$iconAn icon to show in content bar.
ActionMenu | null$actionMenuOptional action menu for page actions.

Member Function Documentation

__toString ( )

Magic method: when ContentBar is used as a string, this will just call the render method, returning a string representation of this object.

Returns
string
render ( )

Render the content bar from corresponding template

Returns
string
setActionMenu ( ActionMenu  $actionMenu)

Provide an action menu.

Parameters
ActionMenu$actionMenu
Returns
ContentBar $this Return current instance for method chaining.
setIcon ( Icon  $icon)

Set an icon.

Parameters
Icon$icon
Returns
ContentBar $this Return current instance for method chaining.
setInfo ( string  $info)

Provide some info text.

Parameters
string$info
Returns
ContentBar $this Return current instance for method chaining.
setTOC ( TOCItem  $toc)

Set a table of contents object.

Parameters
TOCItem$toc
Returns
ContentBar $this Return current instance for method chaining.

Field Documentation

$actionMenu = null
$icon = ''
$infoText = ''
$toc = null

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