Class JButtonHelp

Description

Renders a help popup window button

  • since: 11.1

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

JObject
   |
   --JButton
      |
      --JButtonHelp
Variable Summary
string $_name
Method Summary
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
string $_name = 'Help' (line 24)
  • var: Button type
  • access: protected

Redefinition of:
JButton::$_name
element name

Inherited Variables

Inherited from JButton

JButton::$_parent

Inherited from JObject

JObject::$_errors
Methods
fetchButton (line 39)

Fetches the button HTML code.

  • since: 11.1
  • 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:
JButton::fetchButton()
Get the button
fetchId (line 63)

Get the button id

Redefined from JButton class

  • return: Button CSS Id
  • since: 11.1
  • access: public
string fetchId ()
_getCommand (line 80)

Get the JavaScript command for the button

  • return: JavaScript command string
  • since: 11.1
  • 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 JButton

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

Inherited From JObject

JObject::__construct()
JObject::def()
JObject::get()
JObject::getError()
JObject::getErrors()
JObject::getProperties()
JObject::set()
JObject::setError()
JObject::setProperties()
JObject::toString()
JObject::__toString()

Documentation generated on Mon, 25 Jun 2012 13:55:16 -0500 by phpDocumentor 1.4.4