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

Public Member Functions

 __construct ()
 
 _validateAccessKey ($request)
 
 authorize ($request, &$args, $roleAssignments)
 
 getReviewForm ($step, $request, $reviewerSubmission, $reviewAssignment)
 
- Public Member Functions inherited from PKPReviewerHandler
 _retrieveStep ()
 
 saveDeclineReview ($args, $request)
 
 saveStep ($args, $request)
 
 setupTemplate ($request)
 
 showDeclineReview ($args, $request)
 
 step ($args, $request)
 
 submission ($args, $request)
 
- Public Member Functions inherited from PKPHandler
 addPolicy ($authorizationPolicy, $addToTop=false)
 
 addRoleAssignment ($roleIds, $operations)
 
 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)
 

Additional Inherited Members

- Static Public Member Functions inherited from PKPHandler
static getPageParamName ($rangeName)
 
static getRangeInfo ($request, $rangeName, $contextData=null)
 
static hashPageContext ($request, $contextData=array())
 
- Data Fields inherited from PKPReviewerHandler
 $_isBackendPage = true
 
- Data Fields inherited from PKPHandler
 $_authorizationDecisionManager
 
 $_checks = array()
 
 $_dispatcher
 
 $_enforceRestrictedSite = true
 
 $_id
 
 $_isBackendPage = false
 
 $_roleAssignments = array()
 
 $_roleAssignmentsChecked = false
 
- Protected Attributes inherited from PKPHandler
 $_apiToken = null
 

Detailed Description

Handle requests for reviewer functions.

Definition at line 18 of file ReviewerHandler.inc.php.

Constructor & Destructor Documentation

◆ __construct()

ReviewerHandler::__construct ( )

Constructor

Reimplemented from PKPHandler.

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

References PKPHandler\addRoleAssignment().

Member Function Documentation

◆ _validateAccessKey()

ReviewerHandler::_validateAccessKey (   $request)

Tests if the request contains a valid access token. If this is the case the regular login process will be skipped

Parameters
$requestPKPRequest
Returns
void

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

References AccessKeyManager\generateKeyHash(), DAORegistry\getDAO(), SessionManager\getManager(), Validation\registerUserSession(), and PKPReviewerHandler\submission().

Referenced by authorize().

◆ authorize()

ReviewerHandler::authorize (   $request,
$args,
  $roleAssignments 
)

Authorize this request.

Routers will call this method automatically thereby enforcing authorization. This method will be called before the validate() method and before passing control on to the handler operation.

NB: This method will be called once for every request only.

Parameters
$requestRequest
$argsarray request arguments
$roleAssignmentsarray the operation role assignment, see getRoleAssignment() for more details.
Returns
boolean

Reimplemented from PKPHandler.

Definition at line 35 of file ReviewerHandler.inc.php.

References _validateAccessKey(), and PKPHandler\addPolicy().

◆ getReviewForm()

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

Get a review form for the current step.

Parameters
$stepint current step
$requestPKPRequest
$reviewerSubmissionReviewerSubmission
$reviewAssignmentReviewAssignment

Reimplemented from PKPReviewerHandler.

Definition at line 102 of file ReviewerHandler.inc.php.


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