SectionEditorAction Class Reference
[Submission]

SectionEditorAction class. More...

Inheritance diagram for SectionEditorAction:

List of all members.

Public Member Functions
	addReviewer ($sectionEditorSubmission, $reviewerId, $round=null)
	addReviewForm ($sectionEditorSubmission, $reviewId, $reviewFormId)
	addSubmissionNote ($articleId)
	archiveSubmission ($sectionEditorSubmission)
	assignLayoutEditor ($submission, $editorId)
	blindCcReviewsToReviewers ($article, $send=false, $inhibitExistingEmail=false)
	cancelReview ($sectionEditorSubmission, $reviewId, $send=false)
	changeSection ($sectionEditorSubmission, $sectionId)
	clearAllSubmissionNotes ($articleId)
	clearReview ($sectionEditorSubmission, $reviewId)
	clearReviewForm ($sectionEditorSubmission, $reviewId)
	completeCopyedit ($sectionEditorSubmission)
	completeFinalCopyedit ($sectionEditorSubmission)
	confirmReviewForReviewer ($reviewId, $accept)
	deleteArticleFile ($submission, $fileId, $revision)
	deleteArticleImage ($submission, $fileId, $revision)
	deleteGalley ($article, $galleyId)
	deleteSuppFile ($article, $suppFileId)
	emailEditorDecisionComment ($sectionEditorSubmission, $send)
	initiateCopyedit ($sectionEditorSubmission)
	makeReviewerFileViewable ($articleId, $reviewId, $fileId, $revision, $viewable=false)
	notifyAuthorCopyedit ($sectionEditorSubmission, $send=false)
	notifyCopyeditor ($sectionEditorSubmission, $send=false)
	notifyFinalCopyedit ($sectionEditorSubmission, $send=false)
	notifyLayoutEditor ($submission, $send=false)
	notifyReviewer ($sectionEditorSubmission, $reviewId, $send=false)
	orderGalley ($article, $galleyId, $direction)
	orderSuppFile ($article, $suppFileId, $direction)
	postCopyeditComment ($article, $emailComment)
	postEditorDecisionComment ($article, $emailComment)
	postLayoutComment ($article, $emailComment)
	postPeerReviewComment (&$article, $reviewId, $emailComment)
	postProofreadComment ($article, $emailComment)
	rateReviewer ($articleId, $reviewId, $quality=null)
	recordDecision ($sectionEditorSubmission, $decision)
	remindReviewer ($sectionEditorSubmission, $reviewId, $send=false)
	removeSubmissionNote ($articleId)
	restoreToQueue ($sectionEditorSubmission)
	resubmitFile ($sectionEditorSubmission, $fileId, $revision)
	SectionEditorAction ()
	selectCopyeditor ($sectionEditorSubmission, $copyeditorId)
	setCopyeditFile ($sectionEditorSubmission, $fileId, $revision)
	setDueDate ($articleId, $reviewId, $dueDate=null, $numWeeks=null)
	setReviewerRecommendation ($articleId, $reviewId, $recommendation, $acceptOption)
	submissionBreadcrumb ($articleId, $parentPage, $section)
	thankAuthorCopyedit ($sectionEditorSubmission, $send=false)
	thankCopyeditor ($sectionEditorSubmission, $send=false)
	thankFinalCopyedit ($sectionEditorSubmission, $send=false)
	thankLayoutEditor ($submission, $send=false)
	thankReviewer ($sectionEditorSubmission, $reviewId, $send=false)
	unsuitableSubmission ($sectionEditorSubmission, $send=false)
	updateCommentsStatus ($submission, $commentsStatus)
	updateSection ($submission, $sectionId)
	updateSubmissionNote ($articleId)
	uploadCopyeditVersion ($sectionEditorSubmission, $copyeditStage)
	uploadEditorVersion ($sectionEditorSubmission)
	uploadLayoutVersion ($submission)
	uploadReviewForReviewer ($reviewId)
	uploadReviewVersion ($sectionEditorSubmission)
	viewCopyeditComments ($article)
	viewEditorDecisionComments ($article)
	viewLayoutComments ($article)
	viewPeerReviewComments (&$article, $reviewId)
	viewProofreadComments ($article)
	viewReviewFormResponse ($sectionEditorSubmission, $reviewId)

---

Detailed Description

