PHP Class FOF30\Toolbar\Toolbar

Since: 1.0

Mostrar archivo Open project: akeeba/fof Class Usage Examples

Public Properties

Property	Type	Description
$perms		Permissions map, see the __construct method for more information

Protected Properties

Property	Type	Description
$container		Component container
$isDataView		Are we rendering a data-aware view?
$linkbar		The links to be rendered in the toolbar
$renderFrontendButtons		Should I render buttons in the front-end?
$renderFrontendSubmenu		Should I render the submenu in the front-end?
$useConfigurationFile		Should I use the configuration file (fof.xml) of the component?

Public Methods

Method	Description
__construct ( Container $c, array $config = [] )	Public constructor.
appendLink ( string $name, string \| null $link = null, boolean $active = false, string \| null $icon = null, string \| null $parent = '' ) : void	Append a link to the link bar
clearLinks ( ) : void	Removes all links from the link bar
getLinks ( ) : array	Get the link bar's link definitions
getRenderFrontendButtons ( ) : boolean	Return the front-end toolbar rendering flag
getRenderFrontendSubmenu ( ) : boolean	Return the front-end submenu rendering flag
isDataView ( ) : boolean	Is the view we are rendering the toolbar for a data-aware view?
onAdd ( ) : void	Renders the toolbar for the component's Add pages
onBrowse ( ) : void	Renders the toolbar for the component's Browse pages (the plural views)
onCpanelsBrowse ( ) : void	Renders the toolbar for the component's Control Panel page
onEdit ( ) : void	Renders the toolbar for the component's Edit pages
onRead ( ) : void	Renders the toolbar for the component's Read pages
prefixLink ( string $name, string \| null $link = null, boolean $active = false, string \| null $icon = null ) : void	Prefixes (some people erroneously call this "prepend" – there is no such word) a link to the link bar
renderSubmenu ( ) : void	Renders the submenu (toolbar links) for all detected views of this component
renderToolbar ( string $view = null, string $task = null ) : void	Renders the toolbar for the current view and task
setRenderFrontendButtons ( boolean $renderFrontendButtons )
setRenderFrontendSubmenu ( boolean $renderFrontendSubmenu )

Protected Methods

Method	Description
checkACL ( string $area ) : boolean	Checks if the current user has enough privileges for the requested ACL privilege of a custom toolbar button.
getMyViews ( ) : array	Automatically detects all views of the component
renderToolbarElements ( array $tasks ) : void	Simplified default rendering without any attributes.

Private Methods

Method	Description
renderFromConfig ( array $toolbar ) : void	Render the toolbar from the configuration.
renderToolbarElement ( string $type, mixed $value = null, array $attributes = [] ) : void	Render a toolbar element.

Method Details

__construct() public method

The $config array can contain the following optional values: renderFrontendButtons bool Should I render buttons in the front-end of the component? renderFrontendSubmenu bool Should I render the submenu in the front-end of the component? useConfigurationFile bool Should we use the configuration file (fof.xml) of the component?

public __construct ( Container $c, array $config = [] )
$c	FOF30\Container\Container	The container for the component
$config	array	The configuration overrides, see above

appendLink() public method

Append a link to the link bar

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

checkACL() protected method

Checks if the current user has enough privileges for the requested ACL privilege of a custom toolbar button.

protected checkACL ( string $area ) : boolean
$area	string	The ACL privilege as set up in the $this->perms object
return	boolean	True if the user has the ACL privilege specified

clearLinks() public method

Removes all links from the link bar

public clearLinks ( ) : void
return	void

getLinks() public method

Get the link bar's link definitions

public getLinks ( ) : array
return	array

getMyViews() protected method

Automatically detects all views of the component

protected getMyViews ( ) : array
return	array	A list of all views, in the order to be displayed in the toolbar submenu

getRenderFrontendButtons() public method

Return the front-end toolbar rendering flag

public getRenderFrontendButtons ( ) : boolean
return	boolean

getRenderFrontendSubmenu() public method

Return the front-end submenu rendering flag

public getRenderFrontendSubmenu ( ) : boolean
return	boolean

isDataView() public method

Is the view we are rendering the toolbar for a data-aware view?

public isDataView ( ) : boolean
return	boolean

onAdd() public method

Renders the toolbar for the component's Add pages

public onAdd ( ) : void
return	void

onBrowse() public method

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

public onBrowse ( ) : void
return	void

onCpanelsBrowse() public method

Renders the toolbar for the component's Control Panel page

public onCpanelsBrowse ( ) : void
return	void

onEdit() public method

Renders the toolbar for the component's Edit pages

public onEdit ( ) : void
return	void

onRead() public method

Renders the toolbar for the component's Read pages

public onRead ( ) : void
return	void

prefixLink() public method

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

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

renderSubmenu() public method

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

public renderSubmenu ( ) : void
return	void

renderToolbar() public method

Renders the toolbar for the current view and task

public renderToolbar ( string $view = null, string $task = null ) : void
$view	string	The view of the component
$task	string	The exact task of the view
return	void

renderToolbarElements() protected method

Simplified default rendering without any attributes.

protected renderToolbarElements ( array $tasks ) : void
$tasks	array	Array of tasks.
return	void

setRenderFrontendButtons() public method

public setRenderFrontendButtons ( boolean $renderFrontendButtons )
$renderFrontendButtons	boolean

setRenderFrontendSubmenu() public method

public setRenderFrontendSubmenu ( boolean $renderFrontendSubmenu )
$renderFrontendSubmenu	boolean

Property Details

$container protected_oe property

Component container

protected $container

$isDataView protected_oe property

Are we rendering a data-aware view?

protected $isDataView

$linkbar protected_oe property

The links to be rendered in the toolbar

protected $linkbar

$perms public_oe property

Permissions map, see the __construct method for more information

public $perms

$renderFrontendButtons protected_oe property

Should I render buttons in the front-end?

protected $renderFrontendButtons

$renderFrontendSubmenu protected_oe property

Should I render the submenu in the front-end?

protected $renderFrontendSubmenu

$useConfigurationFile protected_oe property

Should I use the configuration file (fof.xml) of the component?

protected $useConfigurationFile