Class JHelp

Description

Help system class

  • since: 11.1

Located in /libraries/joomla/language/help.php (line 19)


	
			
Method Summary
static array createSiteList (string $pathToXml, [string $selected = null])
static string createURL (string $ref, [boolean $useComponent = false], [string $override = null], [string $component = null])
Methods
static method createSiteList (line 158)

Builds a list of the help sites which can be used in a select option.

  • return: An array of arrays (text, value, selected).
  • since: 11.1
  • access: public
static array createSiteList (string $pathToXml, [string $selected = null])
  • string $pathToXml: Path to an XML file.
  • string $selected: Language tag to select (if exists).
static method createURL (line 33)

Create a URL for a given help key reference

  • since: 11.1
  • access: public
static string createURL (string $ref, [boolean $useComponent = false], [string $override = null], [string $component = null])
  • string $ref: The name of the help screen (its key reference)
  • boolean $useComponent: Use the help file in the component directory
  • string $override: Use this URL instead of any other
  • string $component: Name of component (or null for current component)

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