Open Journal Systems  3.3.0
EditorAction Class Reference

Public Member Functions

 __construct ()
 
 addReviewer ($request, $submission, $reviewerId, &$reviewRound, $reviewDueDate, $responseDueDate, $reviewMethod=null)
 
 incrementWorkflowStage ($submission, $newStage, $request)
 
 recordDecision ($request, $submission, $decision, $decisionLabels, $reviewRound=null, $stageId=null, $recommendation=false)
 
 setDueDates ($request, $submission, $reviewAssignment, $reviewDueDate, $responseDueDate, $logEntry=false)
 

Detailed Description

Editor actions.

Definition at line 19 of file EditorAction.inc.php.

Constructor & Destructor Documentation

◆ __construct()

EditorAction::__construct ( )

Constructor.

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

Member Function Documentation

◆ addReviewer()

EditorAction::addReviewer (   $request,
  $submission,
  $reviewerId,
$reviewRound,
  $reviewDueDate,
  $responseDueDate,
  $reviewMethod = null 
)

Assigns a reviewer to a submission.

Parameters
$requestPKPRequest
$submissionobject
$reviewerIdint
$reviewRoundReviewRound
$reviewDueDatedatetime
$responseDueDatedatetime

Definition at line 106 of file EditorAction.inc.php.

References HookRegistry\call(), Core\getCurrentDate(), DAORegistry\getDAO(), SubmissionLog\logEvent(), and setDueDates().

◆ incrementWorkflowStage()

EditorAction::incrementWorkflowStage (   $submission,
  $newStage,
  $request 
)

Increment a submission's workflow stage.

Parameters
$submissionSubmission
$newStageinteger One of the WORKFLOW_STAGE_* constants.
$requestRequest

Definition at line 219 of file EditorAction.inc.php.

References DAORegistry\getDAO().

◆ recordDecision()

EditorAction::recordDecision (   $request,
  $submission,
  $decision,
  $decisionLabels,
  $reviewRound = null,
  $stageId = null,
  $recommendation = false 
)

Records an editor's submission decision.

Parameters
$requestPKPRequest
$submissionSubmission
$decisioninteger
$decisionLabelsarray(SUBMISSION_EDITOR_DECISION_... or SUBMISSION_EDITOR_RECOMMEND_... => editor.submission.decision....)
$reviewRoundReviewRound optional Current review round that user is taking the decision, if any.
$stageIdinteger optional
$recommendationboolean optional

Definition at line 39 of file EditorAction.inc.php.

References HookRegistry\call(), Core\getCurrentDate(), DAORegistry\getDAO(), SubmissionLog\logEvent(), and AppLocale\requireComponents().

◆ setDueDates()

EditorAction::setDueDates (   $request,
  $submission,
  $reviewAssignment,
  $reviewDueDate,
  $responseDueDate,
  $logEntry = false 
)

Sets the due date for a review assignment.

Parameters
$requestPKPRequest
$submissionSubmission
$reviewAssignmentReviewAssignment
$reviewDueDatestring
$responseDueDatestring
$logEntryboolean

Definition at line 165 of file EditorAction.inc.php.

References HookRegistry\call(), DAORegistry\getDAO(), and SubmissionLog\logEvent().

Referenced by addReviewer().


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