SubmissionEditHandler Class Reference
[Pages_trackDirector]

Handle requests for submission tracking. More...

Inheritance diagram for SubmissionEditHandler:

List of all members.

Public Member Functions
	addSubmissionNote ()
	addSuppFile ($args)
	archiveSubmission ($args)
	cancelReview ($args)
	changeSessionType ()
	changeTrack ()
	clearAllSubmissionNotes ()
	clearReview ($args)
	clearReviewForm ($args)
	clearSubmissionEmailLog ($args)
	clearSubmissionEventLog ($args)
	completePaper ($args)
	confirmReviewForReviewer ($args)
	createReviewer ($args)
	deleteGalley ($args)
	deletePaperFile ($args)
	deletePaperImage ($args)
	deleteSuppFile ($args)
	directorReview ($args)
	downloadFile ($args)
	editGalley ($args)
	editSuppFile ($args)
	enroll ($args)
	enrollSearch ($args)
	enterReviewerRecommendation ($args)
	makeReviewerFileViewable ()
	notifyReviewer ($args=array())
	orderGalley ()
	orderSuppFile ()
	previewReviewForm ($args)
	proofGalley ($args)
	proofGalleyFile ($args)
	proofGalleyTop ($args)
	rateReviewer ()
	recordDecision ($args)
	remindReviewer ($args=null)
	removeSubmissionNote ()
	restoreToQueue ($args)
	saveGalley ($args)
	saveMetadata ()
	saveSuppFile ($args)
	selectReviewer ($args)
	selectReviewForm ($args)
	setDueDate ($args)
	setSuppFileVisibility ($args)
	submission ($args)
	SubmissionEditHandler ()
	submissionEmailLog ($args)
	submissionEmailLogType ($args)
	submissionEventLog ($args)
	submissionEventLogType ($args)
	submissionHistory ($args)
	submissionNotes ($args)
	submissionRegrets ($args)
	submissionReview ($args)
	suggestUsername ()
	thankReviewer ($args=array())
	unsuitableSubmission ($args)
	updateCommentsStatus ($args)
	updateSubmissionNote ()
	uploadGalley ($fileName=null, $stage=null)
	uploadLayoutFile ()
	uploadReviewForReviewer ($args)
	uploadReviewVersion ()
	uploadSuppFile ($fileName=null, $stage=null)
	userProfile ($args)
	validate ($paperId, $access=null)
	viewFile ($args)
	viewMetadata ($args)
	viewReviewFormResponse ($args)
Public Attributes
	$submission

---

Detailed Description

Handle requests for submission tracking.

Definition at line 24 of file SubmissionEditHandler.inc.php.

---

Member Function Documentation

SubmissionEditHandler.addSubmissionNote

(

)

Creates a submission note. Redirects to submission notes list

Definition at line 1706 of file SubmissionEditHandler.inc.php.

References TrackDirectorAction.addSubmissionNote(), Request.redirect(), submissionNotes(), and TrackDirectorHandler.validate().

SubmissionEditHandler.addSuppFile

(

$

args

)

Add a supplementary file.

Parameters:

$args

array ($paperId)

Definition at line 1063 of file SubmissionEditHandler.inc.php.

References $submission, TrackDirectorHandler.setupTemplate(), submission(), and TrackDirectorHandler.validate().

SubmissionEditHandler.changeSessionType

(

)

Change the session type for a submission.

Definition at line 337 of file SubmissionEditHandler.inc.php.

References $submission, TrackDirectorAction.changeSessionType(), Request.getConference(), Request.getSchedConf(), Request.redirect(), submission(), and TrackDirectorHandler.validate().

SubmissionEditHandler.changeTrack

(

)

Change the track a submission is currently in.

Definition at line 320 of file SubmissionEditHandler.inc.php.

References $submission, TrackDirectorAction.changeTrack(), Request.getConference(), Request.getSchedConf(), Request.redirect(), submission(), and TrackDirectorHandler.validate().

