Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
EditorAction Class Reference
Inheritance diagram for EditorAction:
PKPAction

Public Member Functions

 addReviewer ($request, $submission, $reviewerId, &$reviewRound, $reviewDueDate=null, $responseDueDate=null, $reviewMethod=null)
 
 assignDefaultStageParticipants ($submission, $stageId, $request)
 
 clearReview ($request, $submissionId, $reviewId)
 
 EditorAction ()
 
 incrementWorkflowStage ($submission, $newStage, $request)
 
 recordDecision ($request, $submission, $decision, $decisionLabels, $reviewRound=null, $stageId=null)
 
 setDueDates ($request, $submission, $reviewAssignment, $reviewDueDate=null, $responseDueDate=null, $logEntry=false)
 
- Public Member Functions inherited from PKPAction
 editCitations ($request, $submission)
 
 PKPAction ()
 

Detailed Description

Editor actions.

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

Member Function Documentation

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

Assigns a reviewer to a submission.

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

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

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

EditorAction::assignDefaultStageParticipants (   $submission,
  $stageId,
  $request 
)

Assign the default participants to a workflow stage.

Parameters
$submissionSubmission
$stageIdint
$requestRequest

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

Referenced by incrementWorkflowStage().

EditorAction::clearReview (   $request,
  $submissionId,
  $reviewId 
)

Clears a review assignment from a submission.

Parameters
$requestPKPRequest
$submissionobject
$reviewIdint

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

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

EditorAction::EditorAction ( )

Constructor.

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

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

Increment a submission's workflow stage.

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

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

References assignDefaultStageParticipants(), and Application\getSubmissionDAO().

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

Records an editor's submission decision.

Parameters
$requestPKPRequest
$submissionSubmission
$decisioninteger
$decisionLabelsarray(DECISION_CONSTANT => decision.locale.key, ...)
$reviewRoundReviewRound Current review round that user is taking the decision, if any.
$stageIdint

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

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

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

Sets the due date for a review assignment.

Parameters
$requestPKPRequest
$submissionSubmission
$reviewIdint
$dueDatestring
$numWeeksint
$logEntryboolean

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

References HookRegistry\call(), DAO\formatDateToDB(), DAORegistry\getDAO(), Config\getVar(), and SubmissionLog\logEvent().

Referenced by addReviewer().


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