Horde_Help
in package
The Horde_Help:: class provides an interface to the online help subsystem.
Copyright 1999-2017 Horde LLC (http://www.horde.org/)
See the enclosed file LICENSE for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.
Tags
Table of Contents
Constants
- SOURCE_FILE = 1
- SOURCE_RAW = 0
Properties
- $_xml : array<string|int, mixed>
- A list of DOM help entry nodes.
Methods
- __construct() : mixed
- Constructor.
- link() : string
- Generates the HTML link that will pop up a help window for the requested topic.
- lookup() : string
- Looks up the requested entry in the XML help buffer.
- search() : array<string|int, mixed>
- Returns a hash of all of the topics in this help buffer containing the keyword specified.
- topics() : array<string|int, mixed>
- Returns a hash of all of the topics in this help buffer.
- _processNode() : string
- Process a help node.
- _processXml() : mixed
Constants
SOURCE_FILE
public
mixed
SOURCE_FILE
= 1
SOURCE_RAW
public
mixed
SOURCE_RAW
= 0
Properties
$_xml
A list of DOM help entry nodes.
protected
array<string|int, mixed>
$_xml
= array()
Methods
__construct()
Constructor.
public
__construct(int $source, string $data[, array<string|int, mixed> $views = array() ]) : mixed
Parameters
- $source : int
-
The source of the XML help data, based on the SOURCE_* constants.
- $data : string
-
The data source. If $source is RAW, this is XML text. If $source is FILE, this is the XML filename.
- $views : array<string|int, mixed> = array()
-
Include these views.
Tags
link()
Generates the HTML link that will pop up a help window for the requested topic.
public
static link(string $module, string $topic) : string
Parameters
- $module : string
-
The name of the current Horde module.
- $topic : string
-
The help topic to be displayed.
Return values
string —The HTML to create the help link.
lookup()
Looks up the requested entry in the XML help buffer.
public
lookup(string $id) : string
Parameters
- $id : string
-
String containing the entry ID.
Return values
string —The HTML formatted help entry.
search()
Returns a hash of all of the topics in this help buffer containing the keyword specified.
public
search(string $keyword) : array<string|int, mixed>
Parameters
- $keyword : string
-
Search keyword.
Return values
array<string|int, mixed> —Hash of all of the search results.
topics()
Returns a hash of all of the topics in this help buffer.
public
topics() : array<string|int, mixed>
Return values
array<string|int, mixed> —Hash of all of the topics in this buffer (keys are IDs, values are the title names).
_processNode()
Process a help node.
protected
_processNode(DOMElement $node) : string
Parameters
- $node : DOMElement
-
A help node.
Return values
string —HTML string.
_processXml()
protected
_processXml(DOMElement $node, mixed $views) : mixed
Parameters
- $node : DOMElement
- $views : mixed