Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
SubmissionLayoutHandler Class Reference
Inheritance diagram for SubmissionLayoutHandler:
LayoutEditorHandler Handler PKPHandler

Public Member Functions

 completeAssignment ($args, $request)
 
 deleteArticleImage ($args, &$request)
 
 deleteGalley ($args, &$request)
 
 deleteSuppFile ($args, &$request)
 
 downloadFile ($args, &$request)
 
 downloadLayoutTemplate ($args, &$request)
 
 editGalley ($args, &$request)
 
 editSuppFile ($args, $request)
 
 layoutEditorProofreadingComplete ($args, $request)
 
 orderGalley ($args, &$request)
 
 orderSuppFile ($args, &$request)
 
 proofGalley ($args, &$request)
 
 proofGalleyFile ($args, &$request)
 
 proofGalleyTop ($args, &$request)
 
 saveGalley ($args, $request)
 
 saveSuppFile ($args, $request)
 
 submission ($args, &$request)
 
 SubmissionLayoutHandler ()
 
 uploadLayoutFile ($args, $request)
 
 viewFile ($args, &$request)
 
 viewMetadata ($args, $request)
 
- Public Member Functions inherited from LayoutEditorHandler
 _layoutEditingEnabled (&$submission)
 
 backIssues ($args, &$request)
 
 completeProofreader ($args, &$request)
 
 futureIssues ($args, &$request)
 
 index ($args, &$request)
 
 instructions ($args, &$request)
 
 LayoutEditorHandler ()
 
 setupTemplate ($subclass=false, $articleId=0, $parentPage=null)
 
 submissions ($args, &$request)
 
 validate ($request, $articleId=null, $checkEdit=false)
 
- Public Member Functions inherited from PKPHandler
 addCheck (&$handlerValidator)
 
 addPolicy (&$authorizationPolicy, $addToTop=false)
 
 addRoleAssignment ($roleIds, $operations)
 
 authorize (&$request, &$args, $roleAssignments)
 
getAuthorizedContext ()
 
getAuthorizedContextObject ($assocType)
 
getDispatcher ()
 
 getId ()
 
 getLastAuthorizationMessage ()
 
 getLoginExemptions ()
 
getRangeInfo ($rangeName, $contextData=null)
 
 getRoleAssignment ($roleId)
 
 getRoleAssignments ()
 
 hashPageContext ($contextData=array())
 
 index ()
 
 initialize (&$request, $args=null)
 
 PKPHandler ()
 
 setDispatcher (&$dispatcher)
 
 setId ($id)
 
 validate ($requiredContexts=null, $request=null)
 

Additional Inherited Members

- Public Attributes inherited from LayoutEditorHandler
 $submission
 

Detailed Description

Handle requests related to submission layout editing.

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

Member Function Documentation

SubmissionLayoutHandler::completeAssignment (   $args,
  $request 
)

Mark assignment as complete.

Parameters
$argsarray
$requestPKPRequest

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

References LayoutEditorAction\completeLayoutEditing(), LayoutEditorHandler\setupTemplate(), submission(), and LayoutEditorHandler\validate().

SubmissionLayoutHandler::deleteArticleImage (   $args,
$request 
)

Delete an article image.

Parameters
$argsarray ($articleId, $fileId)
$requestPKPRequest

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

References LayoutEditorAction\deleteArticleImage(), submission(), and LayoutEditorHandler\validate().

SubmissionLayoutHandler::deleteGalley (   $args,
$request 
)

Delete a galley file.

Parameters
$argsarray ($articleId, $galleyId)
$requestPKPRequest

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

References LayoutEditorHandler\$submission, LayoutEditorAction\deleteGalley(), and LayoutEditorHandler\validate().

SubmissionLayoutHandler::deleteSuppFile (   $args,
$request 
)

Delete a supplementary file.

Parameters
$argsarray ($articleId, $suppFileId)
$requestPKPRequest

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

References LayoutEditorAction\deleteSuppFile(), submission(), and LayoutEditorHandler\validate().

SubmissionLayoutHandler::downloadFile (   $args,
$request 
)

Download a file.

Parameters
$argsarray ($articleId, $fileId, [$revision])
$requestPKPRequest

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

