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( name, mixed||string|int args) :
inherited
throws

LogicException
since

4.0.0

Arguments

name

stringThe method name.

args

array<string|int, mixed>The method arguments.

Response

mixed

__construct

Init this class.

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

4.0.0
throws

InvalidArgumentException

Arguments

name

stringName of this button.

text

stringThe button text, will auto translate.

options

array<string|int, mixed>Button options.

Response

mixed

_getCommand

Get the JavaScript command for the button

_getCommand() :
since

3.0

Response

stringJavaScript command string

attributes

attributes(mixed||string|int value) :
inherited

Arguments

value

array<string|int, mixed>

Response

self

buttonClass

buttonClass( value) :
inherited

Arguments

value

string

Response

self

component

component( value) :

Arguments

value

string

Response

self

ensureUniqueId

Make sure the id is unique

ensureUniqueId( id) :
inherited
since

4.0.0

Arguments

id

stringThe id string.

Response

string

fetchButton

Fetches the button HTML code.

fetchButton( type = 'Help',  ref = '',  com = false,  override = null,  component = null) :
deprecated
since

3.0
deprecated

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

Arguments

type

stringUnused string.

ref

stringThe name of the help screen (its key reference).

com

boolUse the help file in the component directory.

override

stringUse this URL instead of any other.

component

stringName of component to get Help (null for current component)

Response

string

fetchIconClass

Method to get the CSS class name for an icon identifier

fetchIconClass( identifier) :
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() :
inherited
since

3.0

Response

stringButton CSS Id

findOptionName

Find field option name from accessors.

findOptionName( name) : bool|string
inherited static
since

4.0.0

Arguments

name

stringThe field name.

Response

bool|string

form

form( value) :
inherited

Arguments

value

string

Response

self

formValidation

formValidation( value) :
inherited

Arguments

value

bool

Response

self

getAccessors

Method to configure available option accessors.

getAccessors() : mixed||string|int
static
since

4.0.0

Response

array<string|int, mixed>

getAttributes

getAttributes() : mixed||string|int
inherited

Response

array<string|int, mixed>

getButtonClass

getButtonClass() :
inherited

Response

string

getComponent

getComponent() :

Response

string

getForm

getForm() :
inherited

Response

string

getFormValidation

getFormValidation() :
inherited

Response

bool

getIcon

getIcon() :
inherited

Response

string

getLayout

Get layout path.

getLayout() :
inherited
since

4.0.0

Response

string

getListCheck

getListCheck() :
inherited

Response

bool

getListCheckMessage

getListCheckMessage() :
inherited

Response

string

getName

Get button name.

getName() :
inherited
since

4.0.0

Response

string

getOnclick

getOnclick() :
inherited

Response

string

getOption

Get single option value.

getOption( name,  default = null) :
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() : mixed||string|int
inherited
since

4.0.0

Response

array<string|int, mixed>

getParent

Get parent toolbar instance.

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

4.0.0

Response

Toolbar

getRef

getRef() :

Response

string

getTask

getTask() :
inherited

Response

string

getText

getText() :
inherited

Response

string

getUrl

getUrl() :

Response

string

getUseComponent

getUseComponent() :

Response

bool

icon

icon( value) :
inherited

Arguments

value

string

Response

self

layout

Set layout path.

layout( layout) :
inherited
since

4.0.0

Arguments

layout

stringThe layout path name to render.

Response

staticReturn self to support chaining.

listCheck

listCheck( value) :
inherited

Arguments

value

bool

Response

self

listCheckMessage

listCheckMessage( value) :
inherited

Arguments

value

string

Response

self

name

Set button name.

name( name) :
inherited
since

4.0.0

Arguments

name

stringThe button name.

Response

staticReturn self to support chaining.

onclick

onclick( value) :
inherited

Arguments

value

string

Response

self

prepareOptions

Prepare options for this button.

prepareOptions(mixed||string|int &options) :
since

4.0.0

Arguments

options

array<string|int, mixed>The options about this button.

Response

void

ref

ref( value) :

Arguments

value

string

Response

self

render

Get the HTML to render the button

render(mixed||string|int &definition = null) :
inherited
since

3.0
throws

Exception

Arguments

definition

array<string|int, mixed>Parameters to be passed

Response

string

renderButton

Render button HTML.

renderButton(mixed||string|int &options) :
inherited
since

4.0.0

Arguments

options

array<string|int, mixed>The button options.

Response

stringThe button HTML.

setOption

Set option value.

setOption( name,  value) :
inherited
since

4.0.0

Arguments

name

stringThe option name to store value.

value

mixedThe option value.

Response

static

setOptions

Set all options.

setOptions(mixed||string|int options) :
inherited
since

4.0.0

Arguments

options

array<string|int, mixed>The button options.

Response

staticReturn self to support chaining.

setParent

Set parent Toolbar instance.

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

4.0.0

Arguments

parent

ToolbarThe parent Toolbar instance to set.

Response

staticReturn self to support chaining.

task

task( value) :
inherited

Arguments

value

string

Response

self

text

text( value) :
inherited

Arguments

value

string

Response

self

url

url( value) :

Arguments

value

string

Response

self

useComponent

useComponent( value) :

Arguments

value

bool

Response

self

Properties

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

layout

Property layout.

inherited
since

4.0.0

Type(s)

string

options

Button options.

inherited
since

4.0.0

Type(s)

array<string|int, mixed>

idCounter

Used to track an ids, to avoid duplication

inherited static
since

4.0.0

Type(s)

array<string|int, mixed>
  • \ Joomla
  • \ CMS
  • \ Toolbar
  • \ Button
  • \ HelpButton