HelpButton
Extends BasicButtonRenders 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
throws |
|
---|---|
since |
4.0.0 |
Arguments
- name
string
The method name.- args
array
The method arguments.
Response
mixed
__construct
Init this class.
__construct(string name = '', string text = '', array options = []) : mixed
since |
4.0.0 |
---|---|
throws |
|
Arguments
- name
string
Name of this button.- text
string
The button text, will auto translate.- options
array
Button options.
Response
mixed
_getCommand
Get the JavaScript command for the button
_getCommand() : string
since |
3.0 |
---|
Response
string
JavaScript command string
attributes
attributes(array value) : self
Arguments
- value
array
Response
self
buttonClass
buttonClass(string value) : self
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
since |
4.0.0 |
---|
Arguments
- id
string
The id string.
Response
string
fetchButton
Get the button
fetchButton() : string
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
Can be redefined in the final class
since |
3.0 |
---|
Arguments
- identifier
string
Icon identification string
Response
string
CSS class name
fetchId
Get the button CSS Id.
fetchId() : string
since |
3.0 |
---|
Response
string
Button CSS Id
findOptionName
Find field option name from accessors.
findOptionName(string name) : bool|string
since |
4.0.0 |
---|
Arguments
- name
string
The field name.
Response
bool|string
form
form(string value) : self
Arguments
- value
string
Response
self
formValidation
formValidation(bool value) : self
Arguments
- value
bool
Response
self
getAccessors
Method to configure available option accessors.
getAccessors() : array
since |
4.0.0 |
---|
Response
array
getAttributes
getAttributes() : array
Response
array
getButtonClass
getButtonClass() : string
Response
string
getComponent
getComponent() : string
Response
string
getForm
getForm() : string
Response
string
getFormValidation
getFormValidation() : bool
Response
bool
getIcon
getIcon() : string
Response
string
getLayout
Get layout path.
getLayout() : string
since |
4.0.0 |
---|
Response
string
getListCheck
getListCheck() : bool
Response
bool
getListCheckMessage
getListCheckMessage() : string
Response
string
getName
Get button name.
getName() : string
since |
4.0.0 |
---|
Response
string
getOnclick
getOnclick() : string
Response
string
getOption
Get single option value.
getOption(string name, mixed default = null) : mixed
since |
4.0.0 |
---|
Arguments
- name
string
The option name.- default
mixed
The default value if this name not exists.
Response
mixed
getOptions
Get button options.
getOptions() : array
since |
4.0.0 |
---|
Response
array
getParent
Get parent toolbar instance.
getParent() : \Joomla\CMS\Toolbar\Toolbar
since |
4.0.0 |
---|
Response
\Joomla\CMS\Toolbar\Toolbar
getRef
getRef() : string
Response
string
getTask
getTask() : string
Response
string
getText
getText() : string
Response
string
getUrl
getUrl() : string
Response
string
getUseComponent
getUseComponent() : bool
Response
bool
icon
icon(string value) : self
Arguments
- value
string
Response
self
layout
Set layout path.
layout(string layout) : static
since |
4.0.0 |
---|
Arguments
- layout
string
The layout path name to render.
Response
static
Return self to support chaining.
listCheck
listCheck(bool value) : self
Arguments
- value
bool
Response
self
listCheckMessage
listCheckMessage(string value) : self
Arguments
- value
string
Response
self
name
Set button name.
name(string name) : static
since |
4.0.0 |
---|
Arguments
- name
string
The button name.
Response
static
Return self to support chaining.
onclick
onclick(array value) : self
Arguments
- value
array
Response
self
prepareOptions
Prepare options for this button.
prepareOptions(array &options) : void
since |
4.0.0 |
---|
Arguments
- options
array
The 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
since |
3.0 |
---|---|
throws |
|
Arguments
- definition
array
Parameters to be passed
Response
string
renderButton
Render button HTML.
renderButton(array &options) : string
since |
4.0.0 |
---|
Arguments
- options
array
The button options.
Response
string
The button HTML.
setOption
Set option value.
setOption(string name, mixed value) : static
since |
4.0.0 |
---|
Arguments
- name
string
The option name to store value.- value
mixed
The option value.
Response
static
setOptions
Set all options.
setOptions(array options) : static
since |
4.0.0 |
---|
Arguments
- options
array
The button options.
Response
static
Return self to support chaining.
setParent
Set parent Toolbar instance.
setParent(\Joomla\CMS\Toolbar\Toolbar parent) : static
since |
4.0.0 |
---|
Arguments
- parent
\Joomla\CMS\Toolbar\Toolbar
The parent Toolbar instance to set.
Response
static
Return self to support chaining.
task
task(string value) : self
Arguments
- value
string
Response
self
text
text(string value) : self
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