SectionEditorAction class.

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

---

Member Function Documentation

SectionEditorAction.addReviewer	(	$	sectionEditorSubmission,
		$	reviewerId,
		$	round = null
	)

Assigns a reviewer to a submission.

Parameters:

	$sectionEditorSubmission	object
	$reviewerId	int

Definition at line 83 of file SectionEditorAction.inc.php.

References HookRegistry.call(), Core.getCurrentDate(), DAORegistry.getDAO(), Request.getJournal(), Request.getUser(), ArticleLog.logEvent(), and setDueDate().

Referenced by resubmitFile().

SectionEditorAction.addReviewForm	(	$	sectionEditorSubmission,
		$	reviewId,
		$	reviewFormId
	)

Assigns a review form to a review.

Parameters:

	$sectionEditorSubmission	object
	$reviewId	int
	$reviewFormId	int

Definition at line 696 of file SectionEditorAction.inc.php.

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

Referenced by SubmissionEditHandler.selectReviewForm().

SectionEditorAction.addSubmissionNote

(

$

articleId

)

Add Submission Note

Parameters:

$articleId

int

Definition at line 1607 of file SectionEditorAction.inc.php.

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

Referenced by SubmissionEditHandler.addSubmissionNote().

SectionEditorAction.archiveSubmission

(

$

sectionEditorSubmission

)

Archive a submission.

Parameters:

$sectionEditorSubmission

object

Definition at line 1304 of file SectionEditorAction.inc.php.

References HookRegistry.call(), DAORegistry.getDAO(), Request.getUser(), and ArticleLog.logEvent().

Referenced by unsuitableSubmission().

SectionEditorAction.assignLayoutEditor	(	$	submission,
		$	editorId
	)

Assign a layout editor to a submission.

Parameters:

	$submission	object
	$editorId	int user ID of the new layout editor

Definition at line 1406 of file SectionEditorAction.inc.php.

References HookRegistry.call(), DAORegistry.getDAO(), and ArticleLog.logEvent().

Referenced by SubmissionEditHandler.assignLayoutEditor().

SectionEditorAction.blindCcReviewsToReviewers	(	$	article,
		$	send = false,
		$	inhibitExistingEmail = false
	)

Blind CC the reviews to reviewers.

Parameters:

	$article	object
	$send	boolean
	$inhibitExistingEmail	boolean

Returns:

boolean true iff ready for redirect

Definition at line 1910 of file SectionEditorAction.inc.php.

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

Referenced by SubmissionCommentsHandler.blindCcReviewsToReviewers().

SectionEditorAction.cancelReview	(	$	sectionEditorSubmission,
		$	reviewId,
		$	send = false
	)

Cancels a review.

Parameters:

	$sectionEditorSubmission	object
	$reviewId	int

Returns:

boolean true iff ready for redirect

Definition at line 283 of file SectionEditorAction.inc.php.

References HookRegistry.call(), Core.getCurrentDate(), DAORegistry.getDAO(), Request.getJournal(), Request.getUser(), Request.getUserVar(), ArticleLog.logEvent(), and Request.url().

SectionEditorAction.changeSection	(	$	sectionEditorSubmission,
		$	sectionId
	)

Actions. Changes the section an article belongs in.

Parameters:

	$sectionEditorSubmission	int
	$sectionId	int

Definition at line 38 of file SectionEditorAction.inc.php.

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

SectionEditorAction.clearAllSubmissionNotes

(

$

articleId

)

Clear All Submission Notes

Parameters:

$articleId

int

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

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

Referenced by SubmissionEditHandler.clearAllSubmissionNotes().

SectionEditorAction.clearReview	(	$	sectionEditorSubmission,
		$	reviewId
	)

Clears a review assignment from a submission.

Parameters:

	$sectionEditorSubmission	object
	$reviewId	int

Definition at line 142 of file SectionEditorAction.inc.php.

References HookRegistry.call(), DAORegistry.getDAO(), Request.getUser(), and ArticleLog.logEvent().

SectionEditorAction.clearReviewForm	(	$	sectionEditorSubmission,
		$	reviewId
	)

Clear a review form

Parameters:

	$sectionEditorSubmission	object
	$reviewId	int

Definition at line 673 of file SectionEditorAction.inc.php.

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

Referenced by SubmissionEditHandler.clearReviewForm().

