[ Index ]

PHP Cross Reference of Eventum

title

Body

[close]

/include/ -> class.help.php (summary)

(no description)

File Size: 254 lines (8 kb)
Included or required: 1 time
Referenced: 0 times
Includes or requires: 1 file
 include/class.error_handler.php

Defines 1 class

Help:: (4 methods):
  topicExists()
  getParent()
  getChildLinks()
  getNavigationLinks()


Class: Help  - X-Ref

Class to handle the business logic related to the help
documentation, such as providing a dynamic list of topics related
to the current topic and such.

topicExists($topic)   X-Ref
Method used to check whether a specific topic exists or not.
This is mainly used in the help documentation main page to see
if a requested topic exists, and to show a default one
otherwise.

param: string $topic The topic title to check for
return: boolean Whether the topic exists or not

getParent($topic)   X-Ref
Method used to get the parent help documentation topic
associated with a specific topic title.

param: string $topic The topic title
return: array The information related to the parent help topic

getChildLinks($topic)   X-Ref
Method used to get all the help topics related to a specific
'parent' one.

param: string $topic The 'parent' help topic
return: array The list of help topics

getNavigationLinks($topic)   X-Ref
Method used to get all of the navigation links related to a
specific help topic.

param: string $topic The topic title
return: array The list of navigation links



Generated: Wed Dec 19 21:21:33 2007 Cross-referenced by PHPXref 0.7