JHelp
Help system class
| package |
Joomla.Platform |
|---|---|
| subpackage |
Language |
| since |
11.1 |
Methods
createSiteList
Builds a list of the help sites which can be used in a select option.
createSiteList(string $pathToXml, string $selected = null) : array
static
| since |
11.1 |
|---|
Arguments
- $pathToXml
stringPath to an XML file.- $selected
stringLanguage tag to select (if exists).
Response
arrayAn array of arrays (text, value, selected).
createURL
Create a URL for a given help key reference
createURL(string $ref, boolean $useComponent = false, string $override = null, string $component = null) : string
static
| since |
11.1 |
|---|
Arguments
- $ref
stringThe name of the help screen (its key reference)- $useComponent
booleanUse the help file in the component directory- $override
stringUse this URL instead of any other- $component
stringName of component (or null for current component)
Response
string