TrackDirectorAction Class Reference
[Submission]

TrackDirectorAction class. More...

Inheritance diagram for TrackDirectorAction:

List of all members.

Public Member Functions
	addReviewer ($trackDirectorSubmission, $reviewerId, $stage)
	addReviewForm ($trackDirectorSubmission, $reviewId, $reviewFormId)
	addSubmissionNote ($paperId)
	archiveSubmission ($trackDirectorSubmission)
	blindCcReviewsToReviewers ($paper, $send=false, $inhibitExistingEmail=false)
	cancelReview ($trackDirectorSubmission, $reviewId, $send=false)
	changeSessionType (&$trackDirectorSubmission, $sessionType)
	changeTrack (&$trackDirectorSubmission, $trackId)
	clearAllSubmissionNotes ($paperId)
	clearReview ($trackDirectorSubmission, $reviewId)
	clearReviewForm ($trackDirectorSubmission, $reviewId)
	completePaper ($trackDirectorSubmission, $complete)
	completeReview ($trackDirectorSubmission)
	confirmReviewForReviewer ($reviewId)
	deleteGalley ($paper, $galleyId)
	deletePaperFile ($submission, $fileId, $revision)
	deletePaperImage ($submission, $fileId, $revision)
	deleteSuppFile ($paper, $suppFileId)
	emailDirectorDecisionComment ($trackDirectorSubmission, $send)
	makeReviewerFileViewable ($paperId, $reviewId, $fileId, $revision, $viewable=false)
	notifyReviewer ($trackDirectorSubmission, $reviewId, $send=false)
	orderGalley ($paper, $galleyId, $direction)
	orderSuppFile ($paper, $suppFileId, $direction)
	postDirectorDecisionComment ($paper, $emailComment)
	postPeerReviewComment (&$paper, $reviewId, $emailComment)
	rateReviewer ($paperId, $reviewId, $quality=null)
	recordDecision ($trackDirectorSubmission, $decision, $stage)
	remindReviewer ($trackDirectorSubmission, $reviewId, $send=false)
	removeSubmissionNote ($paperId)
	restoreToQueue ($trackDirectorSubmission)
	setDueDate ($paperId, $reviewId, $dueDate=null, $numWeeks=null, $logChange=true)
	setEditingFile ($trackDirectorSubmission, $fileId, $revision, $createGalley=false)
	setReviewerRecommendation ($paperId, $reviewId, $recommendation, $acceptOption)
	submissionBreadcrumb ($paperId, $parentPage, $track)
	thankReviewer ($trackDirectorSubmission, $reviewId, $send=false)
	TrackDirectorAction ()
	unsuitableSubmission ($trackDirectorSubmission, $send=false)
	updateCommentsStatus ($submission, $commentsStatus)
	updateSubmissionNote ($paperId)
	uploadDirectorVersion ($trackDirectorSubmission)
	uploadReviewForReviewer ($reviewId)
	uploadReviewVersion ($trackDirectorSubmission)
	viewDirectorDecisionComments ($paper)
	viewPeerReviewComments (&$paper, $reviewId)
	viewReviewFormResponse ($trackDirectorSubmission, $reviewId)

---

Detailed Description

TrackDirectorAction class.

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

---

Member Function Documentation

TrackDirectorAction.addReviewer	(	$	trackDirectorSubmission,
		$	reviewerId,
		$	stage
	)

Assigns a reviewer to a submission.

Parameters:

	$trackDirectorSubmission	object
	$reviewerId	int
	$stage	int

Definition at line 171 of file TrackDirectorAction.inc.php.

References Request.getSchedConf(), PaperLog.logEvent(), and setDueDate().

Referenced by completeReview(), and SubmissionEditHandler.selectReviewer().

TrackDirectorAction.addReviewForm	(	$	trackDirectorSubmission,
		$	reviewId,
		$	reviewFormId
	)

Assigns a review form to a review.

Parameters:

	$trackDirectorSubmission	object
	$reviewId	int
	$reviewFormId	int

Definition at line 818 of file TrackDirectorAction.inc.php.

Referenced by SubmissionEditHandler.selectReviewForm().

TrackDirectorAction.addSubmissionNote

