API Documentation
\

\Horde_Help

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.

Summary

Methods
Properties
Constants
__construct()
lookup()
search()
topics()
link()
No public properties found
SOURCE_RAW
SOURCE_FILE
_processXml()
_processNode()
$_xml
N/A
No private methods found
No private properties found
N/A

Constants

SOURCE_RAW

SOURCE_RAW

SOURCE_FILE

SOURCE_FILE

Properties

$_xml

$_xml : array

A list of DOM help entry nodes.

Type

array

Methods

__construct()

__construct(integer  $source, string  $data, array  $views = array())

Constructor.

Parameters

integer $source

The source of the XML help data, based on the SOURCE_* constants.
string $data

The data source. If $source is RAW, this is XML text. If $source is FILE, this is the XML filename.
array $views

Include these views.

Throws

\Exception
\Horde_Exception

lookup()

lookup(string  $id) : string

Looks up the requested entry in the XML help buffer.

Parameters

string $id

String containing the entry ID.

Returns

string —

The HTML formatted help entry.

search()

search(string  $keyword) : array

Returns a hash of all of the topics in this help buffer containing the keyword specified.

Parameters

string $keyword

Search keyword.

Returns

array —

Hash of all of the search results.

topics()

topics() : array

Returns a hash of all of the topics in this help buffer.

Returns

array —

Hash of all of the topics in this buffer (keys are IDs, values are the title names).

link()

link(string  $module, string  $topic) : string

Generates the HTML link that will pop up a help window for the requested topic.

Parameters

string $module

The name of the current Horde module.
string $topic

The help topic to be displayed.

Returns

string —

The HTML to create the help link.

_processXml()

_processXml(\DOMElement  $node,   $views)

Parameters

\DOMElement $node
$views

_processNode()

_processNode(\DOMElement  $node) : string

Process a help node.

Parameters

\DOMElement $node

A help node.

Returns

string —

HTML string.