SubmissionEditHandler.clearAllSubmissionNotes

(

)

Clear all submission notes. Redirects to submission notes list

Definition at line 1742 of file SubmissionEditHandler.inc.php.

References TrackDirectorAction.clearAllSubmissionNotes(), Request.redirect(), submissionNotes(), and TrackDirectorHandler.validate().

SubmissionEditHandler.clearReviewForm

(

$

args

)

Clear a review form, i.e. remove review form assignment to the review.

Parameters:

$args

array ($paperId, $reviewId)

Definition at line 953 of file SubmissionEditHandler.inc.php.

References $submission, TrackDirectorAction.clearReviewForm(), Request.redirect(), submission(), submissionReview(), and TrackDirectorHandler.validate().

SubmissionEditHandler.clearSubmissionEmailLog

(

$

args

)

Clear submission email log entries.

Definition at line 1683 of file SubmissionEditHandler.inc.php.

References Request.redirect(), submissionEmailLog(), and TrackDirectorHandler.validate().

SubmissionEditHandler.clearSubmissionEventLog

(

$

args

)

Clear submission event log entries.

Definition at line 1591 of file SubmissionEditHandler.inc.php.

References $submission, Request.redirect(), submission(), submissionEventLog(), and TrackDirectorHandler.validate().

SubmissionEditHandler.createReviewer

(

$

args

)

Create a new user as a reviewer.

Definition at line 491 of file SubmissionEditHandler.inc.php.

References $submission, Request.getConference(), Request.getSchedConf(), Request.redirect(), selectReviewer(), TrackDirectorHandler.setupTemplate(), submission(), and TrackDirectorHandler.validate().

SubmissionEditHandler.deleteGalley

(

$

args

)

Delete a galley file.

Parameters:

$args

array ($paperId, $galleyId)

Definition at line 1403 of file SubmissionEditHandler.inc.php.

References $submission, TrackDirectorAction.deleteGalley(), Request.redirect(), submission(), submissionReview(), and TrackDirectorHandler.validate().

SubmissionEditHandler.deletePaperFile

(

$

args

)

Delete a director version file.

Parameters:

$args

array ($paperId, $fileId)

Definition at line 1168 of file SubmissionEditHandler.inc.php.

References $submission, TrackDirectorAction.deletePaperFile(), Request.redirect(), submission(), submissionReview(), and TrackDirectorHandler.validate().

SubmissionEditHandler.deletePaperImage

(

$

args

)

Delete a paper image.

Parameters:

$args

array ($paperId, $fileId)

Definition at line 1279 of file SubmissionEditHandler.inc.php.

References $submission, TrackDirectorAction.deletePaperImage(), editGalley(), Request.redirect(), submission(), and TrackDirectorHandler.validate().

SubmissionEditHandler.deleteSuppFile

(

$

args

)

Delete a supplementary file.

Parameters:

$args

array ($paperId, $suppFileId)

Definition at line 1184 of file SubmissionEditHandler.inc.php.

References $submission, TrackDirectorAction.deleteSuppFile(), Request.redirect(), submission(), submissionReview(), and TrackDirectorHandler.validate().

SubmissionEditHandler.downloadFile

(

$

args

)

Download a file.

Parameters:

$args

array ($paperId, $fileId, [$revision])

Definition at line 1804 of file SubmissionEditHandler.inc.php.

References Action.downloadFile(), Request.redirect(), submission(), and TrackDirectorHandler.validate().

SubmissionEditHandler.editGalley

(

$

args

)

Edit a galley.

Parameters:

$args

array ($paperId, $galleyId)

Definition at line 1316 of file SubmissionEditHandler.inc.php.

References $submission, TrackDirectorHandler.setupTemplate(), submission(), and TrackDirectorHandler.validate().

Referenced by deletePaperImage(), saveGalley(), and uploadGalley().

SubmissionEditHandler.editSuppFile

(

$

args

)

Edit a supplementary file.

