Référence de la classe ToolbarButton

Graphe d'héritage de ToolbarButton:

Fonctions membres publiques
	__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)
	renderButton (array &$options)
	fetchId ()
	ensureUniqueId (string $id)

Fonctions membres protégées statiques
static	getAccessors ()

Attributs protégés
	$name
	$parent
	$layout
	$options = []

Attributs protégés statiques
static	$idCounter = []

Fonctions membres privées statiques
static	findOptionName (string $name)

Description détaillée

The ToolbarButton class.

self text(string $value) self task(string $value) self icon(string $value) self buttonClass(string $value) self attributes(array $value) self onclick(array $value) self listCheck(bool $value) self listCheckMessage(string $value) self form(string $value) self formValidation(bool $value) string getText() string getTask() string getIcon() string getButtonClass() array getAttributes() string getOnclick() bool getListCheck() string getListCheckMessage() string getForm() bool getFormValidation()

Depuis

4.0.0

Documentation des constructeurs et destructeur

__construct()

__construct	(	string	$name = '',
		string	$text = '',
		array	$options = []
	)

Init this class.

Paramètres

string	$name	Name of this button.
string	$text	The button text, will auto translate.
array	$options	Button options.

Depuis

4.0.0

Exceptions

Références $name, $options, $text, ArrayHelper\mergeRecursive(), et name.

Documentation des fonctions membres

__call()

__call	(	string	$name,
		array	$args
	)

Magiix method to adapt option accessors.

Paramètres

string	$name	The method name.
array	$args	The method arguments.

Renvoie

mixed

Exceptions

Références $name.

ensureUniqueId()

ensureUniqueId ( string  $id )

protected

Make sure the id is unique

Paramètres

string

$id

The id string.

Renvoie

string

Depuis

4.0.0

Références $id.

fetchButton()

fetchButton ( )

abstract

Get the button

Defined in the final button class

Renvoie

string

Depuis

3.0

Obsolète:

5.0 Use render() instead.

fetchIconClass()

fetchIconClass

(

$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

3.0

Références $layout.

fetchId()

fetchId ( )

protected

Get the button CSS Id.

Renvoie

string Button CSS Id

Depuis

3.0

Références parent.

findOptionName()

static findOptionName ( string  $name )

staticprivate

Find field option name from accessors.

Paramètres

string

$name

The field name.

Renvoie

boolean|string

Depuis

4.0.0

Références $name.

getAccessors()

static getAccessors ( )

staticprotected

Method to configure available option accessors.

Renvoie

array

Depuis

4.0.0

getLayout()

getLayout

(

)

Get layout path.

Renvoie

string

Depuis

4.0.0

Références $layout.

getName()

getName

(

)

Get button name.

Renvoie

string

Depuis

4.0.0

Références $name.

getOption()

getOption	(	string	$name,
			$default = null
	)

Get single option value.

Paramètres

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

Renvoie

mixed

Depuis

4.0.0

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

getOptions()

getOptions

(

)

Get button options.

Renvoie

array

Depuis

4.0.0

Références $options.

getParent()

getParent

(

)

Get parent toolbar instance.

Renvoie

Toolbar

Depuis

4.0.0

layout()

layout

(

string

$layout

)

Set layout path.

Paramètres

string

$layout

The layout path name to render.

Renvoie

static Return self to support chaining.

Depuis

4.0.0

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

name()

name

(

string

$name

)

Set button name.

Paramètres

string

$name

The button name.

Renvoie

static Return self to support chaining.

Depuis

4.0.0

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

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, et Text\_().

render()

render

(

&

$definition = null

)

Get the HTML to render the button

Paramètres

array

&$definition

Parameters to be passed

Renvoie

string

Depuis

3.0

Exceptions

Références $layout, elseif, et null.

renderButton()

renderButton ( array &  $options )

protected

Render button HTML.

Paramètres

array

&$options

The button options.

Renvoie

string The button HTML.

Depuis

4.0.0

Références $buttonClass, $layout, $options, et ArrayHelper\toString().

setOption()

setOption	(	string	$name,
			$value
	)

Set option value.

Paramètres

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

Renvoie

static

Depuis

4.0.0

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

setOptions()

setOptions

(

array

$options

)

Set all options.

Paramètres

array

$options

The button options.

Renvoie

static Return self to support chaining.

Depuis

4.0.0

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

setParent()

setParent

(

Toolbar

$parent

)

Set parent Toolbar instance.

Paramètres

Toolbar

$parent

The parent Toolbar instance to set.

Renvoie

static Return self to support chaining.

Depuis

4.0.0

Références $this, et parent.

Documentation des champs

$idCounter

$idCounter = []

staticprotected

$layout

$layout

protected

$name

$name

protected

$options

$options = []

protected

$parent

$parent

protected

---

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

• ToolbarButton.php