SectionEditorAction.completeCopyedit

(

$

sectionEditorSubmission

)

Editor completes initial copyedit (copyeditors disabled).

Parameters:

$sectionEditorSubmission

object

Definition at line 1243 of file SectionEditorAction.inc.php.

References HookRegistry.call(), Core.getCurrentDate(), DAORegistry.getDAO(), Request.getJournal(), Request.getUser(), and ArticleLog.logEvent().

SectionEditorAction.completeFinalCopyedit

(

$

sectionEditorSubmission

)

Section editor completes final copyedit (copyeditors disabled).

Parameters:

$sectionEditorSubmission

object

Definition at line 1266 of file SectionEditorAction.inc.php.

References HookRegistry.call(), Core.getCurrentDate(), DAORegistry.getDAO(), Request.getJournal(), Request.getUser(), and ArticleLog.logEvent().

SectionEditorAction.confirmReviewForReviewer	(	$	reviewId,
		$	accept
	)

Confirms the review assignment on behalf of its reviewer.

Parameters:

	$reviewId	int
	$accept	boolean True === accept; false === decline

Definition at line 2083 of file SectionEditorAction.inc.php.

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

SectionEditorAction.deleteArticleFile	(	$	submission,
		$	fileId,
		$	revision
	)

Delete a file from an article.

Parameters:

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

Definition at line 1571 of file SectionEditorAction.inc.php.

References HookRegistry.call().

Referenced by SubmissionEditHandler.deleteArticleFile().

SectionEditorAction.deleteArticleImage	(	$	submission,
		$	fileId,
		$	revision
	)

Delete an image from an article galley.

Parameters:

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

Definition at line 1587 of file SectionEditorAction.inc.php.

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

Referenced by SubmissionEditHandler.deleteArticleImage().

SectionEditorAction.deleteGalley	(	$	article,
		$	galleyId
	)

Delete a galley.

Parameters:

	$article	object
	$galleyId	int

Definition at line 1539 of file SectionEditorAction.inc.php.

References LayoutEditorAction.deleteGalley().

Referenced by SubmissionEditHandler.deleteGalley().

SectionEditorAction.deleteSuppFile	(	$	article,
		$	suppFileId
	)

Delete a supplementary file.

Parameters:

	$article	object
	$suppFileId	int

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

References LayoutEditorAction.deleteSuppFile().

Referenced by SubmissionEditHandler.deleteSuppFile().

SectionEditorAction.emailEditorDecisionComment	(	$	sectionEditorSubmission,
		$	send
	)

Email editor decision comment.

Parameters:

	$sectionEditorSubmission	object
	$send	boolean

Definition at line 1814 of file SectionEditorAction.inc.php.

References HookRegistry.call(), Core.getCurrentDate(), DAORegistry.getDAO(), Request.getJournal(), Request.getUser(), Request.getUserVar(), Validation.isEditor(), Locale.translate(), and Request.url().

Referenced by SubmissionCommentsHandler.emailEditorDecisionComment().

SectionEditorAction.initiateCopyedit

(

$

sectionEditorSubmission

)

Initiates the initial copyedit stage when the editor does the copyediting.

Parameters:

$sectionEditorSubmission

object

Definition at line 908 of file SectionEditorAction.inc.php.

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

SectionEditorAction.makeReviewerFileViewable	(	$	articleId,
		$	reviewId,
		$	fileId,
		$	revision,
		$	viewable = false
	)

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

Parameters:

	$articleId	int
	$reviewId	int
	$viewable	boolean

Definition at line 523 of file SectionEditorAction.inc.php.

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

SectionEditorAction.notifyAuthorCopyedit	(	$	sectionEditorSubmission,
		$	send = false
	)

Notifies the author that the copyedit is complete.

Parameters:

$sectionEditorSubmission

object

Returns:

true iff ready for redirect

Definition at line 964 of file SectionEditorAction.inc.php.

References HookRegistry.call(), Core.getCurrentDate(), DAORegistry.getDAO(), Request.getJournal(), Request.getUser(), Request.getUserVar(), and Request.url().

SectionEditorAction.notifyCopyeditor	(	$	sectionEditorSubmission,
		$	send = false
	)

Notifies a copyeditor about a copyedit assignment.

Parameters:

$sectionEditorSubmission

object

