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)
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)
	_getCommand ()
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 ()

Membres hérités additionnels
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 = []
Attributs protégés statiques hérités de ToolbarButton
static	$idCounter = []

Description détaillée

Renders a help popup window button

self ref(string $value) self component(string $value) self useComponent(bool $value) self url(string $value) string getRef() string getComponent() bool getUseComponent() string getUrl()

Depuis

3.0

Documentation des fonctions membres

_getCommand()

_getCommand ( )

protected

Get the JavaScript command for the button

Renvoie

string JavaScript command string

Depuis

3.0

Références $url, Text\_(), Help\createUrl(), et ENT_QUOTES.

fetchButton()

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

Fetches the button HTML code.

Paramètres

string	$type	Unused string.
string	$ref	The name of the help screen (its key reference).
boolean	$com	Use the help file in the component directory.
string	$override	Use this URL instead of any other.
string	$component	Name of component to get Help (null for current component)

Renvoie

string

Depuis

3.0

Obsolète:

5.0 Use render() instead.

Références $component, et name.

getAccessors()

static getAccessors ( )

staticprotected

Method to configure available option accessors.

Renvoie

array

Depuis

4.0.0

prepareOptions()

prepareOptions ( array &  $options )

protected

Prepare options for this button.

Paramètres

array

$options

The options about this button.

Renvoie

void

Depuis

4.0.0

Références $options.

---

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

• HelpButton.php