JButtonConfirm
Extends \JButtonRenders a standard button with a confirm dialog
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
mixed
Either 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
string
The classname.
_getCommand
Get the JavaScript command for the button
_getCommand(object $msg, string $name, string $task, boolean $list) : string
since |
11.1 |
---|
Arguments
- $msg
object
The message to display.- $name
string
Not used.- $task
string
The task used by the application- $list
boolean
True is requires a list confirmation.
Response
string
JavaScript command string
def
Sets a default value if not alreay assigned
def(string $property, mixed $default = null) : mixed
since |
11.1 |
---|
Arguments
- $property
string
The name of the property.- $default
mixed
The 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
string
Icon identification string
Response
string
CSS class name
fetchId
Get the button CSS Id
fetchId(string $type = 'Confirm', object $msg = '', string $name = '', string $text = '', string $task = '', boolean $list = true, boolean $hideMenu = false) : string
since |
11.1 |
---|
Arguments
- $type
string
Button type- $msg
object
The message- $name
string
Name to be used as apart of the id- $text
string
Button text- $task
string
The task associated with the button- $list
boolean
True to allow use of lists- $hideMenu
boolean
True to hide the menu on click
Response
string
Button 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
string
The name of the property.- $default
mixed
The default value.
Response
mixed
The 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
integer
Option error index.- $toString
boolean
Indicates if JError objects should return their error message.
Response
string
Error message
getErrors
Return all errors, if any.
getErrors() : array
since |
11.1 |
---|---|
see | \JError |
deprecated |
12.3 JError has been deprecated |
Response
array
Array of error messages or JErrors.
getName
Get the element name
getName() : string
Response
string
type of the parameter
getProperties
Returns an associative array of object properties.
getProperties(boolean $public = true) : array
since |
11.1 |
---|---|
see | \JObject::get() |
Arguments
- $public
boolean
If 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
string
The name of the property.- $value
mixed
The value of the property to set.
Response
mixed
Previous 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
string
Error message.
setProperties
Set the object properties based on a named array/hash.
setProperties(mixed $properties) : boolean
since |
11.1 |
---|---|
see | \JObject::set() |
Arguments
- $properties
mixed
Either 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.