PHP Class Horde_Help, horde

Author: Jon Parise ([email protected])

Protected Properties

Property	Type	Description
$_xml	array	A list of DOM help entry nodes.

Method	Description
__construct ( integer $source, string $data, array $views = [] )	Constructor.
link ( string $module, string $topic ) : string	Generates the HTML link that will pop up a help window for the requested topic.
lookup ( string $id ) : string	Looks up the requested entry in the XML help buffer.
search ( string $keyword ) : array	Returns a hash of all of the topics in this help buffer containing the keyword specified.
topics ( ) : array	Returns a hash of all of the topics in this help buffer.

Method	Description
_processNode ( DOMElement $node ) : string	Process a help node.
_processXml ( DOMElement $node, $views )

Constructor.

public __construct ( integer $source, string $data, array $views = [] )
$source	integer	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	Include these views.

Process a help node.

protected _processNode ( DOMElement $node ) : string
$node	DOMElement	A help node.
return	string	HTML string.

protected _processXml ( DOMElement $node, $views )
$node	DOMElement

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

public static link ( string $module, string $topic ) : string
$module	string	The name of the current Horde module.
$topic	string	The help topic to be displayed.
return	string	The HTML to create the help link.

Looks up the requested entry in the XML help buffer.

public lookup ( string $id ) : string
$id	string	String containing the entry ID.
return	string	The HTML formatted help entry.

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

public search ( string $keyword ) : array
$keyword	string	Search keyword.
return	array	Hash of all of the search results.

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

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

A list of DOM help entry nodes.

protected array $_xml
return	array