SubmissionLayoutHandler Class Reference
[Pages_layoutEditor]

Handle requests related to submission layout editing. More...

Inheritance diagram for SubmissionLayoutHandler:

List of all members.

Public Member Functions
	completeAssignment ($args)
	deleteArticleImage ($args)
	deleteGalley ($args)
	deleteSuppFile ($args)
	downloadFile ($args)
	editGalley ($args)
	editSuppFile ($args)
	layoutEditingEnabled (&$submission)
	layoutEditorProofreadingComplete ($args)
	orderGalley ()
	orderSuppFile ()
	proofGalley ($args)
	proofGalleyFile ($args)
	proofGalleyTop ($args)
	saveGalley ($args)
	saveSuppFile ($args)
	submission ($args)
	uploadLayoutFile ()
	validate ($articleId, $checkEdit=false)
	viewFile ($args)

---

Detailed Description

Handle requests related to submission layout editing.

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

---

Member Function Documentation

SubmissionLayoutHandler.completeAssignment

(

$

args

)

Mark assignment as complete.

Reimplemented from LayoutEditorHandler.

Definition at line 78 of file SubmissionLayoutHandler.inc.php.

References LayoutEditorAction.completeLayoutEditing(), Request.getUserVar(), Request.redirect(), and LayoutEditorHandler.validate().

SubmissionLayoutHandler.deleteArticleImage

(

$

args

)

Delete an article image.

Parameters:

$args

array ($articleId, $fileId)

Reimplemented from LayoutEditorHandler.

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

References LayoutEditorAction.deleteArticleImage(), Request.redirect(), and LayoutEditorHandler.validate().

SubmissionLayoutHandler.deleteGalley

(

$

args

)

Delete a galley file.

Parameters:

$args

array ($articleId, $galleyId)

Reimplemented from LayoutEditorHandler.

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

References LayoutEditorAction.deleteGalley(), Request.redirect(), and LayoutEditorHandler.validate().

SubmissionLayoutHandler.deleteSuppFile

(

$

args

)

Delete a supplementary file.

Parameters:

$args

array ($articleId, $suppFileId)

Reimplemented from LayoutEditorHandler.

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

References LayoutEditorAction.deleteSuppFile(), Request.redirect(), and LayoutEditorHandler.validate().

SubmissionLayoutHandler.downloadFile

(

$

args

)

Download a file.

Parameters:

$args

array ($articleId, $fileId, [$revision])

Reimplemented from LayoutEditorHandler.

Definition at line 408 of file SubmissionLayoutHandler.inc.php.

References LayoutEditorAction.downloadFile(), Request.redirect(), and LayoutEditorHandler.validate().

SubmissionLayoutHandler.editGalley

(

$

args

)

Edit a galley.

Parameters:

$args

array ($articleId, $galleyId)

Reimplemented from LayoutEditorHandler.

Definition at line 131 of file SubmissionLayoutHandler.inc.php.

References DAORegistry.getDAO(), TemplateManager.getManager(), layoutEditingEnabled(), Request.redirect(), and LayoutEditorHandler.validate().

SubmissionLayoutHandler.editSuppFile

(

$

args

)

Edit a supplementary file.

Parameters:

$args

array ($articleId, $suppFileId)

Reimplemented from LayoutEditorHandler.

Definition at line 312 of file SubmissionLayoutHandler.inc.php.

References DAORegistry.getDAO(), TemplateManager.getManager(), layoutEditingEnabled(), Request.redirect(), and LayoutEditorHandler.validate().

SubmissionLayoutHandler.layoutEditingEnabled

(

&$

submission

)

Check if a layout editor is allowed to make changes to the submission. This is allowed if there is an outstanding galley creation or layout editor proofreading request.

Parameters:

$submission

LayoutEditorSubmission

Returns:

boolean true if layout editor can modify the submission

Definition at line 505 of file SubmissionLayoutHandler.inc.php.

Referenced by editGalley(), editSuppFile(), submission(), and validate().

SubmissionLayoutHandler.layoutEditorProofreadingComplete

(

$

args

)

Sets the date of layout editor proofreading completion

Reimplemented from LayoutEditorHandler.

Definition at line 441 of file SubmissionLayoutHandler.inc.php.

References Request.getUserVar(), ProofreaderAction.proofreadEmail(), Request.redirect(), Request.url(), and LayoutEditorHandler.validate().

SubmissionLayoutHandler.orderGalley

(

)

