Référence de la classe ActionButton

Graphe d'héritage de ActionButton:

Fonctions membres publiques
	__construct (array $options=[])
	addState (int $value, string $task, string $icon='ok', string $title='', array $options=[])
	getState (int $value)
	removeState (int $value)
	render (?int $value=null, ?int $row=null, array $options=[])
	__toString ()
	getLayout ()
	setLayout (string $layout)
	getOptions ()
	setOptions (array $options)
	getOption (string $name, $default=null)
	setOption (string $name, $value)
	fetchIconClass (string $identifier)

Fonctions membres protégées
	preprocess ()

Attributs protégés
	$states = []
	$unknownState
	$options
	$layout = 'joomla.button.action-button'

Description détaillée

The TaskButton class.

Depuis

4.0.0

Documentation des constructeurs et destructeur

__construct()

__construct

(

array

$options = []

)

ActionButton constructor.

Paramètres

array

$options

The options for all buttons in this group.

Depuis

4.0.0

Références $options, et Text\_().

Documentation des fonctions membres

__toString()

__toString

(

)

Render to string.

Renvoie

string

Depuis

4.0.0

addState()

addState	(	int	$value,
		string	$task,
		string	$icon = 'ok',
		string	$title = '',
		array	$options = []
	)

Add a state profile.

Paramètres

integer	$value	The value of this state.
string	$task	The task you want to execute after click this button.
string	$icon	The icon to display for user.
string	$title	Title text will show if we enable tooltips.
array	$options	The button options, will override group options.

Renvoie

static Return self to support chaining.

Depuis

4.0.0

Références $icon, $options, $task, $this, $title, et $value.

fetchIconClass()

fetchIconClass

(

string

$identifier

)

Method to get the CSS class name for an icon identifier.

Can be redefined in the final class.

Paramètres

string

$identifier

Icon identification string.

Renvoie

string CSS class name.

Depuis

4.0.0

Références $layout.

getLayout()

getLayout

(

)

Method to get property layout.

Renvoie

string

Depuis

4.0.0

Références $layout.

getOption()

getOption	(	string	$name,
			$default = null
	)

Get an option value.

Paramètres

string	$name	The option name.
mixed	$default	Default value if not exists.

Renvoie

mixed Return option value or default value.

Depuis

4.0.0

Références $default, et $name.

getOptions()

getOptions

(

)

Method to get property options.

Renvoie

array

Depuis

4.0.0

getState()

getState

(

int

$value

)

Get state profile by value name.

Paramètres

integer

$value

The value name we want to get.

Renvoie

array|null Return state profile or NULL.

Depuis

4.0.0

Références $value, et null.

preprocess()

preprocess ( )

protected

Configure this object.

Renvoie

void

Depuis

4.0.0

removeState()

removeState

(

int

$value

)

Remove a state by value name.

Paramètres

integer

$value

Remove state by this value.

Renvoie

static Return to support chaining.

Depuis

4.0.0

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

render()

render	(	?int	$value = null,
		?int	$row = null,
		array	$options = []
	)

Render action button by item value.

Paramètres

integer | null	$value	Current value of this item.
integer | null	$row	The row number of this item.
array	$options	The options to override group options.

Renvoie

string Rendered HTML.

Depuis

4.0.0

Exceptions

Références $data, $options, $value, Joomla\CMS\MVC\Model\getState(), ArrayHelper\mergeRecursive(), et LayoutHelper\render().

setLayout()

setLayout

(

string

$layout

)

Method to set property template.

Paramètres

string

$layout

The layout path.

Renvoie

static Return self to support chaining.

Depuis

4.0.0

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

setOption()

setOption	(	string	$name,
			$value
	)

Set option value.

Paramètres

string	$name	The option name.
mixed	$value	The option value.

Renvoie

static Return self to support chaining.

Depuis

4.0.0

Références $name, $this, et $value.

setOptions()

setOptions

(

array

$options

)

Method to set property options.

Paramètres

array

$options

The options of this button group.

Renvoie

static Return self to support chaining.

Depuis

4.0.0

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

Documentation des champs

$layout

$layout = 'joomla.button.action-button'

protected

$options

$options

protected

$states

$states = []

protected

$unknownState

$unknownState

protected

Valeur initiale :

= [
        'value'   => null

---

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

• ActionButton.php