Joomla CMS  3.10.11 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.10.11 et du framework Joomla Platform intégré
Tout Structures de données Espaces de nommage Fichiers Fonctions Variables Pages
Référence de la classe HelpButton
+ Graphe d'héritage de HelpButton:

Fonctions membres publiques

 fetchButton ($type='Help', $ref='', $com=false, $override=null, $component=null)
 
 fetchId ()
 
- Fonctions membres publiques hérités de ToolbarButton
 __construct ($parent=null)
 
 getName ()
 
 render (&$definition)
 
 fetchIconClass ($identifier)
 
 fetchButton ()
 

Fonctions membres protégées

 _getCommand ($ref, $com, $override, $component)
 

Attributs protégés

 $_name = 'Help'
 
- Attributs protégés hérités de ToolbarButton
 $_name = null
 
 $_parent = null
 

Description détaillée

Renders a help popup window button

Depuis
3.0

Documentation des fonctions membres

◆ _getCommand()

_getCommand (   $ref,
  $com,
  $override,
  $component 
)
protected

Get the JavaScript command for the button

Paramètres
string$refThe name of the help screen (its key reference).
boolean$comUse the help file in the component directory.
string$overrideUse this URL instead of any other.
string$componentName of component to get Help (null for current component)
Renvoie
string JavaScript command string
Depuis
3.0

Références $component, $url, Help\createUrl(), ENT_QUOTES, htmlspecialchars, et json_encode.

◆ fetchButton()

fetchButton (   $type = 'Help',
  $ref = '',
  $com = false,
  $override = null,
  $component = null 
)

Fetches the button HTML code.

Paramètres
string$typeUnused string.
string$refThe name of the help screen (its key reference).
boolean$comUse the help file in the component directory.
string$overrideUse this URL instead of any other.
string$componentName of component to get Help (null for current component)
Renvoie
string
Depuis
3.0

Références $component, $layout, et $options.

◆ fetchId()

fetchId ( )

Get the button id

Redefined from JButton class

Renvoie
string Button CSS Id
Depuis
3.0

Documentation des champs

◆ $_name

$_name = 'Help'
protected

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