[ Index ]
 

Code source de Horde 3.1.3

Accédez au Source d'autres logiciels libresSoutenez Angelica Josefina !

title

Body

[fermer]

/lib/Horde/ -> Help.php (sommaire)

Raw help in the string.

Poids: 544 lignes (16 kb)
Inclus ou requis:0 fois
Référencé: 0 fois
Nécessite: 0 fichiers

Définit 1 class

Help:: (23 méthodes):
  Help()
  link()
  cleanup()
  lookup()
  topics()
  display()
  _init()
  _startElement()
  _endElement()
  _defaultHandler()
  _helpHandler()
  _entryHandler()
  _titleHandler()
  _headingHandler()
  _paraHandler()
  _refHandler()
  _erefHandler()
  _hrefHandler()
  _bHandler()
  _iHandler()
  _preHandler()
  _tipHandler()
  _warnHandler()


Classe: Help  - X-Ref

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

$Horde: framework/Horde/Horde/Help.php,v 1.68.8.18 2006/03/02 05:27:35 slusarz Exp $

Copyright 1999-2006 Jon Parise <jon@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.

Help($source, $arg = null)   X-Ref
Constructor

param: integer $source  The source of the XML help data, based on the
param: string $arg      Source-dependent argument for this Help

link($module, $topic)   X-Ref
Generates the HTML link that will pop up a help window for the
requested topic.

param: string $module  The name of the current Horde module.
param: string $topic   The help topic to be displayed.
return: string  The HTML to create the help link.

cleanup()   X-Ref
Cleans up the Help class resources.

return: boolean  Returns true on success, false on failure.

lookup($entry)   X-Ref
Looks up the requested entry in the XML help buffer.

param: string $entry  String containing the entry ID.

topics()   X-Ref
Returns a hash of all of the topics in this help buffer.

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

display()   X-Ref
Display the contents of the formatted output buffer.


_init()   X-Ref
Initialzes the XML parser.

return: boolean  Returns true on success, false on failure.

_startElement($parser, $name, $attrs)   X-Ref
User-defined function callback for start elements.

param: object $parser  Handle to the parser instance.
param: string $name    The name of this XML element.
param: array $attrs    List of this element's attributes.

_endElement($parser, $name)   X-Ref
User-defined function callback for end elements.

param: object $parser  Handle to the parser instance.
param: string $name    The name of this XML element.

_defaultHandler($parser, $data)   X-Ref
User-defined function callback for character data.

param: object $parser  Handle to the parser instance.
param: string $data    String of character data.

_helpHandler($startTag, $attrs = array()   X-Ref
XML element handler for the <help> tag.

param: boolean $startTag  Boolean indicating whether this instance is a
param: array $attrs       Additional element attributes (Not used).

_entryHandler($startTag, $attrs = array()   X-Ref
XML element handler for the <entry> tag.
Attributes: id

param: boolean $startTag  Boolean indicating whether this instance is a
param: array $attrs       Additional element attributes.

_titleHandler($startTag, $attrs = array()   X-Ref
XML element handler for the <title> tag.

param: boolean $startTag  Boolean indicating whether this instance is a
param: array $attrs       Additional element attributes (Not used).

_headingHandler($startTag, $attrs = array()   X-Ref
XML element handler for the <heading> tag.

param: boolean $startTag  Boolean indicating whether this instance is a
param: array $attrs      Additional element attributes (Not used).

_paraHandler($startTag, $attrs = array()   X-Ref
XML element handler for the <para> tag.

param: boolean $startTag  Boolean indicating whether this instance is a
param: array $attrs       Additional element attributes (Not used).

_refHandler($startTag, $attrs = array()   X-Ref
XML element handler for the <ref> tag.
Required attributes: ENTRY, MODULE

param: boolean $startTag  Boolean indicating whether this instance is a
param: array $attrs       Additional element attributes.

_erefHandler($startTag, $attrs = array()   X-Ref
XML element handler for the <eref> tag.
Required elements: URL

param: boolean $startTag  Boolean indicating whether this instance is a
param: array $attrs       Additional element attributes.

_hrefHandler($startTag, $attrs = array()   X-Ref
XML element handler for the <href> tag.
Required elements: url, app.

param: boolean $startTag  Boolean indicating whether this instance is a
param: array $attrs       Additional element attributes.

_bHandler($startTag, $attrs = array()   X-Ref
XML element handler for the &lt;b&gt; tag.

param: boolean $startTag  Boolean indicating whether this instance is a
param: array $attrs       Additional element attributes (Not used).

_iHandler($startTag, $attrs = array()   X-Ref
XML element handler for the &lt;i&gt; tag.

param: boolean $startTag  Boolean indicating whether this instance is a
param: array $attrs       Additional element attributes.

_preHandler($startTag, $attrs = array()   X-Ref
XML element handler for the &lt;pre&gt; tag.

param: boolean $startTag  Boolean indicating whether this instance is a
param: array $attrs       Additional element attributes.

_tipHandler($startTag, $attrs = array()   X-Ref
XML element handler for the <tip> tag.

param: boolean $startTag  Boolean indicating whether this instance is a
param: array $attrs       Additional element attributes.

_warnHandler($startTag, $attrs = array()   X-Ref
XML element handler for the <warn> tag.

param: boolean $startTag  Boolean indicating whether this instance is a
param: array $attrs       Additional element attributes.



Généré le : Sun Feb 25 18:01:28 2007 par Balluche grâce à PHPXref 0.7