[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/libraries/src/Toolbar/Button/ -> HelpButton.php (summary)

Joomla! Content Management System

Copyright: (C) 2006 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
File Size: 117 lines (3 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

HelpButton:: (4 methods):
  prepareOptions()
  fetchButton()
  _getCommand()
  getAccessors()


Class: HelpButton  - X-Ref

Renders a help popup window button

prepareOptions(array &$options)   X-Ref
Prepare options for this button.

param: array  $options  The options about this button.
return: void

fetchButton($type = 'Help', $ref = '', $com = false, $override = null, $component = null)   X-Ref
Fetches the button HTML code.

param: string   $type       Unused string.
param: string   $ref        The name of the help screen (its key reference).
param: boolean  $com        Use the help file in the component directory.
param: string   $override   Use this URL instead of any other.
param: string   $component  Name of component to get Help (null for current component)
return: string

_getCommand()   X-Ref
Get the JavaScript command for the button

return: string  JavaScript command string

getAccessors()   X-Ref
Method to configure available option accessors.

return: array



Generated: Wed Sep 7 05:41:13 2022 Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer