CopyeditorAction Class Reference
[Submission]

CopyeditorAction class. More...

Inheritance diagram for CopyeditorAction:

List of all members.

Public Member Functions
	completeCopyedit ($copyeditorSubmission, $send=false)
	completeFinalCopyedit ($copyeditorSubmission, $send=false)
	CopyeditorAction ()
	copyeditUnderway (&$copyeditorSubmission)
	downloadCopyeditorFile ($submission, $fileId, $revision=null)
	postCopyeditComment ($article, $emailComment)
	postLayoutComment ($article, $emailComment)
	uploadCopyeditVersion ($copyeditorSubmission, $copyeditStage)
	viewCopyeditComments ($article)
	viewLayoutComments ($article)

---

Detailed Description

CopyeditorAction class.

See also:

CopyeditorSubmissionDAO

Definition at line 21 of file CopyeditorAction.inc.php.

---

Member Function Documentation

CopyeditorAction.completeCopyedit	(	$	copyeditorSubmission,
		$	send = false
	)

Actions. Copyeditor completes initial copyedit.

Parameters:

$copyeditorSubmission

object

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

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

CopyeditorAction.completeFinalCopyedit	(	$	copyeditorSubmission,
		$	send = false
	)

Copyeditor completes final copyedit.

Parameters:

$copyeditorSubmission

object

Definition at line 97 of file CopyeditorAction.inc.php.

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

CopyeditorAction.CopyeditorAction

(

)

Constructor.

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

CopyeditorAction.copyeditUnderway

(

&$

copyeditorSubmission

)

Set that the copyedit is underway.

Definition at line 174 of file CopyeditorAction.inc.php.

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

CopyeditorAction.downloadCopyeditorFile	(	$	submission,
		$	fileId,
		$	revision = null
	)

Download a file a copyeditor has access to.

Parameters:

	$submission	object
	$fileId	int
	$revision	int

Definition at line 349 of file CopyeditorAction.inc.php.

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

Referenced by SubmissionCopyeditHandler.downloadFile().

CopyeditorAction.postCopyeditComment	(	$	article,
		$	emailComment
	)

Post copyedit comment.

Parameters:

$article

object

Definition at line 317 of file CopyeditorAction.inc.php.

References HookRegistry.call().

Referenced by SubmissionCommentsHandler.postCopyeditComment().

CopyeditorAction.postLayoutComment	(	$	article,
		$	emailComment
	)

Post layout comment.

Parameters:

$article

object

Definition at line 277 of file CopyeditorAction.inc.php.

References HookRegistry.call().

Referenced by SubmissionCommentsHandler.postLayoutComment().

CopyeditorAction.uploadCopyeditVersion	(	$	copyeditorSubmission,
		$	copyeditStage
	)

Upload the copyedited version of an article.

Parameters:

$copyeditorSubmission

object

Definition at line 203 of file CopyeditorAction.inc.php.

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

CopyeditorAction.viewCopyeditComments

(

$

article

)

View copyedit comments.

Parameters:

$article

object

Definition at line 303 of file CopyeditorAction.inc.php.

References HookRegistry.call().

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

CopyeditorAction.viewLayoutComments

(

$

article

)

View layout comments.

Parameters:

$article

object

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

References HookRegistry.call().

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

---

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

• classes/submission/copyeditor/CopyeditorAction.inc.php