AuthorAction Class Reference
[Submission]

AuthorAction class. More...

Inheritance diagram for AuthorAction:

List of all members.

Public Member Functions
	AuthorAction ()
	completeAuthorCopyedit ($authorSubmission, $send=false)
	copyeditUnderway ($authorSubmission)
	deleteArticleFile ($article, $fileId, $revisionId)
	designateReviewVersion ($authorSubmission, $designate=false)
	downloadAuthorFile ($article, $fileId, $revision=null)
	emailEditorDecisionComment ($authorSubmission, $send)
	postCopyeditComment ($article, $emailComment)
	postLayoutComment ($article, $emailComment)
	postProofreadComment ($article, $emailComment)
	uploadCopyeditVersion ($authorSubmission, $copyeditStage)
	uploadRevisedVersion ($authorSubmission)
	viewCopyeditComments ($article)
	viewEditorDecisionComments ($article)
	viewLayoutComments ($article)
	viewProofreadComments ($article)

---

Detailed Description

AuthorAction class.

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

---

Member Function Documentation

AuthorAction.AuthorAction

(

)

Constructor.

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

AuthorAction.completeAuthorCopyedit	(	$	authorSubmission,
		$	send = false
	)

Author completes editor / author review.

Parameters:

$authorSubmission

object

Definition at line 125 of file AuthorAction.inc.php.

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

AuthorAction.copyeditUnderway

(

$

authorSubmission

)

Set that the copyedit is underway.

Definition at line 202 of file AuthorAction.inc.php.

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

Referenced by TrackSubmissionHandler.submissionEditing().

AuthorAction.deleteArticleFile	(	$	article,
		$	fileId,
		$	revisionId
	)

Delete an author file from a submission.

Parameters:

	$article	object
	$fileId	int
	$revisionId	int

Definition at line 64 of file AuthorAction.inc.php.

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

Referenced by TrackSubmissionHandler.deleteArticleFile().

AuthorAction.designateReviewVersion	(	$	authorSubmission,
		$	designate = false
	)

Actions. Designates the original file the review version.

Parameters:

	$authorSubmission	object
	$designate	boolean

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

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

Referenced by Upgrade.designateReviewVersions(), and AuthorSubmitStep5Form.execute().

AuthorAction.downloadAuthorFile	(	$	article,
		$	fileId,
		$	revision = null
	)

Download a file an author has access to.

Parameters:

	$article	object
	$fileId	int
	$revision	int

Returns:

boolean TODO: Complete list of files author has access to

Definition at line 452 of file AuthorAction.inc.php.

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

Referenced by TrackSubmissionHandler.downloadFile().

AuthorAction.emailEditorDecisionComment	(	$	authorSubmission,
		$	send
	)

Email editor decision comment.

Parameters:

	$authorSubmission	object
	$send	boolean

Definition at line 309 of file AuthorAction.inc.php.

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

Referenced by SubmissionCommentsHandler.emailEditorDecisionComment().

AuthorAction.postCopyeditComment	(	$	article,
		$	emailComment
	)

Post copyedit comment.

Parameters:

$article

object

Definition at line 377 of file AuthorAction.inc.php.

References HookRegistry.call().

Referenced by SubmissionCommentsHandler.postCopyeditComment().

AuthorAction.postLayoutComment	(	$	article,
		$	emailComment
	)

Post layout comment.

Parameters:

	$article	object
	$emailComment	boolean

Definition at line 268 of file AuthorAction.inc.php.

References HookRegistry.call().

Referenced by SubmissionCommentsHandler.postLayoutComment().

AuthorAction.postProofreadComment	(	$	article,
		$	emailComment
	)

Post proofread comment.

Parameters:

	$article	object
	$emailComment	boolean

Definition at line 418 of file AuthorAction.inc.php.

References HookRegistry.call().

Referenced by SubmissionCommentsHandler.postProofreadComment().

AuthorAction.uploadCopyeditVersion	(	$	authorSubmission,
		$	copyeditStage
	)

Upload the revised version of a copyedit file.

Parameters:

	$authorSubmission	object
	$copyeditStage	string

Definition at line 217 of file AuthorAction.inc.php.

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

AuthorAction.uploadRevisedVersion

(

$

authorSubmission

)

Upload the revised version of an article.

Parameters:

$authorSubmission

object

Definition at line 93 of file AuthorAction.inc.php.

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

Referenced by TrackSubmissionHandler.uploadRevisedVersion().

AuthorAction.viewCopyeditComments

(

$

article

)

View copyedit comments.

Parameters:

$article

object

Definition at line 363 of file AuthorAction.inc.php.

References HookRegistry.call().

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

AuthorAction.viewEditorDecisionComments

(

$

article

)

View editor decision comments.

Parameters:

$article

object

Definition at line 294 of file AuthorAction.inc.php.

References HookRegistry.call().

Referenced by SubmissionCommentsHandler.viewEditorDecisionComments().

AuthorAction.viewLayoutComments

(

$

article

)

View layout comments.

Parameters:

$article

object

Definition at line 254 of file AuthorAction.inc.php.

References HookRegistry.call().

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

AuthorAction.viewProofreadComments

(

$

article

)

View proofread comments.

Parameters:

$article

object

Definition at line 403 of file AuthorAction.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/author/AuthorAction.inc.php