Class JToolBar

Description

ToolBar handler

  • since: 11.1

Located in /libraries/joomla/html/toolbar.php (line 22)

JObject
   |
   --JToolBar
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 ()
object loadButtonType (string $type, [boolean $new = false])
string prependButton ()
string render ()
string renderButton (object &$node)
Variables
static JToolbar $instances = array() (line 74)

Stores the singleton instances of various toolbar.

  • since: 11.3
  • access: protected
array $_bar = array() (line 36)

Toolbar array

  • access: protected
array $_buttonPath = array() (line 50)

Directories, where button types can be stored.

  • access: protected
array $_buttons = array() (line 43)

Loaded buttons

  • access: protected
string $_name = array() (line 29)

Toolbar name

  • access: protected

Inherited Variables

Inherited from JObject

JObject::$_errors
Methods
static method getInstance (line 86)

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

  • return: The JToolBar object.
  • since: 11.1
  • access: public
static JToolBar getInstance ([string $name = 'toolbar'])
  • string $name: The name of the toolbar.
Constructor __construct (line 59)

Constructor

  • since: 11.1
  • access: public
JToolBar __construct ([string $name = 'toolbar'])
  • string $name: The toolbar name.

Redefinition of:
JObject::__construct()
Class constructor, overridden in descendant classes.
addButtonPath (line 279)

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: 11.1
  • access: public
void addButtonPath (mixed $path)
  • mixed $path: Directory or directories to search.
appendButton (line 103)

Set a value

  • return: The set value.
  • since: 11.1
  • access: public
string appendButton ()
getItems (line 118)

Get the list of toolbar links.

  • since: 11.1
  • access: public
array getItems ()
getName (line 130)

Get the name of the toolbar.

  • since: 11.1
  • access: public
string getName ()
loadButtonType (line 213)

Loads a button type.

  • since: 11.1
  • access: public
object loadButtonType (string $type, [boolean $new = false])
  • string $type: Button Type
  • boolean $new: False by default
prependButton (line 142)

Get a value.

  • since: 11.1
  • access: public
string prependButton ()
render (line 157)

Render a tool bar.

  • return: HTML for the toolbar.
  • since: 11.1
  • access: public
string render ()
renderButton (line 188)

Render a button.

  • since: 11.1
  • access: public
string renderButton (object &$node)
  • object &$node: A toolbar node.

Inherited Methods

Inherited From JObject

JObject::__construct()
JObject::def()
JObject::get()
JObject::getError()
JObject::getErrors()
JObject::getProperties()
JObject::set()
JObject::setError()
JObject::setProperties()
JObject::toString()
JObject::__toString()

Documentation generated on Mon, 25 Jun 2012 14:00:13 -0500 by phpDocumentor 1.4.4