1. class
  2. Joomla
  3. \
  4. CMS
  5. \
  6. Toolbar
  7. \
  8. Button
  9. \
  10. BasicButton

BasicButton

Since: 4.0.0

class BasicButton extends ToolbarButton

Renders a basic button.

Properties

protected string Since: 4.0.0
$name

Name of this button.

 from  ToolbarButton
protected Toolbar Since: 4.0.0
$parent

Reference to the object that instantiated the element

 from  ToolbarButton
protected string Since: 4.0.0
$layout

Property layout.
protected array Since: 4.0.0
$options

Button options.

 from  ToolbarButton
static protected array Since: 4.0.0
$idCounter

Used to track an ids, to avoid duplication

 from  ToolbarButton

Methods

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

Init this class.

from  ToolbarButton
void
prepareOptions(array $options)

Prepare options for this button.

from  ToolbarButton
string
render(array $definition = null)

Get the HTML to render the button

from  ToolbarButton
string
renderButton(array $options)

Render button HTML.

from  ToolbarButton
string
fetchId()

Get the button CSS Id.

from  ToolbarButton
string
fetchIconClass(string $identifier)

Method to get the CSS class name for an icon identifier

from  ToolbarButton
string
fetchButton(string $type = 'Basic') deprecated

Fetch the HTML for the button

Toolbar
getParent()

Get parent toolbar instance.

from  ToolbarButton
ToolbarButton
setParent(Toolbar $parent)

Set parent Toolbar instance.

from  ToolbarButton
array
getOptions()

Get button options.

from  ToolbarButton
ToolbarButton
setOptions(array $options)

Set all options.

from  ToolbarButton
mixed
getOption(string $name, mixed $default = null)

Get single option value.

from  ToolbarButton
ToolbarButton
setOption(string $name, mixed $value)

Set option value.

from  ToolbarButton
string
getName()

Get button name.

from  ToolbarButton
ToolbarButton
name(string $name)

Set button name.

from  ToolbarButton
string
getLayout()

Get layout path.

from  ToolbarButton
ToolbarButton
layout(string $layout)

Set layout path.

from  ToolbarButton
string
ensureUniqueId(string $id)

Make sure the id is unique

from  ToolbarButton
mixed
__call(string $name, array $args)

Magiix method to adapt option accessors.

from  ToolbarButton
static array
getAccessors()

Method to configure available option accessors.

from  ToolbarButton
self
text(string $value)

No description

from  ToolbarButton
self
task(string $value)

No description

from  ToolbarButton
self
icon(string $value)

No description

from  ToolbarButton
self
buttonClass(string $value)

No description

from  ToolbarButton
self
attributes(array $value)

No description

from  ToolbarButton
self
onclick(string $value)

No description

from  ToolbarButton
self
listCheck(bool $value)

No description

from  ToolbarButton
self
listCheckMessage(string $value)

No description

from  ToolbarButton
self
form(string $value)

No description

from  ToolbarButton
self
formValidation(bool $value)

No description

from  ToolbarButton
string
getText()

No description

from  ToolbarButton
string
getTask()

No description

from  ToolbarButton
string
getIcon()

No description

from  ToolbarButton
string
getButtonClass()

No description

from  ToolbarButton
array
getAttributes()

No description

from  ToolbarButton
string
getOnclick()

No description

from  ToolbarButton
bool
getListCheck()

No description

from  ToolbarButton
string
getListCheckMessage()

No description

from  ToolbarButton
string
getForm()

No description

from  ToolbarButton
bool
getFormValidation()

No description

from  ToolbarButton

Details

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

Since: 4.0.0

Init this class.

Parameters

string $name

Name of this button.
string $text

The button text, will auto translate.
array $options

Button options.

Exceptions

InvalidArgumentException

protected void prepareOptions(array $options)

Since: 4.0.0

Prepare options for this button.

Parameters

array $options

The options about this button.

