Joomla! API

Download
Launch

JToolBar

Extends \JObject

ToolBar handler

This class allows for simple but smart objects with get and set methods and an internal error handler.

package

Joomla.Platform
subpackage

HTML
since

11.1

Methods

__construct

Class constructor, overridden in descendant classes.

__construct(mixed $properties = null)
inherited
since

11.1

Arguments

$properties

mixedEither and associative array or another object to set the initial properties of the object.

__toString

Magic method to convert the object to a string gracefully.

__toString() : string
inherited deprecated
since

11.1
deprecated

12.3 Classes should provide their own __toString() implementation.

Response

stringThe classname.

addButtonPath

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

addButtonPath(mixed $path) : void

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.

since

11.1
see \JToolbar

Arguments

$path

mixedDirectory or directories to search.

appendButton

Set a value

appendButton() : string
since

11.1

Response

stringThe set value.

def

Sets a default value if not alreay assigned

def(string $property, mixed $default = null) : mixed
inherited
since

11.1

Arguments

$property

stringThe name of the property.

$default

mixedThe default value.

Response

mixed

get

Returns a property of the object or the default value if the property is not set.

get(string $property, mixed $default = null) : mixed
inherited
since

11.1
see \JObject::getProperties()

Arguments

$property

stringThe name of the property.

$default

mixedThe default value.

Response

mixedThe value of the property.

getError

Get the most recent error message.

getError(integer $i = null, boolean $toString = true) : string
inherited deprecated
since

11.1
see \JError
deprecated

12.3 JError has been deprecated

Arguments

$i

integerOption error index.

$toString

booleanIndicates if JError objects should return their error message.

Response

stringError message

getErrors

Return all errors, if any.

getErrors() : array
inherited deprecated
since

11.1
see \JError
deprecated

12.3 JError has been deprecated

Response

arrayArray of error messages or JErrors.

getInstance

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

getInstance(string $name = 'toolbar') : \JToolBar
static
since

11.1

Arguments

$name

stringThe name of the toolbar.

Response

\JToolBarThe JToolBar object.

getItems

Get the list of toolbar links.

getItems() : array
since

11.1

Response

array

getName

Get the name of the toolbar.

getName() : string
since

11.1

Response

string

getProperties

Returns an associative array of object properties.

getProperties(boolean $public = true) : array
inherited
since

11.1
see \JObject::get()

Arguments

$public

booleanIf true, returns only the public properties.

Response

array

loadButtonType

Loads a button type.

loadButtonType(string $type, boolean $new = false) : object
since

11.1

Arguments

$type

stringButton Type

$new

booleanFalse by default

Response

object

prependButton

Get a value.

prependButton() : string
since

11.1

Response

string

render

Render a tool bar.

render() : string
since

11.1

Response

stringHTML for the toolbar.

renderButton

Render a button.

renderButton( &$node) : string
since

11.1

Arguments

$node

Response

string

set

Modifies a property of the object, creating it if it does not already exist.

set(string $property, mixed $value = null) : mixed
inherited
since

11.1

Arguments

$property

stringThe name of the property.

$value

mixedThe value of the property to set.

Response

mixedPrevious value of the property.

setError

Add an error message.

setError(string $error) : void
inherited deprecated
since

11.1
see \JError
deprecated

12.3 JError has been deprecated

Arguments

$error

stringError message.

setProperties

Set the object properties based on a named array/hash.

setProperties(mixed $properties) : boolean
inherited
since

11.1
see \JObject::set()

Arguments

$properties

mixedEither an associative array or another object.

Response

boolean

toString

Converts the object to a string (the class name).

toString() : string
inherited deprecated
since

11.1
deprecated

12.1 Use magic method __toString()
see \JObject::__toString()

Response

string

Properties

_name

Toolbar name

Type(s)

string

_bar

Toolbar array

Type(s)

array

_buttons

Loaded buttons

Type(s)

array

_buttonPath

Directories, where button types can be stored.

Type(s)

array

instances

Stores the singleton instances of various toolbar.

static
since

11.3

Type(s)

\JToolbar

_errors

An array of error messages or Exception objects.

inherited deprecated
since

11.1
see \JError
deprecated

12.3 JError has been deprecated

Type(s)

array
  • \ \
  • \ JToolBar