Class JHelp

Help system class

Package: Joomla\Libraries\Help
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE.txt
Since: 1.5
Located at cms/help/help.php

Methods summary

`public static string`	# `createUrl( string $ref, boolean $useComponent = false, string $override = null, string $component = null )` Create a URL for a given help key reference Create a URL for a given help key reference Parameters `$ref` `string` - $ref The name of the help screen (its key reference) `$useComponent` `boolean` - $useComponent Use the help file in the component directory `$override` `string` - $override Use this URL instead of any other `$component` `string` - $component Name of component (or null for current component) Returns `string` Since 1.5
`public static array`	# `createSiteList( string $pathToXml )` Builds a list of the help sites which can be used in a select option. Builds a list of the help sites which can be used in a select option. Parameters `$pathToXml` `string` - $pathToXml Path to an XML file. Returns `array` - An array of arrays (text, value, selected). Since 1.5