Référence de la classe Help

Fonctions membres publiques statiques
static	createUrl ($ref, $useComponent=false, $override=null, $component=null)
static	createSiteList ($pathToXml)

Description détaillée

Help system class

Depuis

1.5

Documentation des fonctions membres

createSiteList()

static createSiteList (   $pathToXml )

static

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

Paramètres

string

$pathToXml

Path to an XML file.

Renvoie

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

Depuis

1.5

Références $list, $option, et $xml.

createUrl()

static createUrl (   $ref,   $useComponent = false,   $override = null,   $component = null  )

static

Create a URL for a given help key reference

Paramètres

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)

Renvoie

string

Depuis

1.5

Références $app, $component, $lang, $params, $url, $version, Text\_(), Factory\getApplication(), ApplicationHelper\getComponentName(), Factory\getLanguage(), ComponentHelper\getParams(), JPATH_BASE, et null.

Référencé par HelpButton\_getCommand(), et HelpModel\getPage().

---

La documentation de cette classe a été générée à partir du fichier suivant :

• Help.php