PluginHelpMappingFile Class Reference
[Help]
Abstracts the plugin's help mapping XML files.
More...
Public Member Functions | |
| getSearchPath ($locale=null) | |
| getTocFilename ($tocId) | |
| getTopicFilename ($topicId) | |
| getTopicIdForFilename ($filename) | |
| PluginHelpMappingFile (&$plugin) | |
Detailed Description
Abstracts the plugin's help mapping XML files.Definition at line 20 of file PluginHelpMappingFile.inc.php.
Member Function Documentation
| PluginHelpMappingFile.getSearchPath | ( | $ | locale = null |
) |
This is an abstract function that should be implemented by subclasses.
Reimplemented from HelpMappingFile.
Definition at line 58 of file PluginHelpMappingFile.inc.php.
References Help.getHelp().
| PluginHelpMappingFile.getTocFilename | ( | $ | tocId | ) |
Return the filename for a plugin help TOC filename.
Reimplemented from HelpMappingFile.
Definition at line 35 of file PluginHelpMappingFile.inc.php.
References Help.getHelp().
| PluginHelpMappingFile.getTopicFilename | ( | $ | topicId | ) |
Return the filename for a plugin help topic filename.
Reimplemented from HelpMappingFile.
Definition at line 43 of file PluginHelpMappingFile.inc.php.
References Help.getHelp().
| PluginHelpMappingFile.getTopicIdForFilename | ( | $ | filename | ) |
This is an abstract function that should be implemented by subclasses.
Reimplemented from HelpMappingFile.
Definition at line 48 of file PluginHelpMappingFile.inc.php.
| PluginHelpMappingFile.PluginHelpMappingFile | ( | &$ | plugin | ) |
Constructor
Definition at line 27 of file PluginHelpMappingFile.inc.php.
The documentation for this class was generated from the following file:
- classes/help/PluginHelpMappingFile.inc.php