Parameters:

$args

array ($paperId, $suppFileId)

Definition at line 1085 of file SubmissionEditHandler.inc.php.

References $submission, TrackDirectorHandler.setupTemplate(), submission(), and TrackDirectorHandler.validate().

Referenced by uploadSuppFile().

SubmissionEditHandler.enrollSearch

(

$

args

)

Search for users to enroll as reviewers.

Definition at line 541 of file SubmissionEditHandler.inc.php.

References $submission, Request.getConference(), Request.getSchedConf(), TrackDirectorHandler.setupTemplate(), submission(), and TrackDirectorHandler.validate().

SubmissionEditHandler.orderGalley

(

)

Change the sequence order of a galley.

Definition at line 1388 of file SubmissionEditHandler.inc.php.

References $submission, TrackDirectorAction.orderGalley(), Request.redirect(), submission(), submissionReview(), and TrackDirectorHandler.validate().

SubmissionEditHandler.orderSuppFile

(

)

Change the sequence order of a supplementary file.

Definition at line 1501 of file SubmissionEditHandler.inc.php.

References $submission, TrackDirectorAction.orderSuppFile(), Request.redirect(), submission(), submissionReview(), and TrackDirectorHandler.validate().

SubmissionEditHandler.previewReviewForm

(

$

args

)

Preview a review form.

Parameters:

$args

array ($reviewId, $reviewFormId)

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

References Request.getConference(), and TrackDirectorHandler.setupTemplate().

SubmissionEditHandler.proofGalley

(

$

args

)

Proof / "preview" a galley.

Parameters:

$args

array ($paperId, $galleyId)

Definition at line 1418 of file SubmissionEditHandler.inc.php.

References submission(), and TrackDirectorHandler.validate().

SubmissionEditHandler.proofGalleyFile

(

$

args

)

Proof galley (outputs file contents).

Parameters:

$args

array ($paperId, $galleyId)

Definition at line 1449 of file SubmissionEditHandler.inc.php.

References submission(), Request.url(), TrackDirectorHandler.validate(), and viewFile().

SubmissionEditHandler.proofGalleyTop

(

$

args

)

Proof galley (shows frame header).

Parameters:

$args

array ($paperId, $galleyId)

Definition at line 1433 of file SubmissionEditHandler.inc.php.

References submission(), submissionReview(), and TrackDirectorHandler.validate().

SubmissionEditHandler.removeSubmissionNote

(

)

Removes a submission note. Redirects to submission notes list

Definition at line 1718 of file SubmissionEditHandler.inc.php.

References Request.redirect(), TrackDirectorAction.removeSubmissionNote(), submissionNotes(), and TrackDirectorHandler.validate().

SubmissionEditHandler.saveGalley

(

$

args

)

Save changes to a galley.

Parameters:

$args

array ($paperId, $galleyId)

Definition at line 1341 of file SubmissionEditHandler.inc.php.

References $submission, editGalley(), Request.redirect(), TrackDirectorHandler.setupTemplate(), submission(), submissionReview(), Request.url(), and TrackDirectorHandler.validate().

SubmissionEditHandler.saveSuppFile

(

$

args

)

Save a supplementary file.

Parameters:

$args

array ($suppFileId)

Definition at line 1128 of file SubmissionEditHandler.inc.php.

References $submission, Request.redirect(), TrackDirectorHandler.setupTemplate(), submission(), submissionReview(), Request.url(), and TrackDirectorHandler.validate().

SubmissionEditHandler.selectReviewForm

(

$

args

)

Select a review form

Parameters:

$args

array ($paperId, $reviewId, $reviewFormId)

Definition at line 968 of file SubmissionEditHandler.inc.php.

References $submission, TrackDirectorAction.addReviewForm(), Request.getConference(), Request.getSchedConf(), Request.redirect(), TrackDirectorHandler.setupTemplate(), submission(), submissionReview(), and TrackDirectorHandler.validate().

