Open Journal Systems  3.3.0
PKPReviewerHandler Class Reference
Inheritance diagram for PKPReviewerHandler:
Handler PKPHandler ReviewerHandler

Public Member Functions

 _retrieveStep ()
 
 getReviewForm ($step, $request, $reviewerSubmission, $reviewAssignment)
 
 saveDeclineReview ($args, $request)
 
 saveStep ($args, $request)
 
 setupTemplate ($request)
 
 showDeclineReview ($args, $request)
 
 step ($args, $request)
 
 submission ($args, $request)
 
- Public Member Functions inherited from PKPHandler
 __construct ()
 
 addPolicy ($authorizationPolicy, $addToTop=false)
 
 addRoleAssignment ($roleIds, $operations)
 
 authorize ($request, &$args, $roleAssignments)
 
 getApiToken ()
 
getAuthorizedContext ()
 
getAuthorizedContextObject ($assocType)
 
getDispatcher ()
 
 getFirstUserContext ($user, $contexts)
 
 getId ()
 
 getLastAuthorizationMessage ()
 
 getRoleAssignment ($roleId)
 
 getRoleAssignments ()
 
 getSiteRedirectContext ($request)
 
 getTargetContext ($request, &$contextsCount=null)
 
 index ($args, $request)
 
 initialize ($request)
 
 markRoleAssignmentsChecked ()
 
 requireSSL ()
 
 setApiToken ($apiToken)
 
 setDispatcher ($dispatcher)
 
 setEnforceRestrictedSite ($enforceRestrictedSite)
 
 setId ($id)
 
 validate ($requiredContexts=null, $request=null)
 

Data Fields

 $_isBackendPage = true
 
- Data Fields inherited from PKPHandler
 $_authorizationDecisionManager
 
 $_checks = array()
 
 $_dispatcher
 
 $_enforceRestrictedSite = true
 
 $_id
 
 $_isBackendPage = false
 
 $_roleAssignments = array()
 
 $_roleAssignmentsChecked = false
 

Additional Inherited Members

- Static Public Member Functions inherited from PKPHandler
static getPageParamName ($rangeName)
 
static getRangeInfo ($request, $rangeName, $contextData=null)
 
static hashPageContext ($request, $contextData=array())
 
- Protected Attributes inherited from PKPHandler
 $_apiToken = null
 

Detailed Description

Handle requests for reviewer functions.

Definition at line 20 of file PKPReviewerHandler.inc.php.

Member Function Documentation

◆ _retrieveStep()

PKPReviewerHandler::_retrieveStep ( )

◆ getReviewForm()

PKPReviewerHandler::getReviewForm (   $step,
  $request,
  $reviewerSubmission,
  $reviewAssignment 
)

Get a review form for the current step.

Parameters
$stepint current step
$requestPKPRequest
$reviewerSubmissionReviewerSubmission
$reviewAssignmentReviewAssignment

Reimplemented in ReviewerHandler.

Definition at line 205 of file PKPReviewerHandler.inc.php.

Referenced by saveStep(), and step().

◆ saveDeclineReview()

PKPReviewerHandler::saveDeclineReview (   $args,
  $request 
)

Save the reviewer regrets form and decline the review.

Parameters
$argsarray
$requestPKPRequest

Definition at line 166 of file PKPReviewerHandler.inc.php.

References fatalError(), and PKPHandler\getAuthorizedContextObject().

◆ saveStep()

PKPReviewerHandler::saveStep (   $args,
  $request 
)

Save a review step.

Parameters
$argsarray first parameter is the step being saved
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 98 of file PKPReviewerHandler.inc.php.

References fatalError(), PKPHandler\getAuthorizedContextObject(), DAORegistry\getDAO(), DAO\getDataChangedEvent(), getReviewForm(), and setupTemplate().

◆ setupTemplate()

PKPReviewerHandler::setupTemplate (   $request)

Setup common template variables.

Reimplemented from PKPHandler.

Definition at line 185 of file PKPReviewerHandler.inc.php.

References AppLocale\requireComponents().

Referenced by saveStep(), showDeclineReview(), step(), and submission().

◆ showDeclineReview()

PKPReviewerHandler::showDeclineReview (   $args,
  $request 
)

Show a form for the reviewer to enter regrets into.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 141 of file PKPReviewerHandler.inc.php.

References PKPHandler\getAuthorizedContextObject(), DAORegistry\getDAO(), PKPTemplateManager\getManager(), and setupTemplate().

◆ step()

PKPReviewerHandler::step (   $args,
  $request 
)

Display a step tab contents in the submission review page.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 60 of file PKPReviewerHandler.inc.php.

References fatalError(), PKPHandler\getAuthorizedContextObject(), DAORegistry\getDAO(), PKPTemplateManager\getManager(), getReviewForm(), and setupTemplate().

◆ submission()

PKPReviewerHandler::submission (   $args,
  $request 
)

Display the submission review page.

Parameters
$argsarray
$requestPKPRequest

Definition at line 30 of file PKPReviewerHandler.inc.php.

References PKPHandler\getAuthorizedContextObject(), DAORegistry\getDAO(), PKPTemplateManager\getManager(), and setupTemplate().

Referenced by ReviewerHandler\_validateAccessKey().

Field Documentation

◆ $_isBackendPage

PKPReviewerHandler::$_isBackendPage = true

Definition at line 23 of file PKPReviewerHandler.inc.php.


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