Docs For Class JToolbar

Description

ToolBar handler

since: 1.5

Located in /libraries/cms/toolbar/toolbar.php (line 19)

Variable Summary

static JToolbar $instances

array $_bar

array $_buttonPath

array $_buttons

string $_name

Method Summary

static JToolbar getInstance ([string $name = 'toolbar'])

JToolbar __construct ([string $name = 'toolbar'])

void addButtonPath (mixed $path)

string appendButton ()

array getItems ()

string getName ()

boolean loadButtonType (string $type, [boolean $new = false])

string prependButton ()

string render ()

string renderButton (object &$node)

Variables

static JToolbar $instances = array() (line 55)

Stores the singleton instances of various toolbar.

since: 2.5
access: protected

array $_bar = array() (line 33)

Toolbar array

access: protected

array $_buttonPath = array() (line 47)

Directories, where button types can be stored.

access: protected

array $_buttons = array() (line 40)

Loaded buttons

access: protected

string $_name = array() (line 26)

Toolbar name

access: protected

Methods

static getInstance (line 83)

Returns the global JToolbar object, only creating it if it doesn't already exist.

return: The JToolbar object.
since: 1.5
access: public

static JToolbar getInstance ([string $name = 'toolbar'])

string $name: The name of the toolbar.

Constructor __construct (line 64)

Constructor

since: 1.5
access: public

JToolbar __construct ([string $name = 'toolbar'])

string $name: The toolbar name.

addButtonPath (line 283)

Add a directory where JToolbar should search for button types in LIFO order.

You may either pass a string or an array of directories.

JToolbar will be searching for an element type in the same order you added them. If the parameter type cannot be found in the custom folders, it will look in libraries/joomla/html/toolbar/button.

see: JToolbar
since: boolean
access: public

void addButtonPath (mixed $path)

mixed $path: Directory or directories to search.

appendButton (line 100)

Set a value

return: The set value.
since: 1.5
access: public

string appendButton ()

getItems (line 115)

Get the list of toolbar links.

since: 1.6
access: public

array getItems ()

getName (line 127)

Get the name of the toolbar.

since: 1.6
access: public

string getName ()

loadButtonType (line 211)

Loads a button type.

since: 1.5
access: public

boolean loadButtonType (string $type, [boolean $new = false])

string $type: Button Type
boolean $new: False by default

prependButton (line 139)

Get a value.

since: 1.5
access: public

string prependButton ()

render (line 154)

Render a tool bar.

return: HTML for the toolbar.
since: 1.5
access: public

string render ()

renderButton (line 186)

Render a button.

since: 1.5
access: public

string renderButton (object &$node)

object &$node: A toolbar node.