Joomla! 1.5 API

Packages

Package: Joomla-Framework

License

Content on this site is copyright © 2005 - 2011 Open Source Matters Inc and can be used in accordance with the Joomla! Electronic Documentation License. Some parts of this website may be subject to other licenses.

 Class JHelp

Description

Help system class

  • since: 1.5

Located in /joomla/language/help.php (line 22)

Class JHelp   (Subpackage Language)
Method Summary
Method void createSiteList (string $pathToXml, [string $selected = null], array 2)
Method void createURL (string $ref, [boolean $useComponent = false])
Methods
createSiteList (line 105)

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

void createSiteList (string $pathToXml, [string $selected = null], array 2)
  • array 2: An array of arrays ( text, value, selected )
  • string $pathToXml: Path to an xml file
  • string $selected: Language tag to select (if exists)
createURL (line 31)

Create an URL for a giving help file reference

void createURL (string $ref, [boolean $useComponent = false])
  • string $ref: The name of the popup file (excluding the file extension for an xml file)
  • boolean $useComponent: Use the help file in the component directory
Support Joomla!