Docs For Class FOFToolbar

Description

The Toolbar class renders the back-end component title area and the back- and front-end toolbars.

since: 1.0

Located in /libraries/fof/toolbar/toolbar.php (line 18)

Direct descendents

Class	Description
PostinstallToolbar	The Toolbar class renders the component title area and the toolbar.

Variable Summary

array $config

array $input

array $linkbar

array $perms

bool $renderFrontendButtons

bool $renderFrontendSubmenu

Method Summary

static FOFToolbar &getAnInstance ([string $option = null], [array $config = array()])

FOFToolbar __construct ([array $config = array()])

void appendLink (string $name, [string|null $link = null], [boolean $active = false], [string|null $icon = null], [string|null $parent = ''])

void clearLinks ()

array &getLinks ()

array getMyViews ()

boolean getRenderFrontendButtons ()

boolean getRenderFrontendSubmenu ()

void onAdd ()

void onBrowse ()

void onCpanelsBrowse ()

void onEdit ()

void onRead ()

void prefixLink (string $name, [string|null $link = null], [boolean $active = false], [string|null $icon = null])

void renderSubmenu ()

void renderToolbar ([string $view = null], [string $task = null], [FOFInput $input = null])

Variables

array $config = array() (line 21)

var: Configuration parameters
access: protected

array $input = array() (line 24)

var: Input (e.g. request) variables
access: protected

array $linkbar = array() (line 30)

var: The links to be rendered in the toolbar
access: protected

array $perms = array() (line 27)

var: Permissions map, see the __construct method for more information
access: public

bool $renderFrontendButtons = false (line 36)

var: Should I render buttons in the front-end?
access: protected

bool $renderFrontendSubmenu = false (line 33)

var: Should I render the submenu in the front-end?
access: protected

Methods

static getAnInstance (line 46)

Gets an instance of a component's toolbar

return: The toolbar instance for the component
access: public

static FOFToolbar &getAnInstance ([string $option = null], [array $config = array()])

string $option: The name of the component
array $config: The configuration array for the component

Constructor __construct (line 131)

Public cinstructor

access: public

FOFToolbar __construct ([array $config = array()])

array $config: The configuration array of the component

appendLink (line 500)

Append a link to the link bar

access: public

void appendLink (string $name, [string|null $link = null], [boolean $active = false], [string|null $icon = null], [string|null $parent = ''])

string $name: The text of the link
string|null $link: The link to render; set to null to render a separator
boolean $active: True if it's an active link
string|null $icon: Icon class (used by some renderers, like the Bootstrap renderer)
string|null $parent: The parent element (referenced by name)) Thsi will create a dropdown list

clearLinks (line 474)

Removes all links from the link bar

access: public

void clearLinks ()

getLinks (line 484)

Get the link bar's link definitions

access: public

array &getLinks ()

getMyViews (line 614)

Automatically detects all views of the component

return: A list of all views, in the order to be displayed in the toolbar submenu
access: protected

array getMyViews ()

getRenderFrontendButtons (line 715)

Return the front-end toolbar rendering flag

access: public

boolean getRenderFrontendButtons ()

getRenderFrontendSubmenu (line 725)

Return the front-end submenu rendering flag

access: public

boolean getRenderFrontendSubmenu ()

onAdd (line 431)

Renders the toolbar for the component's Add pages

access: public

void onAdd ()

onBrowse (line 332)

Renders the toolbar for the component's Browse pages (the plural views)

access: public

void onBrowse ()

onCpanelsBrowse (line 309)

Renders the toolbar for the component's Control Panel page

access: public

void onCpanelsBrowse ()

onEdit (line 458)

Renders the toolbar for the component's Edit pages

access: public

void onEdit ()

onRead (line 401)

Renders the toolbar for the component's Read pages

access: public

void onRead ()

prefixLink (line 550)

Prefixes (some people erroneously call this "prepend" – there is no such word) a link to the link bar

access: public

void prefixLink (string $name, [string|null $link = null], [boolean $active = false], [string|null $icon = null])

string $name: The text of the link
string|null $link: The link to render; set to null to render a separator
boolean $active: True if it's an active link
string|null $icon: Icon class (used by some renderers, like the Bootstrap renderer)

renderSubmenu (line 566)

Renders the submenu (toolbar links) for all detected views of this component

access: public

void renderSubmenu ()

renderToolbar (line 219)

Renders the toolbar for the current view and task

access: public

void renderToolbar ([string $view = null], [string $task = null], [FOFInput $input = null])

string $view: The view of the component
string $task: The exact task of the view
FOFInput $input: An optional input object used to determine the defaults