Docs For Class browse

Class browse_helpAction

Description

This is the help-browser action which enables browsing of help documentation.

version: $Id: browse_help.act.php,v 1.10 2007/09/19 14:04:56 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College
since: 12/8/05

Located in /polyphony/main/modules/help/browse_help.act.php (line 39)

Action
   |
   --browse_helpAction

Method Summary

void addHelpDirectory (string $directory, mixed $urlPath)

void addTopicsFromDirectory (string $dir, handle $handle, mixed $urlPath)

mixed execute (object Harmoni $harmoni)

string getHeadingText ()

object Component getHelpMenu ()

array getHelpTopics ()

string getMainTopic ()

object getTableOfContents ()

string getTopic ()

object Component getTopicContents (string $topic)

object DOMIT_Document getTopicXmlDocument (string $topic)

boolean isAuthorizedToExecute ()

string linkify (string $inputText)

void updateSrcTags (object $element, mixed $path)

void visitTableOfContentsPart (object $tocPart)

Methods

addHelpDirectory (line 261)

The default sub-directory is en_US

since: 12/9/05
static:
access: public

void addHelpDirectory (string $directory, mixed $urlPath)

string $directory

addTopicsFromDirectory (line 223)

Add the topics from a given file

since: 5/31/06
access: public

void addTopicsFromDirectory (string $dir, handle $handle, mixed $urlPath)

string $dir
handle $handle

execute (line 74)

Execute this action.

since: 4/25/05
access: public

mixed execute (object Harmoni $harmoni)

object Harmoni $harmoni

Redefinition of:

Action::execute(): Execute this action.

getHeadingText (line 62)

Return the heading text for this action, or an empty string.

since: 4/26/05
access: public

string getHeadingText ()

Redefinition of:

Action::getHeadingText(): Return the heading text for this action, or an empty string.

getHelpMenu (line 98)

Create the main help Menu

since: 12/8/05
access: public

object Component getHelpMenu ()

getHelpTopics (line 161)

Answer an array of the Help topics

since: 12/8/05
access: public

array getHelpTopics ()

getMainTopic (line 281)

Answer the title of the index page

since: 12/9/05
access: public

string getMainTopic ()

getTableOfContents (line 207)

Answer our table of contents object tree

since: 5/31/06
access: public

object getTableOfContents ()

getTopic (line 304)

Answer the current topic

since: 12/9/05
access: public

string getTopic ()

getTopicContents (line 319)

Answer the contents of the current topic

since: 12/9/05
access: public

object Component getTopicContents (string $topic)

string $topic

getTopicXmlDocument (line 472)

Answer a DOMIT XML Document for the given topic

since: 12/9/05
access: public

object DOMIT_Document getTopicXmlDocument (string $topic)

string $topic

isAuthorizedToExecute (line 50)

Check Authorizations

since: 4/26/05
access: public

boolean isAuthorizedToExecute ()

Redefinition of:

Action::isAuthorizedToExecute(): Check Authorizations

linkify (line 432)

Convert links of the form [[title]] or [[title#heading]] to html links of the form <a href='link'>title: heading</a>

since: 1/6/06
access: public

string linkify (string $inputText)

string $inputText

updateSrcTags (line 402)

Convert relative links in src tags to contain the full path needed to use them.

since: 5/31/06
access: public

void updateSrcTags (object $element, mixed $path)

object $element

visitTableOfContentsPart (line 115)

Visit a table of contents part and add it to our menue

since: 5/31/06
access: public

void visitTableOfContentsPart (object $tocPart)

object $tocPart

Inherited Methods

Inherited From Action

Action::execute()
Action::getHeadingText()
Action::getUnauthorizedMessage()
Action::isAuthorizedToExecute()
Action::requestedAction()
Action::requestedModule()

Documentation generated on Wed, 19 Sep 2007 10:21:54 -0400 by phpDocumentor 1.3.0RC3