Class Help

Description

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

Copyright 1999-2009 The Horde Project (http://www.horde.org/)

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.

Located in /Horde/Horde/Help.php (line 30)


	
			
Variable Summary
 string $_buffer
 string $_charset
 string $_curEntry
 array $_entries
 array $_handlers
 boolean $_inBlock
 boolean $_inHeading
 boolean $_inHelp
 boolean $_inTitle
 string $_keyword
 string $_output
 resource $_parser
 string $_reqEntry
 array $_search
Method Summary
 Help Help (integer $source, [string $arg = null])
 void display ()
 string link (string $module, string $topic)
 void lookup (string $entry)
 array search ( $keyword)
 array topics ()
Variables
string $_buffer = '' (line 44)

String buffer to hold the XML help source.

string $_charset = 'iso-8859-1' (line 107)

String containing the charset of the XML data source.

string $_curEntry = '' (line 58)

String containing the ID of the current help entry.

array $_entries = array() (line 100)

Hash containing an index of all of the help entries.

array $_handlers = array(
'help' => '_helpHandler',
'entry' => '_entryHandler',
'title' => '_titleHandler',
'heading' => '_headingHandler',
'para' => '_paraHandler',
'ref' => '_refHandler',
'eref' => '_erefHandler',
'href' => '_hrefHandler',
'b' => '_bHandler',
'i' => '_iHandler',
'pre' => '_preHandler',
'tip' => '_tipHandler',
'warn' => '_warnHandler'
)
(line 114)

Hash of user-defined function handlers for the XML elements.

boolean $_inBlock = false (line 79)

Boolean indicating whether we're inside the requested block.

boolean $_inHeading = false (line 93)

Boolean indicating whether we're inside a heading block.

boolean $_inHelp = false (line 72)

Boolean indicating whether we're inside a <help> block.

boolean $_inTitle = false (line 86)

Boolean indicating whether we're inside a <title> block.

string $_keyword = "" (line 142)

String containing the keyword for the search.

string $_output = '' (line 65)

String containing the formatted output.

resource $_parser = 0 (line 37)

Handle for the XML parser object.

string $_reqEntry = '' (line 51)

String containing the ID of the requested help entry.

array $_search = array() (line 135)

Hash containing an index of all of the search results.

Methods
Constructor Help (line 152)

Constructor

Help Help (integer $source, [string $arg = null])
  • integer $source: The source of the XML help data, based on the HELP_SOURCE_* constants.
  • string $arg: Source-dependent argument for this Help instance.
display (line 253)

Display the contents of the formatted output buffer.

void display ()
link (line 189)

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

  • return: The HTML to create the help link.
string link (string $module, string $topic)
  • string $module: The name of the current Horde module.
  • string $topic: The help topic to be displayed.
lookup (line 214)

Looks up the requested entry in the XML help buffer.

void lookup (string $entry)
  • string $entry: String containing the entry ID.
search (line 228)

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

  • return: Hash of all of the search results.
array search ( $keyword)
  • $keyword
topics (line 242)

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

  • return: Hash of all of the topics in this buffer.
array topics ()

Documentation generated on Sun, 30 Jan 2011 05:17:58 +0000 by phpDocumentor 1.4.3