Returns:

boolean true iff ready for redirect

Definition at line 862 of file SectionEditorAction.inc.php.

References HookRegistry.call(), Core.getCurrentDate(), DAORegistry.getDAO(), Request.getJournal(), Request.getUser(), Request.getUserVar(), and Request.url().

SectionEditorAction.notifyFinalCopyedit	(	$	sectionEditorSubmission,
		$	send = false
	)

Notify copyeditor about final copyedit.

Parameters:

	$sectionEditorSubmission	object
	$send	boolean

Returns:

boolean true iff ready for redirect

Definition at line 1054 of file SectionEditorAction.inc.php.

References HookRegistry.call(), Core.getCurrentDate(), DAORegistry.getDAO(), Request.getJournal(), Request.getUser(), Request.getUserVar(), and Request.url().

SectionEditorAction.notifyLayoutEditor	(	$	submission,
		$	send = false
	)

Notifies the current layout editor about an assignment.

Parameters:

	$submission	object
	$send	boolean

Returns:

boolean true iff ready for redirect

Definition at line 1437 of file SectionEditorAction.inc.php.

References HookRegistry.call(), Core.getCurrentDate(), DAORegistry.getDAO(), Request.getJournal(), Request.getUser(), Request.getUserVar(), and Request.url().

Referenced by SubmissionEditHandler.notifyLayoutEditor().

SectionEditorAction.notifyReviewer	(	$	sectionEditorSubmission,
		$	reviewId,
		$	send = false
	)

Notifies a reviewer about a review assignment.

Parameters:

	$sectionEditorSubmission	object
	$reviewId	int

Returns:

boolean true iff ready for redirect

Definition at line 169 of file SectionEditorAction.inc.php.

References HookRegistry.call(), Validation.generatePasswordResetHash(), Core.getCurrentDate(), DAORegistry.getDAO(), Request.getJournal(), Request.getUser(), Request.getUserVar(), Config.getVar(), Locale.translate(), and Request.url().

SectionEditorAction.orderGalley	(	$	article,
		$	galleyId,
		$	direction
	)

Change the sequence order of a galley.

Parameters:

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

Definition at line 1529 of file SectionEditorAction.inc.php.

References LayoutEditorAction.orderGalley().

Referenced by SubmissionEditHandler.orderGalley().

SectionEditorAction.orderSuppFile	(	$	article,
		$	suppFileId,
		$	direction
	)

Change the sequence order of a supplementary file.

Parameters:

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

Definition at line 1550 of file SectionEditorAction.inc.php.

References LayoutEditorAction.orderSuppFile().

Referenced by SubmissionEditHandler.orderSuppFile().

SectionEditorAction.postCopyeditComment	(	$	article,
		$	emailComment
	)

Post copyedit comment.

Parameters:

	$article	object
	$emailComment	boolean

Definition at line 1974 of file SectionEditorAction.inc.php.

References HookRegistry.call(), and Validation.isEditor().

Referenced by SubmissionCommentsHandler.postCopyeditComment().

SectionEditorAction.postEditorDecisionComment	(	$	article,
		$	emailComment
	)

Post editor decision comment.

Parameters:

	$article	int
	$emailComment	boolean

Definition at line 1788 of file SectionEditorAction.inc.php.

References HookRegistry.call(), and Validation.isEditor().

Referenced by SubmissionCommentsHandler.postEditorDecisionComment().

SectionEditorAction.postLayoutComment	(	$	article,
		$	emailComment
	)

Post layout comment.

Parameters:

	$article	object
	$emailComment	boolean

Definition at line 2015 of file SectionEditorAction.inc.php.

References HookRegistry.call(), and Validation.isEditor().

Referenced by SubmissionCommentsHandler.postLayoutComment().

SectionEditorAction.postPeerReviewComment	(	&$	article,
		$	reviewId,
		$	emailComment
	)

Post reviewer comments.

Parameters:

	$article	object
	$reviewId	int
	$emailComment	boolean

Definition at line 1747 of file SectionEditorAction.inc.php.

References HookRegistry.call(), and Validation.isEditor().

Referenced by SubmissionCommentsHandler.postPeerReviewComment().

SectionEditorAction.postProofreadComment	(	$	article,
		$	emailComment
	)

Post proofread comment.

Parameters:

	$article	object
	$emailComment	boolean

