Help Class Reference
[Help]

Provides methods for translating help topic keys to their respected topic help ids. More...

List of all members.

Public Member Functions
&	buildToc ($helpToc)
	buildTocHelper (&$toc, $section, $prefix)
	buildTopicSection ($topicId, $prevTocId=null)
	dirmtime ($dirName, $doRecursive)
&	getHelp ()
	getLocale ()
&	getTableOfContents ()
	Help ()
	translate ($key)

---

Detailed Description

Provides methods for translating help topic keys to their respected topic help ids.

Definition at line 23 of file Help.inc.php.

---

Member Function Documentation

& Help.buildToc

(

$

helpToc

)

Modifies retrieved array of topics and arranges them into toc

Parameters:

$helpToc

array

Returns:

array

Definition at line 163 of file Help.inc.php.

References buildTocHelper().

Help.buildTocHelper	(	&$	toc,
		$	section,
		$	prefix
	)

Helper method for buildToc

Parameters:

	$helpToc	array
	$section	array
	$num	numbering of topic

Definition at line 179 of file Help.inc.php.

Referenced by buildToc().

Help.buildTopicSection	(	$	topicId,
		$	prevTocId = null
	)

Helper method for getTableOfContents

Parameters:

	$topicId	int
	$prevTocId	int

Returns:

array

Definition at line 195 of file Help.inc.php.

References DAORegistry.getDAO().

Help.dirmtime	(	$	dirName,
		$	doRecursive
	)

Returns the most recent modified file in the specified directory Taken from the php.net site under filemtime

Parameters:

	$dirName	string
	$doRecursive	bool

Returns:

int

Definition at line 232 of file Help.inc.php.

& Help.getHelp

(

)

Get an instance of the Help object.

Definition at line 30 of file Help.inc.php.

References Registry.get(), Help(), and Registry.set().

Referenced by Plugin.addHelpData(), PluginHelpMappingFile.getSearchPath(), OJSHelpMappingFile.getSearchPath(), PluginHelpMappingFile.getTocFilename(), OJSHelpMappingFile.getTocFilename(), PluginHelpMappingFile.getTopicFilename(), OJSHelpMappingFile.getTopicFilename(), HelpTopicDAO.getTopicsByKeyword(), TemplateManager.smartyGetHelpId(), and TemplateManager.smartyHelpTopic().

Help.getLocale

(

)

Get the locale to display help files in. If help isn't available for the current locale, defaults to en_US.

Definition at line 63 of file Help.inc.php.

References Locale.getLocale().

& Help.getTableOfContents

(

)

Load table of contents from xml help topics and their tocs (return cache, if available)

Returns:

array associative array of topics and subtopics

Definition at line 153 of file Help.inc.php.

Help.Help

(

)

Constructor.

Definition at line 43 of file Help.inc.php.

Referenced by getHelp().

Help.translate

(

$

key

)

Translate a help topic key to its numerical id.

Parameters:

$key

string

Returns:

string

Definition at line 76 of file Help.inc.php.

---

The documentation for this class was generated from the following file:

• classes/help/Help.inc.php