(

$

paperId

)

Add Submission Note

Parameters:

$paperId

int

Definition at line 1218 of file TrackDirectorAction.inc.php.

Referenced by SubmissionEditHandler.addSubmissionNote().

TrackDirectorAction.archiveSubmission

(

$

trackDirectorSubmission

)

Archive a submission.

Parameters:

$trackDirectorSubmission

object

Definition at line 1039 of file TrackDirectorAction.inc.php.

References PaperLog.logEvent().

Referenced by SubmissionEditHandler.archiveSubmission(), and unsuitableSubmission().

TrackDirectorAction.blindCcReviewsToReviewers	(	$	paper,
		$	send = false,
		$	inhibitExistingEmail = false
	)

Blind CC the reviews to reviewers.

Parameters:

	$paper	object
	$send	boolean
	$inhibitExistingEmail	boolean

Returns:

boolean true iff ready for redirect

Definition at line 1612 of file TrackDirectorAction.inc.php.

References Request.getConference(), and Request.url().

Referenced by SubmissionCommentsHandler.blindCcReviewsToReviewers().

TrackDirectorAction.cancelReview	(	$	trackDirectorSubmission,
		$	reviewId,
		$	send = false
	)

Cancels a review.

Parameters:

	$trackDirectorSubmission	object
	$reviewId	int

Returns:

boolean true iff ready for redirect

Definition at line 386 of file TrackDirectorAction.inc.php.

References Request.getConference(), PaperLog.logEvent(), and Request.url().

Referenced by SubmissionEditHandler.cancelReview().

TrackDirectorAction.changeSessionType	(	&$	trackDirectorSubmission,
		$	sessionType
	)

Changes the session type.

Parameters:

	$trackDirectorSubmission	object
	$sessionType	int

Definition at line 49 of file TrackDirectorAction.inc.php.

Referenced by SubmissionEditHandler.changeSessionType().

TrackDirectorAction.changeTrack	(	&$	trackDirectorSubmission,
		$	trackId
	)

Changes the track a paper belongs in.

Parameters:

	$trackDirectorSubmission	object
	$trackId	int

Definition at line 36 of file TrackDirectorAction.inc.php.

Referenced by SubmissionEditHandler.changeTrack().

TrackDirectorAction.clearAllSubmissionNotes

(

$

paperId

)

Clear All Submission Notes

Parameters:

$paperId

int

Definition at line 1313 of file TrackDirectorAction.inc.php.

Referenced by SubmissionEditHandler.clearAllSubmissionNotes().

TrackDirectorAction.clearReview	(	$	trackDirectorSubmission,
		$	reviewId
	)

Clears a review assignment from a submission.

Parameters:

	$trackDirectorSubmission	object
	$reviewId	int

Definition at line 247 of file TrackDirectorAction.inc.php.

References PaperLog.logEvent().

Referenced by SubmissionEditHandler.clearReview(), and SubmissionEditHandler.recordDecision().

TrackDirectorAction.clearReviewForm	(	$	trackDirectorSubmission,
		$	reviewId
	)

Clear a review form

Parameters:

	$trackDirectorSubmission	object
	$reviewId	int

Definition at line 795 of file TrackDirectorAction.inc.php.

Referenced by SubmissionEditHandler.clearReviewForm().

TrackDirectorAction.completePaper	(	$	trackDirectorSubmission,
		$	complete
	)

Mark a paper as published or move a previously published paper back into the queue.

Parameters:

	$trackDirectorSubmission	object
	$complete	boolean If true, complete the submission. If false, return it to the queue (unpublish it).

Definition at line 991 of file TrackDirectorAction.inc.php.

References PaperLog.logEvent().

Referenced by SubmissionEditHandler.completePaper().

TrackDirectorAction.completeReview

(

$

trackDirectorSubmission

)

After a decision has been recorded, bumps the paper to the next stage. If the submission requires completion, it's sent back to the author. If not, review is complete, and the paper can be released.

Parameters:

	$schedConf	object
	$trackDirectorSubmission	object
	$decision	int

Definition at line 124 of file TrackDirectorAction.inc.php.

References addReviewer(), and Request.getSchedConf().