Definition at line 2056 of file SectionEditorAction.inc.php.

References HookRegistry.call(), and Validation.isEditor().

Referenced by SubmissionCommentsHandler.postProofreadComment().

SectionEditorAction.rateReviewer	(	$	articleId,
		$	reviewId,
		$	quality = null
	)

Rates a reviewer for quality of a review.

Parameters:

	$articleId	int
	$reviewId	int
	$quality	int

Definition at line 489 of file SectionEditorAction.inc.php.

References HookRegistry.call(), Core.getCurrentDate(), DAORegistry.getDAO(), Request.getUser(), and ArticleLog.logEvent().

SectionEditorAction.recordDecision	(	$	sectionEditorSubmission,
		$	decision
	)

Records an editor's submission decision.

Parameters:

	$sectionEditorSubmission	object
	$decision	int

Definition at line 51 of file SectionEditorAction.inc.php.

References HookRegistry.call(), Core.getCurrentDate(), DAORegistry.getDAO(), SectionEditorSubmission.getEditorDecisionOptions(), Request.getUser(), ArticleLog.logEvent(), and Locale.translate().

Referenced by EditorAction.expediteSubmission().

SectionEditorAction.remindReviewer	(	$	sectionEditorSubmission,
		$	reviewId,
		$	send = false
	)

Reminds a reviewer about a review assignment.

Parameters:

	$sectionEditorSubmission	object
	$reviewId	int

Returns:

boolean true iff no error was encountered

Definition at line 345 of file SectionEditorAction.inc.php.

References HookRegistry.call(), Validation.generatePasswordResetHash(), Core.getCurrentDate(), DAORegistry.getDAO(), Request.getJournal(), Request.getUser(), Request.getUserVar(), Config.getVar(), and Request.url().

SectionEditorAction.removeSubmissionNote

(

$

articleId

)

Remove Submission Note

Parameters:

$articleId

int

Definition at line 1639 of file SectionEditorAction.inc.php.

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

Referenced by SubmissionEditHandler.removeSubmissionNote().

SectionEditorAction.restoreToQueue

(

$

sectionEditorSubmission

)

Restores a submission to the queue.

Parameters:

$sectionEditorSubmission

object

Definition at line 1325 of file SectionEditorAction.inc.php.

References HookRegistry.call(), DAORegistry.getDAO(), and ArticleLog.logEvent().

SectionEditorAction.resubmitFile	(	$	sectionEditorSubmission,
		$	fileId,
		$	revision
	)

Resubmit the file for review.

Parameters:

	$sectionEditorSubmission	object
	$fileId	int
	$revision	int TODO: SECURITY!

Definition at line 776 of file SectionEditorAction.inc.php.

References addReviewer(), HookRegistry.call(), DAORegistry.getDAO(), Request.getUser(), and ArticleLog.logEvent().

SectionEditorAction.SectionEditorAction

(

)

Constructor.

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

SectionEditorAction.selectCopyeditor	(	$	sectionEditorSubmission,
		$	copyeditorId
	)

Assigns a copyeditor to a submission.

Parameters:

	$sectionEditorSubmission	object
	$copyeditorId	int

Definition at line 833 of file SectionEditorAction.inc.php.

References HookRegistry.call(), DAORegistry.getDAO(), Request.getUser(), and ArticleLog.logEvent().

SectionEditorAction.setCopyeditFile	(	$	sectionEditorSubmission,
		$	fileId,
		$	revision
	)

Set the file to use as the default copyedit file.

Parameters:

	$sectionEditorSubmission	object
	$fileId	int
	$revision	int TODO: SECURITY!

Definition at line 746 of file SectionEditorAction.inc.php.

References HookRegistry.call(), DAORegistry.getDAO(), Request.getUser(), and ArticleLog.logEvent().

Referenced by EditorAction.expediteSubmission().

SectionEditorAction.setDueDate	(	$	articleId,
		$	reviewId,
		$	dueDate = null,
		$	numWeeks = null
	)

Sets the due date for a review assignment.

Parameters:

	$articleId	int
	$reviewId	int
	$dueDate	string
	$numWeeks	int

Definition at line 543 of file SectionEditorAction.inc.php.

References HookRegistry.call(), DAORegistry.getDAO(), Request.getUser(), Config.getVar(), and ArticleLog.logEvent().

