Joomla! API

Download
Launch

HelpButton

Extends BasicButton

Renders a help popup window button

since

3.0
package

Joomla CMS

Methods

__call

Magiix method to adapt option accessors.

__call(string name, array args) : mixed
inherited
throws

\LogicException
since

4.0.0

Arguments

name

stringThe method name.

args

arrayThe method arguments.

Response

mixed

__construct

Init this class.

__construct(string name = '', string text = '', array options = []) : mixed
inherited
since

4.0.0
throws

\InvalidArgumentException

Arguments

name

stringName of this button.

text

stringThe button text, will auto translate.

options

arrayButton options.

Response

mixed

_getCommand

Get the JavaScript command for the button

_getCommand() : string
since

3.0

Response

stringJavaScript command string

attributes

attributes(array value) : self
inherited

Arguments

value

array

Response

self

buttonClass

buttonClass(string value) : self
inherited

Arguments

value

string

Response

self

component

component(string value) : self

Arguments

value

string

Response

self

ensureUniqueId

Make sure the id is unique

ensureUniqueId(string id) : string
inherited
since

4.0.0

Arguments

id

stringThe id string.

Response

string

fetchButton

Get the button

fetchButton() : string
inherited abstract deprecated

Defined in the final button class

since

3.0
deprecated

5.0 Use render() instead.

Response

string

fetchIconClass

Method to get the CSS class name for an icon identifier

fetchIconClass(string identifier) : string
inherited

Can be redefined in the final class

since

3.0

Arguments

identifier

stringIcon identification string

Response

stringCSS class name

fetchId

Get the button CSS Id.

fetchId() : string
inherited
since

3.0

Response

stringButton CSS Id

findOptionName

Find field option name from accessors.

findOptionName(string name) : bool|string
inherited static
since

4.0.0

Arguments

name

stringThe field name.

Response

bool|string

form

form(string value) : self
inherited

Arguments

value

string

Response

self

formValidation

formValidation(bool value) : self
inherited

Arguments

value

bool

Response

self

getAccessors

Method to configure available option accessors.

getAccessors() : array
inherited static
since

4.0.0

Response

array

getAttributes

getAttributes() : array
inherited

Response

array

getButtonClass

getButtonClass() : string
inherited

Response

string

getComponent

getComponent() : string

Response

string

getForm

getForm() : string
inherited

Response

string

getFormValidation

getFormValidation() : bool
inherited

Response

bool

getIcon

getIcon() : string
inherited

Response

string

getLayout

Get layout path.

getLayout() : string
inherited
since

4.0.0

Response

string

getListCheck

getListCheck() : bool
inherited

Response

bool

getListCheckMessage

getListCheckMessage() : string
inherited

Response

string

getName

Get button name.

getName() : string
inherited
since

4.0.0

Response

string

getOnclick

getOnclick() : string
inherited

Response

string

getOption

Get single option value.

getOption(string name, mixed default = null) : mixed
inherited
since

4.0.0

Arguments

name

stringThe option name.

default

mixedThe default value if this name not exists.

Response

mixed

getOptions

Get button options.

getOptions() : array
inherited
since

4.0.0

Response

array

getParent

Get parent toolbar instance.

getParent() : \Joomla\CMS\Toolbar\Toolbar
inherited
since

4.0.0

Response

\Joomla\CMS\Toolbar\Toolbar

getRef

getRef() : string

Response

string

getTask

getTask() : string
inherited

Response

string

getText

getText() : string
inherited

Response

string

getUrl

getUrl() : string

Response

string

getUseComponent

getUseComponent() : bool

Response

bool

icon

icon(string value) : self
inherited

Arguments

value

string

Response

self

layout

Set layout path.

layout(string layout) : static
inherited
since

4.0.0

Arguments

layout

stringThe layout path name to render.

Response

staticReturn self to support chaining.

listCheck

listCheck(bool value) : self
inherited

Arguments

value

bool

Response

self

listCheckMessage

listCheckMessage(string value) : self
inherited

Arguments

value

string

Response

self

name

Set button name.

name(string name) : static
inherited
since

4.0.0

Arguments

name

stringThe button name.

Response

staticReturn self to support chaining.

onclick

onclick(array value) : self
inherited

Arguments

value

array

Response

self

prepareOptions

Prepare options for this button.

prepareOptions(array &options) : void
inherited
since

4.0.0

Arguments

options

arrayThe options about this button.

ref

ref(string value) : self

Arguments

value

string

Response

self

render

Get the HTML to render the button

render(array &definition = null) : string
inherited
since

3.0
throws

\Exception

Arguments

definition

arrayParameters to be passed

Response

string

renderButton

Render button HTML.

renderButton(array &options) : string
inherited
since

4.0.0

Arguments

options

arrayThe button options.

Response

stringThe button HTML.

setOption

Set option value.

setOption(string name, mixed value) : static
inherited
since

4.0.0

Arguments

name

stringThe option name to store value.

value

mixedThe option value.

Response

static

setOptions

Set all options.

setOptions(array options) : static
inherited
since

4.0.0

Arguments

options

arrayThe button options.

Response

staticReturn self to support chaining.

setParent

Set parent Toolbar instance.

setParent(\Joomla\CMS\Toolbar\Toolbar parent) : static
inherited
since

4.0.0

Arguments

parent

\Joomla\CMS\Toolbar\ToolbarThe parent Toolbar instance to set.

Response

staticReturn self to support chaining.

task

task(string value) : self
inherited

Arguments

value

string

Response

self

text

text(string value) : self
inherited

Arguments

value

string

Response

self

url

url(string value) : self

Arguments

value

string

Response

self

useComponent

useComponent(bool value) : self

Arguments

value

bool

Response

self

Properties

layout

The layout path to render this button.

inherited
since

4.0.0

Type(s)

string

name

Name of this button.

inherited
since

4.0.0

Type(s)

string

parent

Reference to the object that instantiated the element

inherited
since

4.0.0

Type(s)

Toolbar

options

Button options.

inherited
since

4.0.0

Type(s)

array

idCounter

Used to track an ids, to avoid duplication

inherited static
since

4.0.0

Type(s)

array
  • \ Joomla
  • \ CMS
  • \ Toolbar
  • \ Button
  • \ HelpButton