Referenced by recordDecision().

TrackDirectorAction.confirmReviewForReviewer

(

$

reviewId

)

Accepts the review assignment on behalf of its reviewer.

Parameters:

$reviewId

int

Definition at line 1661 of file TrackDirectorAction.inc.php.

References PaperLog.logEventEntry().

Referenced by SubmissionEditHandler.confirmReviewForReviewer().

TrackDirectorAction.deleteGalley	(	$	paper,
		$	galleyId
	)

Delete a galley.

Parameters:

	$paper	object
	$galleyId	int

Definition at line 1112 of file TrackDirectorAction.inc.php.

References PaperSearchIndex.deleteTextIndex().

Referenced by SubmissionEditHandler.deleteGalley().

TrackDirectorAction.deletePaperFile	(	$	submission,
		$	fileId,
		$	revision
	)

Delete a file from a paper.

Parameters:

	$submission	object
	$fileId	int
	$revision	int (optional)

Definition at line 1182 of file TrackDirectorAction.inc.php.

Referenced by SubmissionEditHandler.deletePaperFile().

TrackDirectorAction.deletePaperImage	(	$	submission,
		$	fileId,
		$	revision
	)

Delete an image from a paper galley.

Parameters:

	$submission	object
	$fileId	int
	$revision	int (optional)

Definition at line 1198 of file TrackDirectorAction.inc.php.

Referenced by SubmissionEditHandler.deletePaperImage().

TrackDirectorAction.deleteSuppFile	(	$	paper,
		$	suppFileId
	)

Delete a supplementary file.

Parameters:

	$paper	object
	$suppFileId	int

Definition at line 1159 of file TrackDirectorAction.inc.php.

References PaperSearchIndex.deleteTextIndex().

Referenced by SubmissionEditHandler.deleteSuppFile().

TrackDirectorAction.emailDirectorDecisionComment	(	$	trackDirectorSubmission,
		$	send
	)

Email director decision comment.

Parameters:

	$trackDirectorSubmission	object
	$send	boolean

Definition at line 1451 of file TrackDirectorAction.inc.php.

References Request.getConference(), Request.getSchedConf(), Validation.isDirector(), and Request.url().

Referenced by SubmissionCommentsHandler.emailDirectorDecisionComment().

TrackDirectorAction.makeReviewerFileViewable	(	$	paperId,
		$	reviewId,
		$	fileId,
		$	revision,
		$	viewable = false
	)

Makes a reviewer's annotated version of a paper available to the author.

Parameters:

	$paperId	int
	$reviewId	int
	$viewable	boolean

Definition at line 641 of file TrackDirectorAction.inc.php.

Referenced by SubmissionEditHandler.makeReviewerFileViewable().

TrackDirectorAction.notifyReviewer	(	$	trackDirectorSubmission,
		$	reviewId,
		$	send = false
	)

Notifies a reviewer about a review assignment.

Parameters:

	$trackDirectorSubmission	object
	$reviewId	int

Returns:

boolean true iff ready for redirect

Definition at line 274 of file TrackDirectorAction.inc.php.

References Validation.generatePasswordResetHash(), Request.getConference(), Request.getSchedConf(), and Request.url().

Referenced by SubmissionEditHandler.notifyReviewer().

TrackDirectorAction.orderGalley	(	$	paper,
		$	galleyId,
		$	direction
	)

Change the sequence order of a galley.

Parameters:

	$paper	object
	$galleyId	int
	$direction	char u = up, d = down

Definition at line 1097 of file TrackDirectorAction.inc.php.

Referenced by SubmissionEditHandler.orderGalley().

TrackDirectorAction.orderSuppFile	(	$	paper,
		$	suppFileId,
		$	direction
	)

Change the sequence order of a supplementary file.

Parameters:

	$paper	object
	$suppFileId	int
	$direction	char u = up, d = down

Definition at line 1144 of file TrackDirectorAction.inc.php.

Referenced by SubmissionEditHandler.orderSuppFile().

TrackDirectorAction.postDirectorDecisionComment	(	$	paper,
		$	emailComment
	)

Post director decision comment.

Parameters:

	$paper	int
	$emailComment	boolean

