Open Journal Systems  2.4.4
 All Classes Namespaces Functions Variables Groups Pages
AuthorAction Class Reference
Inheritance diagram for AuthorAction:
Action PKPAction

Public Member Functions

 AuthorAction ()
 
 completeAuthorCopyedit ($authorSubmission, $send, $request)
 
 copyeditUnderway ($authorSubmission)
 
 deleteArticleFile ($article, $fileId, $revisionId)
 
 designateReviewVersion ($authorSubmission, $designate=false)
 
 downloadAuthorFile ($article, $fileId, $revision=null)
 
 emailEditorDecisionComment ($authorSubmission, $send, $request)
 
 postCopyeditComment ($article, $emailComment, $request)
 
 postLayoutComment ($article, $emailComment, $request)
 
 postProofreadComment ($article, $emailComment, $request)
 
 uploadCopyeditVersion ($authorSubmission, $copyeditStage)
 
 uploadRevisedVersion ($authorSubmission, $request)
 
 viewCopyeditComments ($article)
 
 viewEditorDecisionComments ($article)
 
 viewLayoutComments ($article)
 
 viewProofreadComments ($article)
 
- Public Member Functions inherited from Action
 Action ()
 
 deleteComment ($commentId, $user=null)
 
 downloadFile ($articleId, $fileId, $revision=null)
 
 editComment ($article, $comment)
 
 instructions ($type, $allowed=array('copy', 'layout', 'proof', 'referenceLinking'))
 
 saveComment ($article, &$comment, $emailComment, $request)
 
 saveMetadata ($article, &$request)
 
 viewFile ($articleId, $fileId, $revision=null)
 
 viewMetadata ($article, $journal)
 
- Public Member Functions inherited from PKPAction
 editCitations (&$request, &$submission)
 
 PKPAction ()
 

Detailed Description

AuthorAction class.

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

Member Function Documentation

AuthorAction::AuthorAction ( )

Constructor.

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

AuthorAction::completeAuthorCopyedit (   $authorSubmission,
  $send,
  $request 
)

Author completes editor / author review.

Parameters
$authorSubmissionobject
$sendboolean
$requestobject

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

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

Referenced by TrackSubmissionHandler\completeAuthorCopyedit().

AuthorAction::copyeditUnderway (   $authorSubmission)

Set that the copyedit is underway.

Definition at line 235 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
$articleobject
$fileIdint
$revisionIdint

Definition at line 62 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
$authorSubmissionobject
$designateboolean

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

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

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

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

Download a file an author has access to.

Parameters
$articleobject
$fileIdint
$revisionint
Returns
boolean TODO: Complete list of files author has access to

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

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

Referenced by TrackSubmissionHandler\downloadFile().

AuthorAction::emailEditorDecisionComment (   $authorSubmission,
  $send,
  $request 
)

Email editor decision comment.

Parameters
$authorSubmissionobject
$sendboolean
$requestobject

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

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

Referenced by SubmissionCommentsHandler\emailEditorDecisionComment().

AuthorAction::postCopyeditComment (   $article,
  $emailComment,
  $request 
)

Post copyedit comment.

Parameters
$articleobject
$emailCommentboolean
$requestobject

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

References HookRegistry\call().

Referenced by SubmissionCommentsHandler\postCopyeditComment().

AuthorAction::postLayoutComment (   $article,
  $emailComment,
  $request 
)

Post layout comment.

Parameters
$articleobject
$emailCommentboolean

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

References HookRegistry\call().

Referenced by SubmissionCommentsHandler\postLayoutComment().

AuthorAction::postProofreadComment (   $article,
  $emailComment,
  $request 
)

Post proofread comment.

Parameters
$articleobject
$emailCommentboolean
$requestobject

Definition at line 480 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
$authorSubmissionobject
$copyeditStagestring

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

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

Referenced by TrackSubmissionHandler\uploadCopyeditVersion().

AuthorAction::uploadRevisedVersion (   $authorSubmission,
  $request 
)

Upload the revised version of an article.

Parameters
$authorSubmissionobject
$requestobject

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

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

Referenced by TrackSubmissionHandler\uploadRevisedVersion().

AuthorAction::viewCopyeditComments (   $article)

View copyedit comments.

Parameters
$articleobject

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

References HookRegistry\call().

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

AuthorAction::viewEditorDecisionComments (   $article)

View editor decision comments.

Parameters
$articleobject

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

References HookRegistry\call().

Referenced by SubmissionCommentsHandler\viewEditorDecisionComments().

AuthorAction::viewLayoutComments (   $article)

View layout comments.

Parameters
$articleobject

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

References HookRegistry\call().

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

AuthorAction::viewProofreadComments (   $article)

View proofread comments.

Parameters
$articleobject

Definition at line 464 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: