ProofreaderAction Class Reference
[Submission_proofreader_ProofreaderAction]

ProofreaderAction class. More...

Inheritance diagram for ProofreaderAction:

List of all members.

Public Member Functions
	authorProofreadingUnderway (&$submission)
	downloadProofreaderFile ($submission, $fileId, $revision=null)
	layoutEditorProofreadingUnderway (&$submission)
	postLayoutComment ($article, $emailComment)
	postProofreadComment ($article, $emailComment)
	proofreadEmail ($articleId, $mailType, $actionPath= '')
	proofreaderProofreadingUnderway (&$submission)
	selectProofreader ($userId, $article)
	viewLayoutComments ($article)
	viewProofreadComments ($article)

---

Detailed Description

ProofreaderAction class.

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

---

Member Function Documentation

ProofreaderAction.authorProofreadingUnderway

(

&$

submission

)

Set date for author proofreading underway

Parameters:

$articleId

int

Definition at line 354 of file ProofreaderAction.inc.php.

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

Referenced by TrackSubmissionHandler.submissionEditing().

ProofreaderAction.downloadProofreaderFile	(	$	submission,
		$	fileId,
		$	revision = null
	)

Download a file a proofreader has access to.

Parameters:

	$submission	object
	$fileId	int
	$revision	int

Definition at line 414 of file ProofreaderAction.inc.php.

References HookRegistry.call(), and Action.downloadFile().

Referenced by SubmissionProofreadHandler.downloadFile().

ProofreaderAction.layoutEditorProofreadingUnderway

(

&$

submission

)

Set date for layout editor proofreading underway

Parameters:

$articleId

int

Definition at line 390 of file ProofreaderAction.inc.php.

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

Referenced by SubmissionLayoutHandler.submission().

ProofreaderAction.postLayoutComment	(	$	article,
		$	emailComment
	)

Post layout comment.

Parameters:

	$article	object
	$emailComment	boolean

Definition at line 506 of file ProofreaderAction.inc.php.

References HookRegistry.call().

Referenced by SubmissionCommentsHandler.postLayoutComment().

ProofreaderAction.postProofreadComment	(	$	article,
		$	emailComment
	)

Post proofread comment.

Parameters:

	$article	object
	$emailComment	boolean

Definition at line 465 of file ProofreaderAction.inc.php.

References HookRegistry.call().

Referenced by SubmissionCommentsHandler.postProofreadComment().

ProofreaderAction.proofreadEmail	(	$	articleId,
		$	mailType,
		$	actionPath = ''
	)

Proofread Emails

Parameters:

	$articleId	int
	$mailType	defined string - type of proofread mail being sent
	$actionPath	string - form action

Returns:

true iff ready for a redirect

Definition at line 55 of file ProofreaderAction.inc.php.

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

Referenced by SubmissionCopyeditHandler.authorProofreadingComplete(), TrackSubmissionHandler.authorProofreadingComplete(), SubmissionProofreadHandler.completeProofreader(), SubmissionLayoutHandler.layoutEditorProofreadingComplete(), SubmissionEditHandler.notifyAuthorProofreader(), SubmissionEditHandler.notifyLayoutEditorProofreader(), SubmissionEditHandler.notifyProofreader(), SubmissionEditHandler.thankAuthorProofreader(), SubmissionEditHandler.thankLayoutEditorProofreader(), and SubmissionEditHandler.thankProofreader().

ProofreaderAction.proofreaderProofreadingUnderway

(

&$

submission

)

Set date for proofreader proofreading underway

Parameters:

$articleId

int

Definition at line 372 of file ProofreaderAction.inc.php.

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

Referenced by SubmissionProofreadHandler.submission().

ProofreaderAction.selectProofreader	(	$	userId,
		$	article
	)

Select a proofreader for submission

Definition at line 29 of file ProofreaderAction.inc.php.

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

Referenced by SubmissionEditHandler.selectProofreader().

ProofreaderAction.viewLayoutComments

(

$

article

)

View layout comments.

Parameters:

$article

object

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

References HookRegistry.call().

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

ProofreaderAction.viewProofreadComments

(

$

article

)

View proofread comments.

Parameters:

$article

object

Definition at line 450 of file ProofreaderAction.inc.php.

References HookRegistry.call().

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

---

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

• classes/submission/proofreader/ProofreaderAction.inc.php