Search

Projects

Classes

Methods

⇦ Back to Joomla project (class list)

Class HelpButton - list of methods

Renders a help popup window button

Extends

BasicButton
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/HelpButton.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 = 'Help', mixed $ref = '', mixed $com = false, mixed $override = null, mixed $component = null)

Fetches the button HTML code.
Parameters
  • string $type Unused string.
  • string $ref The name of the help screen (its key reference).
  • bool $com Use the help file in the component directory.
  • string $override Use this URL instead of any other.
  • string $component Name of component to get Help (null for current component)
Returns
  • string
Since
  • 3.0
Deprecated
  • 5.0
Show source code of this method: fetchButton Source Code

protected string
_getCommand
()

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
ref (string $value)
public self
component (string $value)
public self
useComponent (bool $value)
public self
url (string $value)
public string
getRef ()
public string
getComponent ()
public bool
getUseComponent ()
public string
getUrl ()
Since
3.0