ReviewerAction Class Reference
[Submission]

ReviewerAction class. More...

Inheritance diagram for ReviewerAction:

List of all members.

Public Member Functions
	confirmReview ($reviewerSubmission, $decline, $send)
	deleteReviewerVersion ($reviewId, $fileId, $revision=null)
	downloadReviewerFile ($reviewId, $article, $fileId, $revision=null)
	editComment ($article, $comment, $reviewId)
	editReviewFormResponse ($reviewId, $reviewFormId)
	postPeerReviewComment (&$user, &$article, $reviewId, $emailComment)
	recordRecommendation (&$reviewerSubmission, $recommendation, $send)
	ReviewerAction ()
	saveReviewFormResponse ($reviewId, $reviewFormId)
	uploadReviewerVersion ($reviewId)
	viewPeerReviewComments (&$user, &$article, $reviewId)

---

Detailed Description

ReviewerAction class.

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

---

Member Function Documentation

ReviewerAction.confirmReview	(	$	reviewerSubmission,
		$	decline,
		$	send
	)

Actions. Records whether or not the reviewer accepts the review assignment.

Parameters:

	$user	object
	$reviewerSubmission	object
	$decline	boolean
	$send	boolean

Definition at line 40 of file ReviewerAction.inc.php.

References HookRegistry.call(), Core.getCurrentDate(), DAORegistry.getDAO(), Request.getJournal(), Request.getUserVar(), Config.getVar(), ArticleLog.logEventEntry(), and Request.url().

Referenced by SubmissionReviewHandler.confirmReview().

ReviewerAction.deleteReviewerVersion	(	$	reviewId,
		$	fileId,
		$	revision = null
	)

Delete an annotated version of an article.

Parameters:

	$reviewId	int
	$fileId	int
	$revision	int If null, then all revisions are deleted.

Definition at line 257 of file ReviewerAction.inc.php.

References HookRegistry.call(), DAORegistry.getDAO(), and Request.getUserVar().

ReviewerAction.downloadReviewerFile	(	$	reviewId,
		$	article,
		$	fileId,
		$	revision = null
	)

Download a file a reviewer has access to.

Parameters:

	$reviewId	int
	$article	object
	$fileId	int
	$revision	int

Definition at line 365 of file ReviewerAction.inc.php.

References HookRegistry.call(), Action.downloadFile(), DAORegistry.getDAO(), and Request.getJournal().

Referenced by SubmissionReviewHandler.downloadFile().

ReviewerAction.editComment	(	$	article,
		$	comment,
		$	reviewId
	)

Edit comment.

Parameters:

$commentId

int

Definition at line 407 of file ReviewerAction.inc.php.

References HookRegistry.call().

Referenced by SubmissionCommentsHandler.editComment().

ReviewerAction.editReviewFormResponse	(	$	reviewId,
		$	reviewFormId
	)

Edit review form response.

Parameters:

	$reviewId	int
	$reviewFormId	int

Definition at line 323 of file ReviewerAction.inc.php.

References HookRegistry.call().

Referenced by SubmissionReviewHandler.editReviewFormResponse().

ReviewerAction.postPeerReviewComment	(	&$	user,
		&$	article,
		$	reviewId,
		$	emailComment
	)

Post reviewer comments.

Parameters:

	$user	object Current user
	$article	object
	$reviewId	int
	$emailComment	boolean

Definition at line 295 of file ReviewerAction.inc.php.

References HookRegistry.call().

Referenced by SubmissionCommentsHandler.postPeerReviewComment().

ReviewerAction.recordRecommendation	(	&$	reviewerSubmission,
		$	recommendation,
		$	send
	)

Records the reviewer's submission recommendation.

Parameters:

	$reviewId	int
	$recommendation	int
	$send	boolean

Definition at line 121 of file ReviewerAction.inc.php.

References HookRegistry.call(), Core.getCurrentDate(), DAORegistry.getDAO(), Request.getJournal(), ReviewAssignment.getReviewerRecommendationOptions(), Request.getUserVar(), ArticleLog.logEventEntry(), Locale.translate(), and Request.url().

Referenced by SubmissionReviewHandler.recordRecommendation().

ReviewerAction.ReviewerAction

(

)

Constructor.

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

ReviewerAction.saveReviewFormResponse	(	$	reviewId,
		$	reviewFormId
	)

Save review form response.

Parameters:

	$reviewId	int
	$reviewFormId	int

Definition at line 338 of file ReviewerAction.inc.php.

References HookRegistry.call().

Referenced by SubmissionReviewHandler.saveReviewFormResponse().

ReviewerAction.uploadReviewerVersion

(

$

reviewId

)

Upload the annotated version of an article.

Parameters:

$reviewId

int

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

References HookRegistry.call(), Core.getCurrentDate(), DAORegistry.getDAO(), and ArticleLog.logEventEntry().

Referenced by SubmissionReviewHandler.uploadReviewerVersion().

ReviewerAction.viewPeerReviewComments	(	&$	user,
		&$	article,
		$	reviewId
	)

View reviewer comments.

Parameters:

	$user	object Current user
	$article	object
	$reviewId	int

Definition at line 276 of file ReviewerAction.inc.php.

References HookRegistry.call().

Referenced by SubmissionCommentsHandler.postPeerReviewComment(), and SubmissionCommentsHandler.viewPeerReviewComments().

---

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

• classes/submission/reviewer/ReviewerAction.inc.php