Help
Help system class
since |
1.5 |
---|
Methods
createSiteList
Builds a list of the help sites which can be used in a select option.
createSiteList(string $pathToXml) : array
static
since |
1.5 |
---|
Arguments
- $pathToXml
string
Path to an XML file.
Response
array
An 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 |
1.5 |
---|
Arguments
- $ref
string
The name of the help screen (its key reference)- $useComponent
boolean
Use the help file in the component directory- $override
string
Use this URL instead of any other- $component
string
Name of component (or null for current component)
Response
string