Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Référence de la classe InlinehelpButton
+ Graphe d'héritage de InlinehelpButton:

Fonctions membres publiques

 fetchButton ( $type='Inlinehelp', string $targetClass='hide-aware-inline-help', string $text='JINLINEHELP', string $icon='fa fa-question-circle', string $buttonClass='btn btn-info')
 
- Fonctions membres publiques hérités de BasicButton
 fetchButton ($type='Basic')
 
- Fonctions membres publiques hérités de ToolbarButton
 __construct (string $name='', string $text='', array $options=[])
 
 render (&$definition=null)
 
 fetchIconClass ($identifier)
 
 fetchButton ()
 
 getParent ()
 
 setParent (Toolbar $parent)
 
 getOptions ()
 
 setOptions (array $options)
 
 getOption (string $name, $default=null)
 
 setOption (string $name, $value)
 
 getName ()
 
 name (string $name)
 
 getLayout ()
 
 layout (string $layout)
 
 __call (string $name, array $args)
 

Fonctions membres protégées

 prepareOptions (array &$options)
 
- Fonctions membres protégées hérités de ToolbarButton
 prepareOptions (array &$options)
 
 renderButton (array &$options)
 
 fetchId ()
 
 ensureUniqueId (string $id)
 

Fonctions membres protégées statiques

static getAccessors ()
 
- Fonctions membres protégées statiques hérités de ToolbarButton
static getAccessors ()
 

Attributs protégés

 $layout = 'joomla.toolbar.inlinehelp'
 
- Attributs protégés hérités de BasicButton
 $layout = 'joomla.toolbar.basic'
 
- Attributs protégés hérités de ToolbarButton
 $name
 
 $parent
 
 $layout
 
 $options = []
 

Membres hérités additionnels

- Attributs protégés statiques hérités de ToolbarButton
static $idCounter = []
 

Description détaillée

Renders a button to show / hide the inline help text

self targetclass(string $value) string getTargetclass()

Depuis
4.1.0

Documentation des fonctions membres

◆ fetchButton()

fetchButton (   $type = 'Inlinehelp',
string  $targetClass = 'hide-aware-inline-help',
string  $text = 'JINLINEHELP',
string  $icon = 'fa fa-question-circle',
string  $buttonClass = 'btn btn-info' 
)

Fetches the button HTML code.

Paramètres
string$typeUnused string.
string$targetClassThe class of the DIVs holding the descriptions to toggle.
string$textButton label
string$iconButton icon
string$buttonClassButton class
Renvoie
string
Depuis
4.1.0
Obsolète:
5.0 Use render() instead.

Références $buttonClass, $icon, $text, et name.

◆ getAccessors()

static getAccessors ( )
staticprotected

Method to configure available option accessors.

Renvoie
array
Depuis
4.1.0

◆ prepareOptions()

prepareOptions ( array &  $options)
protected

Prepare options for this button.

Paramètres
array$optionsThe options for this button.
Renvoie
void
Depuis
4.1.0

Références $options.

Documentation des champs

◆ $layout

$layout = 'joomla.toolbar.inlinehelp'
protected

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