LayoutEditorAction Class Reference
[Submission_layoutEditor_LayoutEditorAction]

LayoutEditorAction class. More...

Inheritance diagram for LayoutEditorAction:

List of all members.

Public Member Functions
	completeLayoutEditing ($submission, $send=false)
	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)
	postProofreadComment ($article, $emailComment)
	uploadLayoutVersion ($submission)
	viewLayoutComments ($article)
	viewProofreadComments ($article)

---

Detailed Description

LayoutEditorAction class.

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

---

Member Function Documentation

LayoutEditorAction.completeLayoutEditing	(	$	submission,
		$	send = false
	)

Marks layout assignment as completed.

Parameters:

	$submission	object
	$send	boolean

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

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

Referenced by SubmissionLayoutHandler.completeAssignment().

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

Delete an image from an article galley.

Parameters:

	$submission	object
	$fileId	int
	$revision	int (optional)

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

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

Referenced by SubmissionLayoutHandler.deleteArticleImage().

LayoutEditorAction.deleteGalley	(	$	article,
		$	galleyId
	)

Delete a galley.

Parameters:

	$article	object
	$galleyId	int

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

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

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

LayoutEditorAction.deleteSuppFile	(	$	article,
		$	suppFileId
	)

Delete a supplementary file.

Parameters:

	$article	object
	$suppFileId	int

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

References HookRegistry.call(), ArticleSearchIndex.deleteTextIndex(), 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:

	$article	object $fileId int
	$revision	int optional

Returns:

boolean

Reimplemented from Action.

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

	$article	object
	$galleyId	int
	$direction	char u = up, d = down

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

	$article	object
	$suppFileId	int
	$direction	char u = up, d = down

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

References DAORegistry.getDAO().

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

LayoutEditorAction.postLayoutComment	(	$	article,
		$	emailComment
	)

Post layout comment.

Parameters:

$article

object

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

References HookRegistry.call().

Referenced by SubmissionCommentsHandler.postLayoutComment().

LayoutEditorAction.postProofreadComment	(	$	article,
		$	emailComment
	)

Post proofread comment.

Parameters:

$article

object

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

References HookRegistry.call().

Referenced by SubmissionCommentsHandler.postProofreadComment().

LayoutEditorAction.uploadLayoutVersion

(

$

submission

)

Upload the layout version of an article.

Parameters:

$submission

object

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

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

Referenced by SubmissionLayoutHandler.uploadLayoutFile().

LayoutEditorAction.viewLayoutComments

(

$

article

)

View layout comments.

Parameters:

$article

object

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

References HookRegistry.call().

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

LayoutEditorAction.viewProofreadComments

(

$

article

)

View proofread comments.

Parameters:

$article

object

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

• classes/submission/layoutEditor/LayoutEditorAction.inc.php