Joomla CMS  3.8.5 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.8.5 et du framework Joomla Platform intégré
Référence de la classe Toolbar

Fonctions membres publiques

 __construct ($name='toolbar')
 
 appendButton ()
 
 getItems ()
 
 getName ()
 
 prependButton ()
 
 render ()
 
 renderButton (&$node)
 
 loadButtonType ($type, $new=false)
 
 addButtonPath ($path)
 

Fonctions membres publiques statiques

static getInstance ($name='toolbar')
 

Attributs protégés

 $_name = array()
 
 $_bar = array()
 
 $_buttons = array()
 
 $_buttonPath = array()
 

Attributs protégés statiques

static $instances = array()
 

Fonctions membres privées

 loadButtonClass ($type)
 

Description détaillée

ToolBar handler

Depuis
1.5

Documentation des constructeurs et destructeur

◆ __construct()

__construct (   $name = 'toolbar')

Constructor

Paramètres
string$nameThe toolbar name.
Depuis
1.5

Références $name.

Documentation des fonctions membres

◆ 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$pathDirectory or directories to search.
Renvoie
void
Depuis
1.5

Références $path, et DIRECTORY_SEPARATOR.

◆ appendButton()

appendButton ( )

Set a value

Renvoie
string The set value.
Depuis
1.5

◆ getInstance()

static getInstance (   $name = 'toolbar')
static

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

Paramètres
string$nameThe name of the toolbar.
Renvoie
The JToolbar object.
Depuis
1.5

Références $name.

◆ 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

◆ loadButtonClass()

loadButtonClass (   $type)
private

Load the button class including the deprecated ones.

Paramètres
string$typeButton Type
Renvoie
string|null
Depuis
3.8.0

Références $type, et null.

◆ loadButtonType()

loadButtonType (   $type,
  $new = false 
)

Loads a button type.

Paramètres
string$typeButton Type
boolean$newFalse by default
Renvoie
boolean
Depuis
1.5

Références $file, $type, DIRECTORY_SEPARATOR, JPath\find(), et JLoader\import().

◆ prependButton()

prependButton ( )

Get a value.

Renvoie
string
Depuis
1.5

◆ render()

render ( )

Render a toolbar.

Renvoie
string HTML for the toolbar.
Depuis
1.5

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

◆ renderButton()

renderButton ( $node)

Render a button.

Paramètres
object&$nodeA toolbar node.
Renvoie
string
Depuis
1.5

Références $button, et $type.

Documentation des champs

◆ $_bar

$_bar = array()
protected

◆ $_buttonPath

$_buttonPath = array()
protected

◆ $_buttons

$_buttons = array()
protected

◆ $_name

$_name = array()
protected

◆ $instances

$instances = array()
staticprotected

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