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

CustomButton

class CustomButton extends ToolbarButton

Renders a custom 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 = 'Custom', string $html = '', string $id = 'custom')

Fetch the HTML for the button

string
fetchId( string $type = 'Custom', string $html = '', string $id = 'custom')

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 = 'Custom', string $html = '', string $id = 'custom')

Fetch the HTML for the button

Parameters

string $type Button type, unused string.
string $html HTML strng for the button
string $id CSS id for the button

Return Value

string

string fetchId( string $type = 'Custom', string $html = '', string $id = 'custom')

Get the button CSS Id

Parameters

string $type Not used.
string $html Not used.
string $id The id prefix for the button.

Return Value

string Button CSS Id