Referenced by addReviewer().

SectionEditorAction.setReviewerRecommendation	(	$	articleId,
		$	reviewId,
		$	recommendation,
		$	acceptOption
	)

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

Parameters:

	$articleId	int
	$reviewId	int
	$recommendation	int

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

References HookRegistry.call(), Core.getCurrentDate(), DAORegistry.getDAO(), Request.getUser(), and ArticleLog.logEvent().

SectionEditorAction.submissionBreadcrumb	(	$	articleId,
		$	parentPage,
		$	section
	)

Helper method for building submission breadcrumb

Parameters:

	$articleId
	$parentPage	name of submission component

Returns:

array

Definition at line 2182 of file SectionEditorAction.inc.php.

References Request.url().

Referenced by SectionEditorHandler.setupTemplate(), ProofreaderHandler.setupTemplate(), LayoutEditorHandler.setupTemplate(), EditorHandler.setupTemplate(), CopyeditorHandler.setupTemplate(), and AuthorHandler.setupTemplate().

SectionEditorAction.thankAuthorCopyedit	(	$	sectionEditorSubmission,
		$	send = false
	)

Thanks an author for completing editor / author review.

Parameters:

$sectionEditorSubmission

object

Returns:

boolean true iff ready for redirect

Definition at line 1012 of file SectionEditorAction.inc.php.

References HookRegistry.call(), Core.getCurrentDate(), DAORegistry.getDAO(), Request.getJournal(), Request.getUser(), Request.getUserVar(), and Request.url().

SectionEditorAction.thankCopyeditor	(	$	sectionEditorSubmission,
		$	send = false
	)

Thanks a copyeditor about a copyedit assignment.

Parameters:

$sectionEditorSubmission

object

Returns:

boolean true iff ready for redirect

Definition at line 923 of file SectionEditorAction.inc.php.

References HookRegistry.call(), Core.getCurrentDate(), DAORegistry.getDAO(), Request.getJournal(), Request.getUser(), Request.getUserVar(), and Request.url().

SectionEditorAction.thankFinalCopyedit	(	$	sectionEditorSubmission,
		$	send = false
	)

Thank copyeditor for completing final copyedit.

Parameters:

$sectionEditorSubmission

object

Returns:

boolean true iff ready for redirect

Definition at line 1102 of file SectionEditorAction.inc.php.

References HookRegistry.call(), Core.getCurrentDate(), DAORegistry.getDAO(), Request.getJournal(), Request.getUser(), Request.getUserVar(), and Request.url().

SectionEditorAction.thankLayoutEditor	(	$	submission,
		$	send = false
	)

Sends acknowledgement email to the current layout editor.

Parameters:

	$submission	object
	$send	boolean

Returns:

boolean true iff ready for redirect

Definition at line 1485 of file SectionEditorAction.inc.php.

References HookRegistry.call(), Core.getCurrentDate(), DAORegistry.getDAO(), Request.getJournal(), Request.getUser(), Request.getUserVar(), and Request.url().

Referenced by SubmissionEditHandler.thankLayoutEditor().

SectionEditorAction.thankReviewer	(	$	sectionEditorSubmission,
		$	reviewId,
		$	send = false
	)

Thanks a reviewer for completing a review assignment.

Parameters:

	$sectionEditorSubmission	object
	$reviewId	int

Returns:

boolean true iff ready for redirect

Definition at line 439 of file SectionEditorAction.inc.php.

References HookRegistry.call(), Core.getCurrentDate(), DAORegistry.getDAO(), Request.getJournal(), Request.getUser(), Request.getUserVar(), and Request.url().

SectionEditorAction.unsuitableSubmission	(	$	sectionEditorSubmission,
		$	send = false
	)

Notifies an author that a submission was unsuitable.

Parameters:

$sectionEditorSubmission

object

Returns:

boolean true iff ready for redirect

Definition at line 599 of file SectionEditorAction.inc.php.

References archiveSubmission(), HookRegistry.call(), DAORegistry.getDAO(), Request.getJournal(), Request.getUser(), Request.getUserVar(), and Request.url().

SectionEditorAction.updateCommentsStatus	(	$	submission,
		$	commentsStatus
	)

Changes the submission RT comments status.

Parameters:

	$submission	object
	$commentsStatus	int

