PHP Class Horde_Help, horde

Copyright 1999-2016 Horde LLC (http://www.horde.org/) See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.
Author: Jon Parise ([email protected])
Exibir arquivo Open project: horde/horde Class Usage Examples

Protected Properties

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

Public Methods

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.

Protected Methods

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

Method Details

__construct() public method

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.

_processNode() protected method

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

_processXml() protected method

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

lookup() public method

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.

topics() public method

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).

Property Details

$_xml protected_oe property

A list of DOM help entry nodes.
protected array $_xml
return array