Return Value

void

string render(array $definition = null)

Since: 3.0

Get the HTML to render the button

Parameters

array $definition

Parameters to be passed

Return Value

string

Exceptions

Exception

protected string renderButton(array $options)

Since: 4.0.0

Render button HTML.

Parameters

array $options

The button options.

Return Value

string

The button HTML.

protected string fetchId()

Since: 3.0

Get the button CSS Id.

Return Value

string

Button CSS Id

string fetchIconClass(string $identifier)

Since: 3.0

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 = 'Basic') deprecated

Since: 3.0

deprecated 4.3 will be removed in 6.0 Use render() instead.

Fetch the HTML for the button

Parameters

string $type

Unused string.

Return Value

string

Exceptions

LogicException

Toolbar getParent()

Since: 4.0.0

Get parent toolbar instance.

Return Value

Toolbar

ToolbarButton setParent(Toolbar $parent)

Since: 4.0.0

Set parent Toolbar instance.

Parameters

Toolbar $parent

The parent Toolbar instance to set.

Return Value

ToolbarButton

Return self to support chaining.

array getOptions()

Since: 4.0.0

Get button options.

Return Value

array

ToolbarButton setOptions(array $options)

Since: 4.0.0

Set all options.

Parameters

array $options

The button options.

Return Value

ToolbarButton

Return self to support chaining.

mixed getOption(string $name, mixed $default = null)

Since: 4.0.0

Get single option value.

Parameters

string $name

The option name.
mixed $default

The default value if this name not exists.

Return Value

mixed

ToolbarButton setOption(string $name, mixed $value)

Since: 4.0.0

Set option value.

Parameters

string $name

The option name to store value.
mixed $value

The option value.

Return Value

ToolbarButton

string getName()

Since: 4.0.0

Get button name.

Return Value

string

ToolbarButton name(string $name)

Since: 4.0.0

Set button name.

Parameters

string $name

The button name.

Return Value

ToolbarButton

Return self to support chaining.

string getLayout()

Since: 4.0.0

Get layout path.

Return Value

string

ToolbarButton layout(string $layout)

Since: 4.0.0

Set layout path.

Parameters

string $layout

The layout path name to render.

Return Value

ToolbarButton

Return self to support chaining.

protected string ensureUniqueId(string $id)

Since: 4.0.0

Make sure the id is unique

Parameters

string $id

The id string.

Return Value

string

mixed __call(string $name, array $args)

Since: 4.0.0

Magiix method to adapt option accessors.

Parameters

string $name

The method name.
array $args

The method arguments.

Return Value

mixed

Exceptions

LogicException

static protected array getAccessors()

Since: 4.0.0

Method to configure available option accessors.

Return Value

array

self text(string $value)

No description

Parameters

string $value

Return Value

self

self task(string $value)

No description

Parameters

string $value

Return Value

self

self icon(string $value)

No description

Parameters

string $value

Return Value

self

self buttonClass(string $value)

No description

Parameters

string $value

Return Value

self

self attributes(array $value)

No description

Parameters

array $value

Return Value

self

self onclick(string $value)

No description

Parameters

string $value

Return Value

self

self listCheck(bool $value)

No description

Parameters

bool $value

Return Value

self

self listCheckMessage(string $value)

No description

Parameters

string $value

Return Value

self

self form(string $value)

No description

Parameters

string $value

Return Value

self

self formValidation(bool $value)

No description

Parameters

bool $value

Return Value

self

string getText()

No description

Return Value

string

string getTask()

No description

Return Value

string

string getIcon()

No description

Return Value

string

string getButtonClass()

No description

Return Value

string

array getAttributes()

No description

Return Value

array

string getOnclick()

No description

Return Value

string

bool getListCheck()

No description

Return Value

bool

string getListCheckMessage()

No description

Return Value

string

string getForm()

No description

Return Value

string

bool getFormValidation()

No description

Return Value

bool