SubmissionEditHandler.setSuppFileVisibility

(

$

args

)

Set reviewer visibility for a supplementary file.

Parameters:

$args

array ($suppFileId)

Definition at line 1108 of file SubmissionEditHandler.inc.php.

References $submission, Request.redirect(), submission(), submissionReview(), and TrackDirectorHandler.validate().

SubmissionEditHandler.SubmissionEditHandler

(

)

Constructor

Definition at line 31 of file SubmissionEditHandler.inc.php.

SubmissionEditHandler.submissionEmailLog

(

$

args

)

View submission email log.

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

References $submission, PaperLog.getEmailLogEntries(), Validation.isDirector(), TrackDirectorHandler.setupTemplate(), submission(), and TrackDirectorHandler.validate().

Referenced by clearSubmissionEmailLog(), and submissionEmailLogType().

SubmissionEditHandler.submissionEmailLogType

(

$

args

)

View submission email log by record type.

Definition at line 1653 of file SubmissionEditHandler.inc.php.

References $submission, Validation.isDirector(), TrackDirectorHandler.setupTemplate(), submission(), submissionEmailLog(), and TrackDirectorHandler.validate().

SubmissionEditHandler.submissionEventLog

(

$

args

)

View submission event log.

Definition at line 1519 of file SubmissionEditHandler.inc.php.

References $submission, PaperLog.getEventLogEntries(), Validation.isDirector(), TrackDirectorHandler.setupTemplate(), submission(), and TrackDirectorHandler.validate().

Referenced by clearSubmissionEventLog(), and submissionEventLogType().

SubmissionEditHandler.submissionEventLogType

(

$

args

)

View submission event log by record type.

Definition at line 1560 of file SubmissionEditHandler.inc.php.

References $submission, Validation.isDirector(), TrackDirectorHandler.setupTemplate(), submission(), submissionEventLog(), and TrackDirectorHandler.validate().

SubmissionEditHandler.submissionHistory

(

$

args

)

View submission history

Definition at line 263 of file SubmissionEditHandler.inc.php.

References $submission, Request.getConference(), PaperLog.getEmailLogEntries(), PaperLog.getEventLogEntries(), Request.getSchedConf(), Validation.isDirector(), TrackDirectorHandler.setupTemplate(), submission(), submissionNotes(), and TrackDirectorHandler.validate().

SubmissionEditHandler.submissionNotes

(

$

args

)

View submission notes.

Definition at line 1753 of file SubmissionEditHandler.inc.php.

References $submission, TrackDirectorHandler.setupTemplate(), submission(), and TrackDirectorHandler.validate().

Referenced by addSubmissionNote(), clearAllSubmissionNotes(), removeSubmissionNote(), submissionHistory(), and updateSubmissionNote().

SubmissionEditHandler.suggestUsername

(

)

Get a suggested username, making sure it's not already used by the system. (Poor-man's AJAX.)

Definition at line 529 of file SubmissionEditHandler.inc.php.

References Validation.suggestUsername().

SubmissionEditHandler.updateCommentsStatus

(

$

args

)

Set RT comments status for paper.

Parameters:

$args

array ($paperId)

Definition at line 1232 of file SubmissionEditHandler.inc.php.

References $submission, Request.redirect(), submission(), TrackDirectorAction.updateCommentsStatus(), and TrackDirectorHandler.validate().

SubmissionEditHandler.updateSubmissionNote

(

)

Updates a submission note. Redirects to submission notes list

Definition at line 1730 of file SubmissionEditHandler.inc.php.

References Request.redirect(), submissionNotes(), TrackDirectorAction.updateSubmissionNote(), and TrackDirectorHandler.validate().

SubmissionEditHandler.uploadGalley	(	$	fileName = null,
		$	stage = null
	)

Create a new galley with the uploaded file.

Parameters:

	$fileName	string
	$stage	int

Definition at line 1298 of file SubmissionEditHandler.inc.php.

