Class Horde_Help

The Horde_Help:: class provides an interface to the online help subsystem.

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Package: Core
Category: Horde
Author: Jon Parise jon@horde.org
Located at Horde/Help.php

Methods summary
`public`	# `__construct( integer $source, array $data = array() )` Constructor. Constructor. Parameters `$source` <p>The source of the XML help data, based on the SOURCE_* constants.</p> `$data` The list of data sources to use. Throws Horde_Exception
`public string`	# `lookup( string $id )` Looks up the requested entry in the XML help buffer. Looks up the requested entry in the XML help buffer. Parameters `$id` String containing the entry ID. Returns `string` The HTML formatted help entry.
`public array`	# `search( mixed $keyword )` Returns a hash of all of the topics in this help buffer containing the keyword specified. Returns a hash of all of the topics in this help buffer containing the keyword specified. Returns `array` Hash of all of the search results.
`public array`	# `topics( )` Returns a hash of all of the topics in this help buffer. 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).
`public static string`	# `link( string $module, string $topic )` Generates the HTML link that will pop up a help window for the requested topic. Generates the HTML link that will pop up a help window for the requested topic. Parameters `$module` The name of the current Horde module. `$topic` The help topic to be displayed. Returns `string` The HTML to create the help link.

Constants summary
`integer`	`SOURCE_RAW`	# `0`
`integer`	`SOURCE_FILE`	# `1`