Change the sequence order of a galley.

Reimplemented from LayoutEditorHandler.

Definition at line 215 of file SubmissionLayoutHandler.inc.php.

References Request.getUserVar(), LayoutEditorAction.orderGalley(), Request.redirect(), and LayoutEditorHandler.validate().

SubmissionLayoutHandler.orderSuppFile

(

)

Change the sequence order of a supplementary file.

Reimplemented from LayoutEditorHandler.

Definition at line 390 of file SubmissionLayoutHandler.inc.php.

References Request.getUserVar(), LayoutEditorAction.orderSuppFile(), Request.redirect(), and LayoutEditorHandler.validate().

SubmissionLayoutHandler.proofGalley

(

$

args

)

Proof / "preview" a galley.

Parameters:

$args

array ($articleId, $galleyId)

Reimplemented from LayoutEditorHandler.

Definition at line 228 of file SubmissionLayoutHandler.inc.php.

References TemplateManager.getManager(), and LayoutEditorHandler.validate().

SubmissionLayoutHandler.proofGalleyFile

(

$

args

)

Proof galley (outputs file contents).

Parameters:

$args

array ($articleId, $galleyId)

Reimplemented from LayoutEditorHandler.

Definition at line 259 of file SubmissionLayoutHandler.inc.php.

References DAORegistry.getDAO(), TemplateManager.getManager(), Request.url(), LayoutEditorHandler.validate(), and viewFile().

SubmissionLayoutHandler.proofGalleyTop

(

$

args

)

Proof galley (shows frame header).

Parameters:

$args

array ($articleId, $galleyId)

Reimplemented from LayoutEditorHandler.

Definition at line 243 of file SubmissionLayoutHandler.inc.php.

References TemplateManager.getManager(), and LayoutEditorHandler.validate().

SubmissionLayoutHandler.saveGalley

(

$

args

)

Save changes to a galley.

Parameters:

$args

array ($articleId, $galleyId)

Reimplemented from LayoutEditorHandler.

Definition at line 170 of file SubmissionLayoutHandler.inc.php.

References Request.getUserVar(), Request.redirect(), and LayoutEditorHandler.validate().

SubmissionLayoutHandler.saveSuppFile

(

$

args

)

Save a supplementary file.

Parameters:

$args

array ($suppFileId)

Reimplemented from LayoutEditorHandler.

Definition at line 352 of file SubmissionLayoutHandler.inc.php.

References Request.getUserVar(), Request.redirect(), and LayoutEditorHandler.validate().

SubmissionLayoutHandler.submission

(

$

args

)

View an assigned submission's layout editing page.

Parameters:

$args

array ($articleId)

Reimplemented from LayoutEditorHandler.

Definition at line 28 of file SubmissionLayoutHandler.inc.php.

References Core.getCurrentDate(), DAORegistry.getDAO(), TemplateManager.getManager(), layoutEditingEnabled(), ProofreaderAction.layoutEditorProofreadingUnderway(), and LayoutEditorHandler.validate().

SubmissionLayoutHandler.uploadLayoutFile

(

)

Create a new layout file (layout version, galley, or supp file) with the uploaded file.

Reimplemented from LayoutEditorHandler.

Definition at line 95 of file SubmissionLayoutHandler.inc.php.

References Request.getUserVar(), Request.redirect(), Locale.translate(), LayoutEditorAction.uploadLayoutVersion(), and LayoutEditorHandler.validate().

SubmissionLayoutHandler.validate	(	$	articleId,
		$	checkEdit = false
	)

Validate that the user is the assigned layout editor for the submission. Redirects to layoutEditor index page if validation fails.

Parameters:

	$articleId	int the submission being edited
	$checkEdit	boolean check if editor has editing permissions

Definition at line 469 of file SubmissionLayoutHandler.inc.php.

References DAORegistry.getDAO(), Request.getJournal(), Request.getRequestedPage(), Request.getUser(), layoutEditingEnabled(), and Request.redirect().

SubmissionLayoutHandler.viewFile

(

$

args

)

View a file (inlines file).

Parameters:

$args

array ($articleId, $fileId, [$revision])

Reimplemented from LayoutEditorHandler.

Definition at line 423 of file SubmissionLayoutHandler.inc.php.

References Request.redirect(), LayoutEditorHandler.validate(), and Action.viewFile().

Referenced by proofGalleyFile().

---

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

• pages/layoutEditor/SubmissionLayoutHandler.inc.php