Class CMS3_Help

Description

Implements interfaces:

The Help plugin displays help pages exposed with CMS3_Help_IProvidesHelp

Located in /lib/Help/CMS3_Help.php (line 32)

CMS3_System_Plugin
   |
   --CMS3_Help
Method Summary
 string GetPluginID ()
 void GetSystemIcon ()
 IEmbedmentOutputHandler &ModifyContent ([IEmbedmentOutputHandler $Identifier = null], string &$EmbedmentOutputHandler)
 string ParseTreeNodes (array $Entries, [string $Parent = ""])
 string ResolveIdentifier (string $Identifier, [array $Entries = null])
 void SystemCallback (string $data)
Variables

Inherited Variables

Inherited from CMS3_System_Plugin

CMS3_System_Plugin::$Owner
Methods
GetPluginID (line 180)

Gets the pluginID of the plugin.

  • access: public
string GetPluginID ()
GetSystemIcon (line 102)

Gets an absolute address of an icon for this plugin

  • access: public
void GetSystemIcon ()
GetSystemMenuEntry (line 109)

Gets menu entry string

  • access: public
void GetSystemMenuEntry ()
ModifyContent (line 63)

Shows help pages

  • access: public
IEmbedmentOutputHandler &ModifyContent ([IEmbedmentOutputHandler $Identifier = null], string &$EmbedmentOutputHandler)
  • IEmbedmentOutputHandler $Identifier: EmbedmentOutputHandler Outputhandler the content MUST be parse to.
  • string &$EmbedmentOutputHandler: Identifier String at the end of the URL
ParseTreeNodes (line 122)

Parse a list of entries into HTML TreeNodes

  • return: HTML/dojo representation of TreeNodes
  • access: protected
string ParseTreeNodes (array $Entries, [string $Parent = ""])
  • array $Entries: Entries List of entries to parse
  • string $Parent: Parent Identifier used by ResolveIdentifier
ResolveIdentifier (line 139)

Gets the content of a help page from its identifier

  • return: Content related the identifier, returns false if nothing was found within the searched entries
  • access: protected
string ResolveIdentifier (string $Identifier, [array $Entries = null])
  • string $Identifier: Identifier for the information you wish to retrive
  • array $Entries: Entries List of entries to search, defaults all help pages available
SystemCallback (line 44)

Handles a callback from ajax application.

  • access: public
void SystemCallback (string $data)
  • string $data: data Data attached to this callback

Inherited Methods

Inherited From CMS3_System_Plugin

 CMS3_System_Plugin::Register()

Documentation generated on Mon, 30 Apr 2007 01:59:04 +0200 by phpDocumentor 1.3.1