Open Journal Systems  2.4.4
 All Classes Namespaces Functions Variables Groups Pages
PluginHelpMappingFile Class Reference
Inheritance diagram for PluginHelpMappingFile:
HelpMappingFile

Public Member Functions

 getSearchPath ($locale=null)
 
 getTocFilename ($tocId)
 
 getTopicFilename ($topicId)
 
 getTopicIdForFilename ($filename)
 
 PluginHelpMappingFile (&$plugin)
 
- Public Member Functions inherited from HelpMappingFile
 getSearchPath ($locale=null)
 
 getTocFilename ($tocId)
 
 getTopicFilename ($topicId)
 
 getTopicIdForFilename ($filename)
 
 HelpMappingFile ($filename)
 

Detailed Description

Abstracts the plugin's help mapping XML files.

Definition at line 19 of file PluginHelpMappingFile.inc.php.

Member Function Documentation

PluginHelpMappingFile::getSearchPath (   $locale = null)

Get the directory containing help files to search.

Parameters
$localestring
Returns
string

Definition at line 67 of file PluginHelpMappingFile.inc.php.

References PKPHelp\getHelp().

PluginHelpMappingFile::getTocFilename (   $tocId)

Return the filename for a plugin help TOC filename.

Definition at line 34 of file PluginHelpMappingFile.inc.php.

References PKPHelp\getHelp().

PluginHelpMappingFile::getTopicFilename (   $topicId)

Return the filename for a plugin help topic filename.

Definition at line 42 of file PluginHelpMappingFile.inc.php.

References PKPHelp\getHelp().

PluginHelpMappingFile::getTopicIdForFilename (   $filename)

Given a help file filename, get the topic ID.

Parameters
$filenamestring
Returns
string

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

PluginHelpMappingFile::PluginHelpMappingFile ( $plugin)

Constructor

Definition at line 26 of file PluginHelpMappingFile.inc.php.


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