Definition at line 1369 of file SectionEditorAction.inc.php.

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

Referenced by SubmissionEditHandler.updateCommentsStatus().

SectionEditorAction.updateSection	(	$	submission,
		$	sectionId
	)

Changes the section.

Parameters:

	$submission	object
	$sectionId	int

Definition at line 1356 of file SectionEditorAction.inc.php.

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

Referenced by SubmissionEditHandler.updateSection().

SectionEditorAction.updateSubmissionNote

(

$

articleId

)

Updates Submission Note

Parameters:

$articleId

int

Definition at line 1660 of file SectionEditorAction.inc.php.

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

Referenced by SubmissionEditHandler.updateSubmissionNote().

SectionEditorAction.uploadCopyeditVersion	(	$	sectionEditorSubmission,
		$	copyeditStage
	)

Upload the copyedit version of an article.

Parameters:

	$sectionEditorSubmission	object
	$copyeditStage	string

Definition at line 1204 of file SectionEditorAction.inc.php.

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

SectionEditorAction.uploadEditorVersion

(

$

sectionEditorSubmission

)

Upload the post-review version of an article.

Parameters:

$sectionEditorSubmission

object

Definition at line 1172 of file SectionEditorAction.inc.php.

References HookRegistry.call(), DAORegistry.getDAO(), Request.getUser(), and ArticleLog.logEvent().

SectionEditorAction.uploadLayoutVersion

(

$

submission

)

Upload the layout version of an article.

Parameters:

$submission

object

Definition at line 1385 of file SectionEditorAction.inc.php.

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

Referenced by SubmissionEditHandler.uploadLayoutVersion().

SectionEditorAction.uploadReviewForReviewer

(

$

reviewId

)

Upload a review on behalf of its reviewer.

Parameters:

$reviewId

int

Definition at line 2122 of file SectionEditorAction.inc.php.

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

SectionEditorAction.uploadReviewVersion

(

$

sectionEditorSubmission

)

Upload the review version of an article.

Parameters:

$sectionEditorSubmission

object

Definition at line 1142 of file SectionEditorAction.inc.php.

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

SectionEditorAction.viewCopyeditComments

(

$

article

)

View copyedit comments.

Parameters:

$article

object

Definition at line 1959 of file SectionEditorAction.inc.php.

References HookRegistry.call(), and Validation.isEditor().

Referenced by SubmissionCommentsHandler.postCopyeditComment(), and SubmissionCommentsHandler.viewCopyeditComments().

SectionEditorAction.viewEditorDecisionComments

(

$

article

)

View editor decision comments.

Parameters:

$article

object

Definition at line 1773 of file SectionEditorAction.inc.php.

References HookRegistry.call(), and Validation.isEditor().

Referenced by SubmissionCommentsHandler.postEditorDecisionComment(), and SubmissionCommentsHandler.viewEditorDecisionComments().

SectionEditorAction.viewLayoutComments

(

$

article

)

View layout comments.

Parameters:

$article

object

Definition at line 2000 of file SectionEditorAction.inc.php.

References HookRegistry.call(), and Validation.isEditor().

Referenced by SubmissionCommentsHandler.postLayoutComment(), and SubmissionCommentsHandler.viewLayoutComments().

SectionEditorAction.viewPeerReviewComments	(	&$	article,
		$	reviewId
	)

View reviewer comments.

Parameters:

	$article	object
	$reviewId	int

Definition at line 1731 of file SectionEditorAction.inc.php.

References HookRegistry.call(), and Validation.isEditor().

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

SectionEditorAction.viewProofreadComments

(

$

article

)

View proofread comments.

Parameters:

$article

object

Definition at line 2041 of file SectionEditorAction.inc.php.

References HookRegistry.call(), and Validation.isEditor().

Referenced by SubmissionCommentsHandler.postProofreadComment(), and SubmissionCommentsHandler.viewProofreadComments().

SectionEditorAction.viewReviewFormResponse	(	$	sectionEditorSubmission,
		$	reviewId
	)

View review form response.

Parameters:

	$sectionEditorSubmission	object
	$reviewId	int

Definition at line 722 of file SectionEditorAction.inc.php.

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

Referenced by SubmissionEditHandler.viewReviewFormResponse().

---

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

• classes/submission/sectionEditor/SectionEditorAction.inc.php