References $submission, editGalley(), Request.redirect(), submission(), and TrackDirectorHandler.validate().

Referenced by uploadLayoutFile().

SubmissionEditHandler.uploadLayoutFile

(

)

Upload a layout file (either layout version, galley, or supp. file).

Definition at line 1248 of file SubmissionEditHandler.inc.php.

References Request.redirect(), TrackDirectorHandler.setupTemplate(), submission(), submissionReview(), uploadGalley(), uploadSuppFile(), and Request.url().

SubmissionEditHandler.uploadSuppFile	(	$	fileName = null,
		$	stage = null
	)

Upload a new supplementary file.

Parameters:

	$fileName	string
	$stage	int

Definition at line 1482 of file SubmissionEditHandler.inc.php.

References $submission, editSuppFile(), Request.getConference(), AppLocale.getLocale(), Request.getSchedConf(), Request.redirect(), submission(), and TrackDirectorHandler.validate().

Referenced by uploadLayoutFile().

SubmissionEditHandler.userProfile

(

$

args

)

Display a user's profile.

Parameters:

$args

array first parameter is the ID or username of the user to display

Definition at line 856 of file SubmissionEditHandler.inc.php.

References TrackDirectorHandler.setupTemplate(), and Request.url().

SubmissionEditHandler.validate	(	$	paperId,
		$	access = null
	)

Validate that the user is the assigned track director for the paper, or is a managing director. Redirects to trackDirector index page if validation fails.

Parameters:

	$paperId	int Paper ID to validate
	$access	int Optional name of access level required -- see TRACK_DIRECTOR_ACCESS_... constants

Definition at line 1842 of file SubmissionEditHandler.inc.php.

References Request.getConference(), Request.getSchedConf(), Validation.isDirector(), Request.redirect(), and submission().

SubmissionEditHandler.viewFile

(

$

args

)

View a file (inlines file).

Parameters:

$args

array ($paperId, $fileId, [$revision])

Definition at line 1819 of file SubmissionEditHandler.inc.php.

References Request.redirect(), submission(), TrackDirectorHandler.validate(), and Action.viewFile().

Referenced by proofGalleyFile().

SubmissionEditHandler.viewReviewFormResponse

(

$

args

)

View review form response.

Parameters:

$args

array ($paperId, $reviewId)

Definition at line 1005 of file SubmissionEditHandler.inc.php.

References $submission, TrackDirectorHandler.setupTemplate(), submission(), TrackDirectorHandler.validate(), and TrackDirectorAction.viewReviewFormResponse().

---

Member Data Documentation

SubmissionEditHandler.$submission

submission associated with the request

Definition at line 26 of file SubmissionEditHandler.inc.php.

Referenced by addSuppFile(), archiveSubmission(), cancelReview(), changeSessionType(), changeTrack(), clearReview(), clearReviewForm(), clearSubmissionEventLog(), completePaper(), confirmReviewForReviewer(), createReviewer(), deleteGalley(), deletePaperFile(), deletePaperImage(), deleteSuppFile(), directorReview(), editGalley(), editSuppFile(), enroll(), enrollSearch(), enterReviewerRecommendation(), makeReviewerFileViewable(), notifyReviewer(), orderGalley(), orderSuppFile(), rateReviewer(), recordDecision(), remindReviewer(), restoreToQueue(), saveGalley(), saveMetadata(), saveSuppFile(), selectReviewer(), selectReviewForm(), setDueDate(), setSuppFileVisibility(), submission(), submissionEmailLog(), submissionEmailLogType(), submissionEventLog(), submissionEventLogType(), submissionHistory(), submissionNotes(), submissionRegrets(), submissionReview(), thankReviewer(), unsuitableSubmission(), updateCommentsStatus(), uploadGalley(), uploadReviewForReviewer(), uploadReviewVersion(), uploadSuppFile(), viewMetadata(), and viewReviewFormResponse().

---

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

• pages/trackDirector/SubmissionEditHandler.inc.php

---