Definition at line 1413 of file TrackDirectorAction.inc.php.

References Validation.isDirector(), and Request.url().

Referenced by SubmissionCommentsHandler.postDirectorDecisionComment().

TrackDirectorAction.postPeerReviewComment	(	&$	paper,
		$	reviewId,
		$	emailComment
	)

Post reviewer comments.

Parameters:

	$paper	object
	$reviewId	int
	$emailComment	boolean

Definition at line 1360 of file TrackDirectorAction.inc.php.

References Validation.isDirector(), and Request.url().

Referenced by SubmissionCommentsHandler.postPeerReviewComment().

TrackDirectorAction.rateReviewer	(	$	paperId,
		$	reviewId,
		$	quality = null
	)

Rates a reviewer for quality of a review.

Parameters:

	$paperId	int
	$reviewId	int
	$quality	int

Definition at line 607 of file TrackDirectorAction.inc.php.

References PaperLog.logEvent().

Referenced by SubmissionEditHandler.rateReviewer().

TrackDirectorAction.recordDecision	(	$	trackDirectorSubmission,
		$	decision,
		$	stage
	)

Records a director's submission decision.

Parameters:

	$trackDirectorSubmission	object
	$decision	int
	$stage	int

Definition at line 63 of file TrackDirectorAction.inc.php.

References completeReview(), TrackDirectorSubmission.getDirectorDecisionOptions(), and PaperLog.logEvent().

Referenced by SubmissionEditHandler.recordDecision().

TrackDirectorAction.remindReviewer	(	$	trackDirectorSubmission,
		$	reviewId,
		$	send = false
	)

Reminds a reviewer about a review assignment.

Parameters:

	$trackDirectorSubmission	object
	$reviewId	int

Returns:

boolean true iff no error was encountered

Definition at line 448 of file TrackDirectorAction.inc.php.

References Validation.generatePasswordResetHash(), Request.getConference(), Request.getSchedConf(), and Request.url().

Referenced by SubmissionEditHandler.remindReviewer().

TrackDirectorAction.removeSubmissionNote

(

$

paperId

)

Remove Submission Note

Parameters:

$paperId

int

Definition at line 1251 of file TrackDirectorAction.inc.php.

Referenced by SubmissionEditHandler.removeSubmissionNote().

TrackDirectorAction.restoreToQueue

(

$

trackDirectorSubmission

)

Restores a submission to the queue.

Parameters:

$trackDirectorSubmission

object

Definition at line 1061 of file TrackDirectorAction.inc.php.

References PaperLog.logEvent().

Referenced by SubmissionEditHandler.restoreToQueue().

TrackDirectorAction.setDueDate	(	$	paperId,
		$	reviewId,
		$	dueDate = null,
		$	numWeeks = null,
		$	logChange = true
	)

Sets the due date for a review assignment.

Parameters:

	$paperId	int
	$reviewId	int
	$dueDate	string
	$numWeeks	int
	$logChange	boolean

Definition at line 662 of file TrackDirectorAction.inc.php.

References PaperLog.logEvent().

Referenced by addReviewer(), and SubmissionEditHandler.setDueDate().

TrackDirectorAction.setEditingFile	(	$	trackDirectorSubmission,
		$	fileId,
		$	revision,
		$	createGalley = false
	)

Set the file to use as the default editing file.

Parameters:

	$trackDirectorSubmission	object
	$fileId	int
	$revision	int
	$createGalley	boolean TODO: SECURITY!

Definition at line 869 of file TrackDirectorAction.inc.php.

References AppLocale.getLocale(), and PaperLog.logEvent().

Referenced by SubmissionEditHandler.directorReview().

TrackDirectorAction.setReviewerRecommendation	(	$	paperId,
		$	reviewId,
		$	recommendation,
		$	acceptOption
	)

Sets the reviewer recommendation for a review assignment. Also concatenates the reviewer and director comments from Peer Review and adds them to Director Review.

Parameters:

	$paperId	int
	$reviewId	int
	$recommendation	int

Definition at line 763 of file TrackDirectorAction.inc.php.

References PaperLog.logEvent().

Referenced by SubmissionEditHandler.enterReviewerRecommendation().

