OJSHelpMappingFile Class Reference
[Help]

Abstracts the built-in help mapping XML file. More...

Inheritance diagram for OJSHelpMappingFile:

List of all members.

Public Member Functions
	getSearchPath ($locale=null)
	getTocFilename ($tocId)
	getTopicFilename ($topicId)
	getTopicIdForFilename ($filename)
	OJSHelpMappingFile ()

---

Detailed Description

Abstracts the built-in help mapping XML file.

Definition at line 20 of file OJSHelpMappingFile.inc.php.

---

Member Function Documentation

OJSHelpMappingFile.getSearchPath

(

$

locale = null

)

This is an abstract function that should be implemented by subclasses.

Reimplemented from HelpMappingFile.

Definition at line 52 of file OJSHelpMappingFile.inc.php.

References Help.getHelp().

OJSHelpMappingFile.getTocFilename

(

$

tocId

)

Return the filename for a built-in OJS help TOC filename.

Reimplemented from HelpMappingFile.

Definition at line 31 of file OJSHelpMappingFile.inc.php.

References Help.getHelp().

OJSHelpMappingFile.getTopicFilename

(

$

topicId

)

Return the filename for a built-in OJS help topic filename.

Reimplemented from HelpMappingFile.

Definition at line 39 of file OJSHelpMappingFile.inc.php.

References Help.getHelp().

OJSHelpMappingFile.getTopicIdForFilename

(

$

filename

)

This is an abstract function that should be implemented by subclasses.

Reimplemented from HelpMappingFile.

Definition at line 45 of file OJSHelpMappingFile.inc.php.

OJSHelpMappingFile.OJSHelpMappingFile

(

)

Constructor

Definition at line 24 of file OJSHelpMappingFile.inc.php.

---

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

• classes/help/OJSHelpMappingFile.inc.php