Back to Joomla project (class list)

Class StandardButton - list of methods

Renders a standard button

Extends

Direct known subclasses

Package: Joomla\CMS\Toolbar\Button
Copyright: (C) 2006 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
Located at: Joomla/Toolbar/Button/StandardButton.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 = 'Standard', mixed $name = '', mixed $text = '', mixed $task = '', mixed $list = true, mixed $formId = null)

Fetch the HTML for the button
Parameters
  • string $type Unused string.
  • string $name The name of the button icon class.
  • string $text Button text.
  • string $task Task associated with the button.
  • bool $list True to allow lists
  • string $formId The id of action form.
Returns
  • string HTML string for the button
Since
  • 3.0
Deprecated
  • 5.0
Show source code of this method: fetchButton Source Code

public string
(string $name)

Fetch button class for standard buttons.
Parameters
  • string $name The button name.
Returns
  • string
Since
  • 4.0.0
Show source code of this method: fetchButtonClass 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

Properties Summary

protected string
$layout
Property layout.
Since
  • 4.0.0

Tags Summary

Since
3.0