1. class
  2. Joomla
  3. CMS
  4. Toolbar
  5. Button
  6. StandardButton

StandardButton

class StandardButton extends ToolbarButton

Renders a standard button

Methods

__construct( object $parent = null)

Constructor

from ToolbarButton
string
getName()

Get the element name

from ToolbarButton
string
render( array $definition)

Get the HTML to render the button

from ToolbarButton
string
fetchIconClass( string $identifier)

Method to get the CSS class name for an icon identifier

from ToolbarButton
string
fetchButton( string $type = 'Standard', string $name = '', string $text = '', string $task = '', boolean $list = true)

Fetch the HTML for the button

string
fetchId( string $type = 'Standard', string $name = '', string $text = '', string $task = '', boolean $list = true, boolean $hideMenu = false)

Get the button CSS Id

Details

__construct( object $parent = null)

Constructor

Parameters

object $parent The parent

string getName()

Get the element name

Return Value

string type of the parameter

string render( array $definition)

Get the HTML to render the button

Parameters

array $definition &$definition Parameters to be passed

Return Value

string

string fetchIconClass( string $identifier)

Method to get the CSS class name for an icon identifier

Can be redefined in the final class

Parameters

string $identifier Icon identification string

Return Value

string CSS class name

string fetchButton( string $type = 'Standard', string $name = '', string $text = '', string $task = '', boolean $list = true)

Fetch the HTML for the button

Parameters

string $type Unused string.
string $name The name of the button icon class.
string $text Button text.
string $task Task associated with the button.
boolean $list True to allow lists

Return Value

string

string fetchId( string $type = 'Standard', string $name = '', string $text = '', string $task = '', boolean $list = true, boolean $hideMenu = false)

Get the button CSS Id

Parameters

string $type Unused string.
string $name Name to be used as apart of the id
string $text Button text
string $task The task associated with the button
boolean $list True to allow use of lists
boolean $hideMenu True to hide the menu on click

Return Value

string Button CSS Id