Class FOFToolbar

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

Package: FrameworkOnFramework\toolbar
Copyright: Copyright (C) 2010-2016 Nicholas K. Dionysopoulos / Akeeba Ltd. All rights reserved.
License: General Public License version 2 or later; see LICENSE.txt
Since: 1.0
Located at fof/toolbar/toolbar.php

Methods summary

`public static FOFToolbar &`	# `getAnInstance( string $option = null, array $config = array() )` Gets an instance of a component's toolbar Gets an instance of a component's toolbar Parameters `$option` `string` - $option The name of the component `$config` `array` - $config The configuration array for the component Returns `FOFToolbar` - The toolbar instance for the component
`public`	# `__construct( array $config = array() )` Public constructor Public constructor Parameters `$config` `array` - $config The configuration array of the component
`public`	# `renderToolbar( string $view = null, string $task = null, FOFInput $input = null )` Renders the toolbar for the current view and task Renders the toolbar for the current view and task Parameters `$view` `string` - $view The view of the component `$task` `string` - $task The exact task of the view `$input` `FOFInput` - $input An optional input object used to determine the defaults
`public`	# `onCpanelsBrowse( )` Renders the toolbar for the component's Control Panel page Renders the toolbar for the component's Control Panel page
`public`	# `onBrowse( )` Renders the toolbar for the component's Browse pages (the plural views) Renders the toolbar for the component's Browse pages (the plural views)
`public`	# `onRead( )` Renders the toolbar for the component's Read pages Renders the toolbar for the component's Read pages
`public`	# `onAdd( )` Renders the toolbar for the component's Add pages Renders the toolbar for the component's Add pages
`public`	# `onEdit( )` Renders the toolbar for the component's Edit pages Renders the toolbar for the component's Edit pages
`public`	# `clearLinks( )` Removes all links from the link bar Removes all links from the link bar
`public array &`	# `getLinks( )` Get the link bar's link definitions Get the link bar's link definitions Returns `array`
`public`	# `appendLink( string $name, string\|null $link = null, boolean $active = false, string\|null $icon = null, string\|null $parent = '' )` Append a link to the link bar Append a link to the link bar Parameters `$name` `string` - $name The text of the link `$link` `string\|null` - $link The link to render; set to null to render a separator `$active` `boolean` - $active True if it's an active link `$icon` `string\|null` - $icon Icon class (used by some renderers, like the Bootstrap renderer) `$parent` `string\|null` - $parent The parent element (referenced by name)) Thsi will create a dropdown list
`public`	# `prefixLink( string $name, string\|null $link = null, boolean $active = false, string\|null $icon = null )` Prefixes (some people erroneously call this "prepend" – there is no such word) a link to the link bar Prefixes (some people erroneously call this "prepend" – there is no such word) a link to the link bar Parameters `$name` `string` - $name The text of the link `$link` `string\|null` - $link The link to render; set to null to render a separator `$active` `boolean` - $active True if it's an active link `$icon` `string\|null` - $icon Icon class (used by some renderers, like the Bootstrap renderer)
`public`	# `renderSubmenu( )` Renders the submenu (toolbar links) for all detected views of this component Renders the submenu (toolbar links) for all detected views of this component
`protected array`	# `getMyViews( )` Automatically detects all views of the component Automatically detects all views of the component Returns `array` - A list of all views, in the order to be displayed in the toolbar submenu
`public boolean`	# `getRenderFrontendButtons( )` Return the front-end toolbar rendering flag Return the front-end toolbar rendering flag Returns `boolean`
`public boolean`	# `getRenderFrontendSubmenu( )` Return the front-end submenu rendering flag Return the front-end submenu rendering flag Returns `boolean`

Magic methods summary

Properties summary

`protected array`	`$config`	# Configuration parameters Configuration parameters
`protected array`	`$input`	# Input (e.g. request) variables Input (e.g. request) variables
`public array`	`$perms`	# Permissions map, see the __construct method for more information Permissions map, see the __construct method for more information
`protected array`	`$linkbar`	# The links to be rendered in the toolbar The links to be rendered in the toolbar
`protected boolean`	`$renderFrontendSubmenu`	# Should I render the submenu in the front-end? Should I render the submenu in the front-end?
`protected boolean`	`$renderFrontendButtons`	# Should I render buttons in the front-end? Should I render buttons in the front-end?

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class FOFToolbar

Methods summary

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Parameters

Returns

Returns

Returns

Magic methods summary

Properties summary