Docs For Class JToolbarButtonConfirm

Description

Renders a standard button with a confirm dialog

since: 3.0

Located in /libraries/cms/toolbar/button/confirm.php (line 19)

JToolbarButton
   |
   --JToolbarButtonConfirm

Variable Summary

string $_name

Method Summary

string fetchButton ([string $type = 'Confirm'], [string $msg = ''], [string $name = ''], [string $text = ''], [string $task = ''], [boolean $list = true], [boolean $hideMenu = false])

string fetchId ([string $type = 'Confirm'], [string $name = ''], [string $text = ''], [string $task = ''], [boolean $list = true], [boolean $hideMenu = false])

string _getCommand (object $msg, string $name, string $task, boolean $list)

Variables

string $_name = 'Confirm' (line 26)

Button type

access: protected

Redefinition of:

JToolbarButton::$_name: element name

Inherited Variables

Inherited from JToolbarButton

JToolbarButton::$_parent

Methods

fetchButton (line 43)

Fetch the HTML for the button

return: HTML string for the button
since: 3.0
access: public

string fetchButton ([string $type = 'Confirm'], [string $msg = ''], [string $name = ''], [string $text = ''], [string $task = ''], [boolean $list = true], [boolean $hideMenu = false])

string $type: Unused string.
string $msg: Message to render
string $name: Name to be used as apart of the id
string $text: Button text
string $task: The task associated with the button
boolean $list: True to allow use of lists
boolean $hideMenu: True to hide the menu on click

Redefinition of:

JToolbarButton::fetchButton(): Get the button

fetchId (line 72)

Get the button CSS Id

return: Button CSS Id
since: 3.0
access: public

string fetchId ([string $type = 'Confirm'], [string $name = ''], [string $text = ''], [string $task = ''], [boolean $list = true], [boolean $hideMenu = false])

string $type: Button type
string $name: Name to be used as apart of the id
string $text: Button text
string $task: The task associated with the button
boolean $list: True to allow use of lists
boolean $hideMenu: True to hide the menu on click

_getCommand (line 89)

Get the JavaScript command for the button

return: JavaScript command string
since: 3.0
access: protected

string _getCommand (object $msg, string $name, string $task, boolean $list)

object $msg: The message to display.
string $name: Not used.
string $task: The task used by the application
boolean $list: True is requires a list confirmation.

Inherited Methods

Inherited From JToolbarButton

JToolbarButton::__construct()
JToolbarButton::fetchButton()
JToolbarButton::fetchIconClass()
JToolbarButton::getName()
JToolbarButton::render()