Référence de la classe Toolbar

Fonctions membres publiques
	__construct ($name='toolbar', ToolbarFactoryInterface $factory=null)
	setFactory (ToolbarFactoryInterface $factory)
	appendButton ($button,... $args)
	getItems ()
	setItems (array $items)
	getName ()
	prependButton ($button,... $args)
	render (array $options=[])
	renderButton (&$node)
	loadButtonType ($type, $new=false)
	addButtonPath ($path)
	getButtonPath ()
	createChild ($name)
	__call ($name, $args)

Fonctions membres publiques statiques
static	getInstance ($name='toolbar')

Attributs protégés
	$_name = ''
	$_bar = []
	$_buttonPath = []
	$factory

Attributs protégés statiques
static	$instances = array()

Description détaillée

ToolBar handler

StandardButton standardButton(string $name = '', string $text = '', string $task = '') SeparatorButton separatorButton(string $name = '', string $text = '', string $task = '') PopupButton popupButton(string $name = '', string $text = '', string $task = '') LinkButton linkButton(string $name = '', string $text = '', string $task = '') HelpButton helpButton(string $name = '', string $text = '', string $task = '') InlinehelpButton inlinehelpButton(string $name = '', string $text = '', string $task = '') CustomButton customButton(string $name = '', string $text = '', string $task = '') ConfirmButton confirmButton(string $name = '', string $text = '', string $task = '') BasicButton basicButton(string $name = '', string $text = '', string $task = '') DropdownButton dropdownButton(string $name = '', string $text = '', string $task = '')

Depuis

1.5

Documentation des constructeurs et destructeur

__construct()

__construct	(		$name = 'toolbar',
		ToolbarFactoryInterface	$factory = null
	)

Constructor

Paramètres

string	$name	The toolbar name.
ToolbarFactoryInterface	$factory	The toolbar factory.

Depuis

1.5

Références $name, $this, __DIR__, class, et Factory\getContainer().

Documentation des fonctions membres

__call()

__call	(		$name,
			$args
	)

Magic method proxy.

Paramètres

string	$name	The method name.
array	$args	The method arguments.

Renvoie

ToolbarButton

Exceptions

Références $button, $name, $this, $type, et class.

addButtonPath()

addButtonPath

(

$path

)

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

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

Toolbar 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.

Paramètres

mixed

$path

Directory or directories to search.

Renvoie

void

Depuis

1.5

Obsolète:

5.0 ToolbarButton classes should be autoloaded

Références $dir, $path, et class.

appendButton()

appendButton	(		$button,
			$args
	)

Append a button to toolbar.

Paramètres

ToolbarButton	$button	The button instance.
array	$args	The more arguments.

Renvoie

ToolbarButton|boolean Return button instance to help chaining configure. If using legacy arguments returns true

Depuis

1.5

Références $button, $this, et class.

createChild()

createChild

(

$name

)

Create child toolbar.

Paramètres

string

$name

The toolbar name.

Renvoie

static

Depuis

4.0.0

Références $name.

getButtonPath()

getButtonPath

(

)

Get the lookup paths for button objects

Renvoie

array

Depuis

4.0.0

Obsolète:

5.0 ToolbarButton classes should be autoloaded

Références class.

getInstance()

static getInstance (   $name = 'toolbar' )

static

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

Paramètres

string

$name

The name of the toolbar.

Renvoie

Toolbar The Toolbar object.

Depuis

1.5

Obsolète:

5.0 Use the ToolbarFactoryInterface instead

Exceptions

Références $name, class, et Factory\getContainer().

Référencé par ToolbarHelper\addNew(), HtmlView\addToolbar(), ListView\addToolbar(), ToolbarHelper\apply(), ToolbarHelper\archiveList(), ToolbarHelper\assign(), ToolbarHelper\back(), ToolbarHelper\cancel(), ToolbarHelper\checkin(), ToolbarHelper\custom(), ToolbarHelper\deleteList(), ToolbarHelper\divider(), ToolbarHelper\editCss(), ToolbarHelper\editHtml(), ToolbarHelper\editList(), ToolbarHelper\help(), ToolbarHelper\inlinehelp(), ToolbarHelper\jooa11y(), ToolbarHelper\link(), ToolbarHelper\makeDefault(), ToolbarHelper\media_manager(), ToolbarHelper\modal(), ToolbarHelper\preferences(), HtmlView\prepareToolbar(), ToolbarHelper\preview(), ToolbarHelper\publish(), ToolbarHelper\publishList(), ToolbarHelper\save(), ToolbarHelper\save2copy(), ToolbarHelper\save2new(), ToolbarHelper\saveGroup(), ToolbarHelper\spacer(), HtmlView\toolbar(), ToolbarHelper\trash(), ToolbarHelper\unarchiveList(), ToolbarHelper\unpublish(), et ToolbarHelper\unpublishList().

getItems()

getItems

(

)

Get the list of toolbar links.

Renvoie

array

Depuis

1.6

getName()

getName

(

)

Get the name of the toolbar.

Renvoie

string

Depuis

1.6

loadButtonType()

loadButtonType	(		$type,
			$new = false
	)

Loads a button type.

Paramètres

string	$type	Button Type
boolean	$new	False by default

Renvoie

false|ToolbarButton

Depuis

1.5

Références $this, $type, Log\add(), et Log\WARNING.

prependButton()

prependButton	(		$button,
			$args
	)

Prepend a button to toolbar.

Paramètres

ToolbarButton	$button	The button instance.
array	$args	The more arguments.

Renvoie

ToolbarButton|boolean Return button instance to help chaining configure. If using legacy arguments returns true

Depuis

1.5

Références $button, $this, et class.

render()

render

(

array

$options = []

)

Render a toolbar.

Paramètres

array

$options

The options of toolbar.

Renvoie

string HTML for the toolbar.

Exceptions

Références $button, $html, $i, $layout, et $options.

renderButton()

renderButton

(

&

$node

)

Render a button.

Paramètres

array

&$node

A toolbar node.

Renvoie

string

Depuis

1.5

Exceptions

Références $button, $this, $type, et Text\sprintf().

setFactory()

setFactory

(

ToolbarFactoryInterface

$factory

)

Set the factory instance

Paramètres

ToolbarFactoryInterface

$factory

The factory instance

Renvoie

$this

Depuis

4.0.0

Références $this.

setItems()

setItems

(

array

$items

)

Set the button list.

Paramètres

ToolbarButton[]

$items The button list array.

Renvoie

static

Depuis

4.0.0

Références $items, et $this.

Documentation des champs

$_bar

$_bar = []

protected

$_buttonPath

$_buttonPath = []

protected

$_name

$_name = ''

protected

$factory

$factory

protected

$instances

$instances = array()

staticprotected

---

La documentation de cette classe a été générée à partir du fichier suivant :

• Toolbar/Toolbar.php