class JHelp


Located at : UKNOWVA_ROOT/libraries/joomla/language/help.php

Help system class

Methods

static string
createURL(string $ref, boolean $useComponent = false, string $override = null, string $component = null)

Create a URL for a given help key reference

static array
createSiteList($pathToXml, $selected = null)

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

Details

at line 33
static string createURL(string $ref, boolean $useComponent = false, string $override = null, string $component = null)

Create a URL for a given help key reference

Parameters

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)

Return Value

string

at line 150
static array createSiteList($pathToXml, $selected = null)

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

Parameters

$pathToXml
$selected

Return Value

array An array of arrays (text, value, selected).