Open Journal Systems  2.4.8
 All Classes Namespaces Functions Variables Groups Pages
HelpHandler Class Reference
Inheritance diagram for HelpHandler:
Handler PKPHandler

Public Member Functions

 HelpHandler ()
 index ($args, &$request)
 search ($args, &$request)
 setupTemplate ()
 toc ($args, &$request)
 view ($args, $request)
- Public Member Functions inherited from PKPHandler
 addCheck (&$handlerValidator)
 addPolicy (&$authorizationPolicy, $addToTop=false)
 addRoleAssignment ($roleIds, $operations)
 authorize (&$request, &$args, $roleAssignments)
getAuthorizedContext ()
getAuthorizedContextObject ($assocType)
getDispatcher ()
 getId ()
 getLastAuthorizationMessage ()
 getLoginExemptions ()
getRangeInfo ($rangeName, $contextData=null)
 getRoleAssignment ($roleId)
 getRoleAssignments ()
 hashPageContext ($contextData=array())
 index ()
 initialize (&$request, $args=null)
 PKPHandler ()
 requireSSL ()
 setDispatcher (&$dispatcher)
 setId ($id)
 validate ($requiredContexts=null, $request=null)

Detailed Description

Handle requests for viewing help pages.

Definition at line 28 of file

Member Function Documentation

HelpHandler::HelpHandler ( )


Definition at line 32 of file

HelpHandler::index (   $args,

Display help table of contents.


Definition at line 41 of file

References view().

HelpHandler::search (   $args,

Display search results for a topic search by keyword.


Definition at line 123 of file

References DAORegistry\getDAO(), String\regexp_replace(), setupTemplate(), and PKPHandler\validate().

HelpHandler::setupTemplate ( )

Initialize the template

Definition at line 152 of file

Referenced by search(), toc(), and view().

HelpHandler::toc (   $args,

Display help table of contents.


Definition at line 50 of file

References PKPHelp\getHelp(), setupTemplate(), and PKPHandler\validate().

HelpHandler::view (   $args,

Display the selected help topic.

$argsarray first parameter is the ID of the topic to display

Definition at line 66 of file

References DAORegistry\getDAO(), AppLocale\getLocale(), String\regexp_replace(), setupTemplate(), and PKPHandler\validate().

Referenced by index().

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