1. class
  2. Joomla
  3. CMS
  4. Help
  5. Help

Help

class Help

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( string $pathToXml)

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

Details

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

static array createSiteList( string $pathToXml)

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

Parameters

string $pathToXml Path to an XML file.

Return Value

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