HelpButton
Extends BasicButtonRenders 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) :
throws |
|
---|---|
since |
4.0.0 |
Arguments
- name
string
The method name.- args
array<string|int, mixed>
The method arguments.
Response
mixed
__construct
Init this class.
__construct( name = '', text = '', mixed||string|int options = []) :
since |
4.0.0 |
---|---|
throws |
|
Arguments
- name
string
Name of this button.- text
string
The 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
string
JavaScript command string
attributes
attributes(mixed||string|int value) :
Arguments
- value
array<string|int, mixed>
Response
self
buttonClass
buttonClass( value) :
Arguments
- value
string
Response
self
component
component( value) :
Arguments
- value
string
Response
self
ensureUniqueId
Make sure the id is unique
ensureUniqueId( id) :
since |
4.0.0 |
---|
Arguments
- id
string
The id string.
Response
string
fetchButton
Fetches the button HTML code.
fetchButton( type = 'Help', ref = '', com = false, override = null, component = null) :
since |
3.0 |
---|---|
deprecated |
4.3 will be removed in 6.0 Use render() instead. |
Arguments
- type
string
Unused string.- ref
string
The name of the help screen (its key reference).- com
bool
Use the help file in the component directory.- override
string
Use this URL instead of any other.- component
string
Name 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) :
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() :
since |
3.0 |
---|
Response
string
Button CSS Id
findOptionName
Find field option name from accessors.
findOptionName( name) : bool|string
since |
4.0.0 |
---|
Arguments
- name
string
The field name.
Response
bool|string
form
form( value) :
Arguments
- value
string
Response
self
formValidation
formValidation( value) :
Arguments
- value
bool
Response
self
getAccessors
Method to configure available option accessors.
getAccessors() : mixed||string|int
since |
4.0.0 |
---|
Response
array<string|int, mixed>
getAttributes
getAttributes() : mixed||string|int
Response
array<string|int, mixed>
getButtonClass
getButtonClass() :
Response
string
getComponent
getComponent() :
Response
string
getForm
getForm() :
Response
string
getFormValidation
getFormValidation() :
Response
bool
getIcon
getIcon() :
Response
string
getLayout
Get layout path.
getLayout() :
since |
4.0.0 |
---|
Response
string
getListCheck
getListCheck() :
Response
bool
getListCheckMessage
getListCheckMessage() :
Response
string
getName
Get button name.
getName() :
since |
4.0.0 |
---|
Response
string
getOnclick
getOnclick() :
Response
string
getOption
Get single option value.
getOption( name, default = null) :
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() : mixed||string|int
since |
4.0.0 |
---|
Response
array<string|int, mixed>
getParent
Get parent toolbar instance.
getParent() : \Joomla\CMS\Toolbar\Toolbar
getRef
getRef() :
Response
string
getTask
getTask() :
Response
string
getText
getText() :
Response
string
getUrl
getUrl() :
Response
string
getUseComponent
getUseComponent() :
Response
bool
icon
icon( value) :
Arguments
- value
string
Response
self
layout
Set layout path.
layout( layout) :
since |
4.0.0 |
---|
Arguments
- layout
string
The layout path name to render.
Response
static
Return self to support chaining.
listCheck
listCheck( value) :
Arguments
- value
bool
Response
self
listCheckMessage
listCheckMessage( value) :
Arguments
- value
string
Response
self
name
Set button name.
name( name) :
since |
4.0.0 |
---|
Arguments
- name
string
The button name.
Response
static
Return self to support chaining.
onclick
onclick( value) :
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) :
since |
3.0 |
---|---|
throws |
|
Arguments
- definition
array<string|int, mixed>
Parameters to be passed
Response
string
renderButton
Render button HTML.
renderButton(mixed||string|int &options) :
since |
4.0.0 |
---|
Arguments
- options
array<string|int, mixed>
The button options.
Response
string
The button HTML.
setOption
Set option value.
setOption( name, value) :
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(mixed||string|int options) :
since |
4.0.0 |
---|
Arguments
- options
array<string|int, mixed>
The button options.
Response
static
Return self to support chaining.
setParent
Set parent Toolbar instance.
setParent(\Joomla\CMS\Toolbar\Toolbar parent) :
since |
4.0.0 |
---|
Arguments
- parent
Toolbar
The parent Toolbar instance to set.
Response
static
Return self to support chaining.
task
task( value) :
Arguments
- value
string
Response
self
text
text( value) :
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.
since |
4.0.0 |
---|
Type(s)
string
layout
Property layout.
since |
4.0.0 |
---|
Type(s)
string
options
Button options.
since |
4.0.0 |
---|
Type(s)
array<string|int, mixed>
idCounter
Used to track an ids, to avoid duplication
since |
4.0.0 |
---|
Type(s)
array<string|int, mixed>