JButtonConfirm

Extends \JButton

Renders 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) 
inherited
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
inherited deprecated
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(object $msg, string $name, string $task, boolean $list) : string
since

11.1

Arguments

$msg

objectThe message to display.

$name

stringNot used.

$task

stringThe task used by the application

$list

booleanTrue is requires a list confirmation.

Response

stringJavaScript command string

def

Sets a default value if not alreay assigned

def(string $property, mixed $default = null) : mixed
inherited
since

11.1

Arguments

$property

stringThe name of the property.

$default

mixedThe default value.

Response

mixed

fetchButton

Get the button

fetchButton() : string
inherited abstract

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
inherited

Can be redefined in the final class

since

11.1

Arguments

$identifier

stringIcon identification string

Response

stringCSS 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

stringButton type

$msg

objectThe message

$name

stringName to be used as apart of the id

$text

stringButton text

$task

stringThe task associated with the button

$list

booleanTrue to allow use of lists

$hideMenu

booleanTrue to hide the menu on click

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
inherited
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
inherited deprecated
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
inherited deprecated
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
inherited

Response

stringtype of the parameter

getProperties

Returns an associative array of object properties.

getProperties(boolean $public = true) : array
inherited
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
inherited

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
inherited
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
inherited deprecated
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
inherited
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
inherited deprecated
since

11.1

deprecated

12.1 Use magic method __toString()

see \JObject::__toString()

Response

string

Properties

_name

element name

inherited

This has to be set in the final renderer classes.

Type(s)

string

_parent

reference to the object that instantiated the element

inherited

Type(s)

\JButton

_errors

An array of error messages or Exception objects.

inherited deprecated
since

11.1

see \JError
deprecated

12.3 JError has been deprecated

Type(s)

array