HelpMappingFile Class Reference
[Help]
Abstracts a Help mapping XML file.
More...
Public Member Functions | |
| getSearchPath ($locale=null) | |
| getTocFilename ($tocId) | |
| getTopicFilename ($topicId) | |
| getTopicIdForFilename ($filename) | |
| HelpMappingFile ($filename) | |
Detailed Description
Abstracts a Help mapping XML file.Definition at line 18 of file HelpMappingFile.inc.php.
Member Function Documentation
| HelpMappingFile.getSearchPath | ( | $ | locale = null |
) |
This is an abstract function that should be implemented by subclasses.
Reimplemented in OJSHelpMappingFile, and PluginHelpMappingFile.
Definition at line 103 of file HelpMappingFile.inc.php.
| HelpMappingFile.getTocFilename | ( | $ | tocId | ) |
This is an abstract function that should be implemented by subclasses.
Reimplemented in OJSHelpMappingFile, and PluginHelpMappingFile.
Definition at line 87 of file HelpMappingFile.inc.php.
| HelpMappingFile.getTopicFilename | ( | $ | topicId | ) |
This is an abstract function that should be implemented by subclasses.
Reimplemented in OJSHelpMappingFile, and PluginHelpMappingFile.
Definition at line 95 of file HelpMappingFile.inc.php.
| HelpMappingFile.getTopicIdForFilename | ( | $ | filename | ) |
This is an abstract function that should be implemented by subclasses.
Reimplemented in OJSHelpMappingFile, and PluginHelpMappingFile.
Definition at line 111 of file HelpMappingFile.inc.php.
| HelpMappingFile.HelpMappingFile | ( | $ | filename | ) |
Constructor.
Definition at line 26 of file HelpMappingFile.inc.php.
The documentation for this class was generated from the following file:
- classes/help/HelpMappingFile.inc.php
