JButtonHelp
Extends \JButtonRenders a help popup window button
The JButton is the base class for all JButton types
| package |
Joomla.Platform |
|---|---|
| subpackage |
HTML |
| since |
11.1 |
Methods
__construct
Class constructor, overridden in descendant classes.
__construct(mixed $properties = null)
| since |
11.1 |
|---|
Arguments
- $properties
mixedEither and associative array or another object to set the initial properties of the object.
__toString
Magic method to convert the object to a string gracefully.
__toString() : string
| since |
11.1 |
|---|---|
| deprecated |
12.3 Classes should provide their own __toString() implementation. |
Response
stringThe classname.
_getCommand
Get the JavaScript command for the button
_getCommand(string $ref, boolean $com, string $override, string $component) : string
| since |
11.1 |
|---|
Arguments
- $ref
stringThe name of the help screen (its key reference).- $com
booleanUse 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
stringJavaScript command string
def
Sets a default value if not alreay assigned
def(string $property, mixed $default = null) : mixed
| since |
11.1 |
|---|
Arguments
- $property
stringThe name of the property.- $default
mixedThe default value.
Response
mixed
fetchButton
Get the button
fetchButton() : string
Defined in the final button class
| since |
11.1 |
|---|
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 |
11.1 |
|---|
Arguments
- $identifier
stringIcon identification string
Response
stringCSS class name
fetchId
Get the button id
fetchId() : string
Redefined from JButton class
| since |
11.1 |
|---|
Response
stringButton CSS Id
get
Returns a property of the object or the default value if the property is not set.
get(string $property, mixed $default = null) : mixed
| since |
11.1 |
|---|---|
| see | \JObject::getProperties() |
Arguments
- $property
stringThe name of the property.- $default
mixedThe default value.
Response
mixedThe value of the property.
getError
Get the most recent error message.
getError(integer $i = null, boolean $toString = true) : string
| since |
11.1 |
|---|---|
| see | \JError |
| deprecated |
12.3 JError has been deprecated |
Arguments
- $i
integerOption error index.- $toString
booleanIndicates if JError objects should return their error message.
Response
stringError message
getErrors
Return all errors, if any.
getErrors() : array
| since |
11.1 |
|---|---|
| see | \JError |
| deprecated |
12.3 JError has been deprecated |
Response
arrayArray of error messages or JErrors.
getName
Get the element name
getName() : string
Response
stringtype of the parameter
getProperties
Returns an associative array of object properties.
getProperties(boolean $public = true) : array
| since |
11.1 |
|---|---|
| see | \JObject::get() |
Arguments
- $public
booleanIf true, returns only the public properties.
Response
array
render
Get the HTML to render the button
render( &$definition) : string
Arguments
- $definition
Response
string
set
Modifies a property of the object, creating it if it does not already exist.
set(string $property, mixed $value = null) : mixed
| since |
11.1 |
|---|
Arguments
- $property
stringThe name of the property.- $value
mixedThe value of the property to set.
Response
mixedPrevious value of the property.
setError
Add an error message.
setError(string $error) : void
| since |
11.1 |
|---|---|
| see | \JError |
| deprecated |
12.3 JError has been deprecated |
Arguments
- $error
stringError message.
setProperties
Set the object properties based on a named array/hash.
setProperties(mixed $properties) : boolean
| since |
11.1 |
|---|---|
| see | \JObject::set() |
Arguments
- $properties
mixedEither an associative array or another object.
Response
boolean
toString
Converts the object to a string (the class name).
toString() : string
Properties
_name
element name
This has to be set in the final renderer classes.
Type(s)
string
_errors
An array of error messages or Exception objects.