Open Journal Systems  2.4.3
 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 ()
 
 setDispatcher (&$dispatcher)
 
 setId ($id)
 
 validate ($requiredContexts=null, $request=null)
 

Detailed Description

Handle requests for viewing help pages.

Definition at line 28 of file HelpHandler.inc.php.

Member Function Documentation

HelpHandler::HelpHandler ( )

Constructor

Definition at line 32 of file HelpHandler.inc.php.

HelpHandler::index (   $args,
$request 
)

Display help table of contents.

Parameters
$argsarray
$requestPKPRequest

Definition at line 41 of file HelpHandler.inc.php.

References view().

HelpHandler::search (   $args,
$request 
)

Display search results for a topic search by keyword.

Parameters
$argsarray
$requestPKPRequest

Definition at line 123 of file HelpHandler.inc.php.

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

HelpHandler::setupTemplate ( )

Initialize the template

Definition at line 152 of file HelpHandler.inc.php.

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

HelpHandler::toc (   $args,
$request 
)

Display help table of contents.

Parameters
$argsarray
$requestPKPRequest

Definition at line 50 of file HelpHandler.inc.php.

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

HelpHandler::view (   $args,
  $request 
)

Display the selected help topic.

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

Definition at line 66 of file HelpHandler.inc.php.

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: