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

Public Member Functions

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

Detailed Description

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

Definition at line 22 of file PKPHelp.inc.php.

Member Function Documentation

& PKPHelp::buildToc (   $helpToc)

Modifies retrieved array of topics and arranges them into toc

Parameters
$helpTocarray
Returns
array

Definition at line 159 of file PKPHelp.inc.php.

References buildTocHelper().

PKPHelp::buildTocHelper ( $toc,
  $section,
  $prefix 
)

Helper method for buildToc

Parameters
$helpTocarray
$sectionarray
$numnumbering of topic

Definition at line 175 of file PKPHelp.inc.php.

Referenced by buildToc().

PKPHelp::buildTopicSection (   $topicId,
  $prevTocId = null 
)

Helper method for getTableOfContents

Parameters
$topicIdint
$prevTocIdint
Returns
array

Definition at line 191 of file PKPHelp.inc.php.

References DAORegistry\getDAO().

PKPHelp::dirmtime (   $dirName,
  $doRecursive 
)

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

Parameters
$dirNamestring
$doRecursivebool
Returns
int

Definition at line 228 of file PKPHelp.inc.php.

PKPHelp::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 60 of file PKPHelp.inc.php.

References AppLocale\getLocale().

& PKPHelp::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 149 of file PKPHelp.inc.php.

PKPHelp::PKPHelp ( )

Constructor.

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

PKPHelp::translate (   $key)

Translate a help topic key to its numerical id.

Parameters
$keystring
Returns
string

Definition at line 73 of file PKPHelp.inc.php.


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