References LayoutEditorHandler\$submission, LayoutEditorAction\downloadFile(), and LayoutEditorHandler\validate().

SubmissionLayoutHandler::downloadLayoutTemplate (   $args,
$request 
)

Download a layout template.

Parameters
$argsarray
$requestPKPRequest

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

SubmissionLayoutHandler::editGalley (   $args,
$request 
)
SubmissionLayoutHandler::editSuppFile (   $args,
  $request 
)

Edit a supplementary file.

Parameters
$argsarray ($articleId, $suppFileId)
$requestPKPRequest

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

References LayoutEditorHandler\$submission, LayoutEditorHandler\_layoutEditingEnabled(), DAORegistry\getDAO(), LayoutEditorHandler\setupTemplate(), and LayoutEditorHandler\validate().

SubmissionLayoutHandler::layoutEditorProofreadingComplete (   $args,
  $request 
)

Sets the date of layout editor proofreading completion

Parameters
$argsarray
$requestRequest

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

References LayoutEditorHandler\$submission, ProofreaderAction\proofreadEmail(), LayoutEditorHandler\setupTemplate(), and LayoutEditorHandler\validate().

SubmissionLayoutHandler::orderGalley (   $args,
$request 
)

Change the sequence order of a galley.

Parameters
$argsarray
$requestPKPRequest

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

References LayoutEditorHandler\$submission, LayoutEditorAction\orderGalley(), and LayoutEditorHandler\validate().

SubmissionLayoutHandler::orderSuppFile (   $args,
$request 
)

Change the sequence order of a supplementary file.

Parameters
$argsarray
$requestPKPRequest

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

References LayoutEditorAction\orderSuppFile(), submission(), and LayoutEditorHandler\validate().

SubmissionLayoutHandler::proofGalley (   $args,
$request 
)

Proof / "preview" a galley.

Parameters
$argsarray ($articleId, $galleyId)
$requestPKPRequest

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

References LayoutEditorHandler\validate().

SubmissionLayoutHandler::proofGalleyFile (   $args,
$request 
)

Proof galley (outputs file contents).

Parameters
$argsarray ($articleId, $galleyId)
$requestPKPRequest

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

References DAORegistry\getDAO(), LayoutEditorHandler\validate(), and viewFile().

SubmissionLayoutHandler::proofGalleyTop (   $args,
$request 
)

Proof galley (shows frame header).

Parameters
$argsarray ($articleId, $galleyId)
$requestPKPRequest

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

References LayoutEditorHandler\validate().

SubmissionLayoutHandler::saveGalley (   $args,
  $request 
)

Save changes to a galley.

Parameters
$argsarray ($articleId, $galleyId)
$requestRequest

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

References DAORegistry\getDAO(), LayoutEditorHandler\setupTemplate(), and LayoutEditorHandler\validate().

SubmissionLayoutHandler::saveSuppFile (   $args,
  $request 
)

Save a supplementary file.

Parameters
$argsarray ($suppFileId)
$requestRequest

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

References LayoutEditorHandler\$submission, DAORegistry\getDAO(), LayoutEditorHandler\setupTemplate(), and LayoutEditorHandler\validate().

SubmissionLayoutHandler::submission (   $args,
$request 
)
SubmissionLayoutHandler::SubmissionLayoutHandler ( )

Constructor

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

SubmissionLayoutHandler::uploadLayoutFile (   $args,
  $request 
)

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

Parameters
$argsarray
$requestPKPRequest

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

References LayoutEditorHandler\$submission, LayoutEditorAction\uploadLayoutVersion(), and LayoutEditorHandler\validate().

SubmissionLayoutHandler::viewFile (   $args,
$request 
)

View a file (inlines file).

Parameters
$argsarray ($articleId, $fileId, [$revision])
$requestPKPRequest

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

References LayoutEditorHandler\$submission, LayoutEditorHandler\validate(), and Action\viewFile().

Referenced by proofGalleyFile().

SubmissionLayoutHandler::viewMetadata (   $args,
  $request 
)

View submission metadata.

Parameters
$argsarray
$requestPKPRequest

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

References LayoutEditorHandler\setupTemplate(), submission(), LayoutEditorHandler\validate(), and Action\viewMetadata().


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