Class JToolbarButtonHelp

Description
Description | Vars (details) | Methods (details)

Renders a help popup window button

  • since: 3.0

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

JToolbarButton
   |
   --JToolbarButtonHelp
Variable Summary
Description | Vars (details) | Methods (details)
string $_name
Method Summary
Description | Vars (details) | Methods (details)
string fetchButton ([string $type = 'Help'], [string $ref = ''], [boolean $com = false], [string $override = null], [string $component = null])
string fetchId ()
string _getCommand (string $ref, boolean $com, string $override, string $component)
Variables
Description | Vars (details) | Methods (details)
string $_name = 'Help' (line 24)
  • var: Button type
  • access: protected
Redefinition of:
JToolbarButton::$_name
element name

Inherited Variables

Inherited from JToolbarButton

JToolbarButton::$_parent
Methods
Description | Vars (details) Methods (details)
fetchButton (line 39)

Fetches the button HTML code.

  • since: 3.0
  • access: public
string fetchButton ([string $type = 'Help'], [string $ref = ''], [boolean $com = false], [string $override = null], [string $component = null])
  • string $type: Unused string.
  • string $ref: The name of the help screen (its key reference).
  • boolean $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)
Redefinition of:
JToolbarButton::fetchButton()
Get the button
fetchId (line 61)

Get the button id

Redefined from JButton class

  • return: Button CSS Id
  • since: 3.0
  • access: public
string fetchId ()
_getCommand (line 78)

Get the JavaScript command for the button

  • return: JavaScript command string
  • since: 3.0
  • access: protected
string _getCommand (string $ref, boolean $com, string $override, string $component)
  • string $ref: The name of the help screen (its key reference).
  • boolean $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)

Inherited Methods

Inherited From JToolbarButton

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

Documentation generated on Tue, 19 Nov 2013 15:04:14 +0100 by phpDocumentor 1.4.3