Support Joomla!

Joomla! 1.5 Documentation

Packages

Package: Joomla-Framework

Developer Network License

The Joomla! Developer Network content is © copyright 2006 by the individual contributors and can be used in accordance with the Creative Commons License, Attribution- NonCommercial- ShareAlike 2.5

Class JHelp

Description
Description | Methods (details)

Help system class

  • since: 1.5

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

Class JHelp   (Subpackage I18N)
Method Summary
Description | Methods (details)
Method void createSiteList (string $pathToXml, [string $selected = null], array 2)
Method void createURL (string $ref, [boolean $useComponent = false])
Methods
Description | Methods (details)
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
Documentation generated on Mon, 05 Mar 2007 21:05:30 +0000 by phpDocumentor 1.3.1