TrackDirectorAction.submissionBreadcrumb	(	$	paperId,
		$	parentPage,
		$	track
	)

Helper method for building submission breadcrumb

Parameters:

	$paperId
	$parentPage	name of submission component

Returns:

array

Definition at line 1774 of file TrackDirectorAction.inc.php.

References Request.url().

Referenced by TrackDirectorHandler.setupTemplate(), DirectorHandler.setupTemplate(), and AuthorHandler.setupTemplate().

TrackDirectorAction.thankReviewer	(	$	trackDirectorSubmission,
		$	reviewId,
		$	send = false
	)

Thanks a reviewer for completing a review assignment.

Parameters:

	$trackDirectorSubmission	object
	$reviewId	int

Returns:

boolean true iff ready for redirect

Definition at line 557 of file TrackDirectorAction.inc.php.

References Request.getConference(), and Request.url().

Referenced by SubmissionEditHandler.thankReviewer().

TrackDirectorAction.TrackDirectorAction

(

)

Constructor.

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

TrackDirectorAction.unsuitableSubmission	(	$	trackDirectorSubmission,
		$	send = false
	)

Notifies an author that a submission was unsuitable.

Parameters:

$trackDirectorSubmission

object

Returns:

boolean true iff ready for redirect

Definition at line 719 of file TrackDirectorAction.inc.php.

References archiveSubmission(), Request.getConference(), Request.getSchedConf(), and Request.url().

Referenced by SubmissionEditHandler.unsuitableSubmission().

TrackDirectorAction.updateCommentsStatus	(	$	submission,
		$	commentsStatus
	)

Changes the submission RT comments status.

Parameters:

	$submission	object
	$commentsStatus	int

Definition at line 1760 of file TrackDirectorAction.inc.php.

Referenced by SubmissionEditHandler.updateCommentsStatus().

TrackDirectorAction.updateSubmissionNote

(

$

paperId

)

Updates Submission Note

Parameters:

$paperId

int

Definition at line 1272 of file TrackDirectorAction.inc.php.

Referenced by SubmissionEditHandler.updateSubmissionNote().

TrackDirectorAction.uploadDirectorVersion

(

$

trackDirectorSubmission

)

Upload the post-review version of a paper.

Parameters:

$trackDirectorSubmission

object

Definition at line 957 of file TrackDirectorAction.inc.php.

References PaperLog.logEvent().

Referenced by SubmissionEditHandler.directorReview().

TrackDirectorAction.uploadReviewForReviewer

(

$

reviewId

)

Upload a review on behalf of its reviewer.

Parameters:

$reviewId

int

Definition at line 1700 of file TrackDirectorAction.inc.php.

References PaperLog.logEventEntry().

Referenced by SubmissionEditHandler.uploadReviewForReviewer().

TrackDirectorAction.uploadReviewVersion

(

$

trackDirectorSubmission

)

Upload the review version of a paper.

Parameters:

$trackDirectorSubmission

object

Definition at line 924 of file TrackDirectorAction.inc.php.

Referenced by SubmissionEditHandler.uploadReviewVersion().

TrackDirectorAction.viewDirectorDecisionComments

(

$

paper

)

View director decision comments.

Parameters:

$paper

object

Definition at line 1398 of file TrackDirectorAction.inc.php.

References Validation.isDirector().

Referenced by SubmissionCommentsHandler.postDirectorDecisionComment(), and SubmissionCommentsHandler.viewDirectorDecisionComments().

TrackDirectorAction.viewPeerReviewComments	(	&$	paper,
		$	reviewId
	)

View reviewer comments.

Parameters:

	$paper	object
	$reviewId	int

Definition at line 1344 of file TrackDirectorAction.inc.php.

References Validation.isDirector().

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

TrackDirectorAction.viewReviewFormResponse	(	$	trackDirectorSubmission,
		$	reviewId
	)

View review form response.

Parameters:

	$trackDirectorSubmission	object
	$reviewId	int

Definition at line 844 of file TrackDirectorAction.inc.php.

Referenced by SubmissionEditHandler.viewReviewFormResponse().

---

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

• classes/submission/trackDirector/TrackDirectorAction.inc.php

---