Back to Joomla project (class list)

Class ConfirmButton - list of methods

Renders a standard button with a confirm dialog

Extends

Package: Joomla\CMS\Toolbar\Button
Copyright: (C) 2007 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
Located at: Joomla/Toolbar/Button/ConfirmButton.php
Project: Joomla

Method Summary

protected void
(array &$options)

Prepare options for this button.
Parameters
  • array $options The options about this button.
Returns
  • void
Since
  • 4.0.0
Show source code of this method: prepareOptions Source Code

public string
(mixed $type = 'Confirm', mixed $msg = '', mixed $name = '', mixed $text = '', mixed $task = '', mixed $list = true, mixed $hideMenu = false)

Fetch the HTML for the button
Parameters
  • 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
  • bool $list True to allow use of lists
  • bool $hideMenu True to hide the menu on click
Returns
  • string HTML string for the button
Since
  • 3.0
Deprecated
  • 5.0
Show source code of this method: fetchButton Source Code

protected string
()

Get the JavaScript command for the button
Returns
  • string JavaScript command string
Since
  • 3.0
Show source code of this method: _getCommand Source Code

protected static array
()

Method to configure available option accessors.
Returns
  • array
Since
  • 4.0.0
Show source code of this method: getAccessors Source Code

Tags Summary

public self
message (string $value)
public bool
getMessage ()
Since
3.0