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

Public Member Functions

 completeLayoutEditing ($submission, $send, $request)
 
 deleteArticleImage ($submission, $fileId, $revision)
 
 deleteGalley ($article, $galleyId)
 
 deleteSuppFile ($article, $suppFileId)
 
 downloadFile ($article, $fileId, $revision=null)
 
 orderGalley ($article, $galleyId, $direction)
 
 orderSuppFile ($article, $suppFileId, $direction)
 
 postLayoutComment ($article, $emailComment, $request)
 
 postProofreadComment ($article, $emailComment, $request)
 
 uploadLayoutVersion ($submission)
 
 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

LayoutEditorAction class.

Definition at line 22 of file LayoutEditorAction.inc.php.

Member Function Documentation

LayoutEditorAction::completeLayoutEditing (   $submission,
  $send,
  $request 
)

Marks layout assignment as completed.

Parameters
$submissionobject
$sendboolean
$requestobject

Definition at line 159 of file LayoutEditorAction.inc.php.

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

Referenced by SubmissionLayoutHandler\completeAssignment().

LayoutEditorAction::deleteArticleImage (   $submission,
  $fileId,
  $revision 
)

Delete an image from an article galley.

Parameters
$submissionobject
$fileIdint
$revisionint (optional)

Definition at line 88 of file LayoutEditorAction.inc.php.

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

Referenced by SubmissionLayoutHandler\deleteArticleImage().

LayoutEditorAction::deleteGalley (   $article,
  $galleyId 
)

Delete a galley.

Parameters
$articleobject
$galleyIdint

Definition at line 50 of file LayoutEditorAction.inc.php.

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

Referenced by SubmissionLayoutHandler\deleteGalley(), and SectionEditorAction\deleteGalley().

LayoutEditorAction::deleteSuppFile (   $article,
  $suppFileId 
)

Delete a supplementary file.

Parameters
$articleobject
$suppFileIdint

Definition at line 126 of file LayoutEditorAction.inc.php.

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

Referenced by SubmissionLayoutHandler\deleteSuppFile(), and SectionEditorAction\deleteSuppFile().

LayoutEditorAction::downloadFile (   $article,
  $fileId,
  $revision = null 
)

Download a file a layout editor has access to. This includes: The layout editor submission file, supplementary files, and galley files.

Parameters
$articleobject $fileId int
$revisionint optional
Returns
boolean

Definition at line 360 of file LayoutEditorAction.inc.php.

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

Referenced by SubmissionLayoutHandler\downloadFile().

LayoutEditorAction::orderGalley (   $article,
  $galleyId,
  $direction 
)

Change the sequence order of a galley.

Parameters
$articleobject
$galleyIdint
$directionchar u = up, d = down

Definition at line 34 of file LayoutEditorAction.inc.php.

References DAORegistry\getDAO().

Referenced by SubmissionLayoutHandler\orderGalley(), and SectionEditorAction\orderGalley().

LayoutEditorAction::orderSuppFile (   $article,
  $suppFileId,
  $direction 
)

Change the sequence order of a supplementary file.

Parameters
$articleobject
$suppFileIdint
$directionchar u = up, d = down

Definition at line 110 of file LayoutEditorAction.inc.php.

References DAORegistry\getDAO().

Referenced by SubmissionLayoutHandler\orderSuppFile(), and SectionEditorAction\orderSuppFile().

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

Post layout comment.

Parameters
$articleobject
$emailCommentboolean
$requestobject

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

References HookRegistry\call().

Referenced by SubmissionCommentsHandler\postLayoutComment().

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

Post proofread comment.

Parameters
$articleobject
$emailCommentboolean
$requestobject

Definition at line 315 of file LayoutEditorAction.inc.php.

References HookRegistry\call().

Referenced by SubmissionCommentsHandler\postProofreadComment().

LayoutEditorAction::uploadLayoutVersion (   $submission)

Upload the layout version of an article.

Parameters
$submissionobject

Definition at line 219 of file LayoutEditorAction.inc.php.

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

Referenced by SubmissionLayoutHandler\uploadLayoutFile().

LayoutEditorAction::viewLayoutComments (   $article)

View layout comments.

Parameters
$articleobject

Definition at line 247 of file LayoutEditorAction.inc.php.

References HookRegistry\call().

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

LayoutEditorAction::viewProofreadComments (   $article)

View proofread comments.

Parameters
$articleobject

Definition at line 299 of file LayoutEditorAction.inc.php.

References HookRegistry\call().

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


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