Public Member Functions

FileUploadWizardHandler Class Reference
[Controllers_wizard_fileUpload]

A controller that handles basic server-side operations of the file upload wizard. More...

Inheritance diagram for FileUploadWizardHandler:
FileManagementHandler Handler

List of all members.

Public Member Functions

& _checkForRevision (&$uploadedFile, &$monographFiles)
& _getMetadataForm (&$request)
& _getUploadedFileInfo (&$uploadedFile)
 _onlyNumbersDiffer ($a, $b)
 confirmRevision ($args, &$request)
 displayFileUploadForm ($args, &$request)
 editMetadata ($args, &$request)
 FileUploadWizardHandler ()
 finishFileSubmission ($args, &$request)
 getAssocId ()
 getAssocType ()
 getFileStage ()
& getReviewRound ()
 getRevisedFileId ()
 getRevisionOnly ()
 getUploaderRoles ()
 initialize (&$request, $args)
 saveMetadata ($args, &$request)
 startWizard ($args, &$request)
 uploadFile ($args, &$request, $fileModifyCallback=null)

Detailed Description

A controller that handles basic server-side operations of the file upload wizard.

Definition at line 30 of file FileUploadWizardHandler.inc.php.

Member Function Documentation

& FileUploadWizardHandler._checkForRevision ( &$  uploadedFile,
&$  monographFiles 
)

Check if the uploaded file has a similar name to an existing file which would then be a candidate for a revised file.

Parameters:
$uploadedFile MonographFile
$monographFiles array a list of monograph files to check the uploaded file against.
Returns:
integer the if of the possibly revised file or null if no matches were found.

Definition at line 467 of file FileUploadWizardHandler.inc.php.

References _onlyNumbersDiffer().

Referenced by uploadFile().

& FileUploadWizardHandler._getMetadataForm ( &$  request  ) 

Retrieve the requested meta-data form.

Parameters:
$request Request
Returns:
SubmissionFilesMetadataForm

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

References FileManagementHandler.getMonograph(), getReviewRound(), and FileManagementHandler.getStageId().

Referenced by editMetadata(), and saveMetadata().

& FileUploadWizardHandler._getUploadedFileInfo ( &$  uploadedFile  ) 

Create an array that describes an uploaded file which can be used in a JSON response.

Parameters:
MonographFile $uploadedFile
Returns:
array

Definition at line 546 of file FileUploadWizardHandler.inc.php.

Referenced by confirmRevision(), and uploadFile().

FileUploadWizardHandler._onlyNumbersDiffer ( $  a,
$  b 
)

Helper function: check if the only difference between $a and $b is numeric. Used to exclude well-named but nearly identical file names from the revision detection pile (e.g. "Chapter 1" and "Chapter 2")

Parameters:
$a string
$b string

Definition at line 521 of file FileUploadWizardHandler.inc.php.

Referenced by _checkForRevision().

FileUploadWizardHandler.confirmRevision ( $  args,
&$  request 
)

Confirm that the uploaded file is a revision of an earlier uploaded file.

Parameters:
$args array
$request Request
Returns:
string a serialized JSON object

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

References _getUploadedFileInfo(), getFileStage(), FileManagementHandler.getMonograph(), getReviewRound(), and FileManagementHandler.getStageId().

FileUploadWizardHandler.displayFileUploadForm ( $  args,
&$  request 
)

Render the file upload form in its initial state.

Parameters:
$args array
$request Request
Returns:
string a serialized JSON object

Definition at line 270 of file FileUploadWizardHandler.inc.php.

References getAssocId(), getAssocType(), getFileStage(), FileManagementHandler.getMonograph(), getReviewRound(), getRevisedFileId(), getRevisionOnly(), FileManagementHandler.getStageId(), and getUploaderRoles().

FileUploadWizardHandler.editMetadata ( $  args,
&$  request 
)

Edit the metadata of the latest revision of the requested submission file.

Parameters:
$args array
$request Request
Returns:
string a serialized JSON object

Definition at line 384 of file FileUploadWizardHandler.inc.php.

References _getMetadataForm().

FileUploadWizardHandler.FileUploadWizardHandler (  ) 

Constructor

Definition at line 56 of file FileUploadWizardHandler.inc.php.

FileUploadWizardHandler.finishFileSubmission ( $  args,
&$  request 
)

Display the final tab of the modal

Parameters:
$args array
$request Request
Returns:
string a serialized JSON object

Definition at line 417 of file FileUploadWizardHandler.inc.php.

References FileManagementHandler.getMonograph().

FileUploadWizardHandler.getAssocId (  ) 

Get the assoc id (if any)

Returns:
integer

Definition at line 218 of file FileUploadWizardHandler.inc.php.

Referenced by displayFileUploadForm(), startWizard(), and uploadFile().

FileUploadWizardHandler.getAssocType (  ) 

Get the assoc type (if any)

Returns:
integer

Definition at line 210 of file FileUploadWizardHandler.inc.php.

Referenced by displayFileUploadForm(), startWizard(), and uploadFile().

FileUploadWizardHandler.getFileStage (  ) 

Get the workflow stage file storage that we upload files to. One of the MONOGRAPH_FILE_* constants.

Returns:
integer

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

Referenced by confirmRevision(), displayFileUploadForm(), startWizard(), and uploadFile().

& FileUploadWizardHandler.getReviewRound (  ) 

Get review round object.

Returns:
ReviewRound

Definition at line 194 of file FileUploadWizardHandler.inc.php.

Referenced by _getMetadataForm(), confirmRevision(), displayFileUploadForm(), initialize(), startWizard(), and uploadFile().

FileUploadWizardHandler.getRevisedFileId (  ) 

Get the id of the file to be revised (if any).

Returns:
integer

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

Referenced by displayFileUploadForm(), and startWizard().

FileUploadWizardHandler.getRevisionOnly (  ) 

Does this uploader only allow revisions and no new files?

Returns:
boolean

Definition at line 186 of file FileUploadWizardHandler.inc.php.

Referenced by displayFileUploadForm(), initialize(), startWizard(), and uploadFile().

FileUploadWizardHandler.getUploaderRoles (  ) 

Get the uploader roles.

Returns:
array

Definition at line 178 of file FileUploadWizardHandler.inc.php.

Referenced by displayFileUploadForm(), and startWizard().

FileUploadWizardHandler.initialize ( &$  request,
$  args 
)
See also:
PKPHandler.initialize()

Reimplemented from FileManagementHandler.

Definition at line 76 of file FileUploadWizardHandler.inc.php.

References getReviewRound(), and getRevisionOnly().

FileUploadWizardHandler.saveMetadata ( $  args,
&$  request 
)

Save the metadata of the latest revision of the requested submission file

Parameters:
$args array
$request Request
Returns:
string a serialized JSON object

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

References _getMetadataForm().

FileUploadWizardHandler.startWizard ( $  args,
&$  request 
)

Displays the file upload wizard.

Parameters:
$args array
$request Request
Returns:
string a serialized JSON object

Definition at line 231 of file FileUploadWizardHandler.inc.php.

References getAssocId(), getAssocType(), getFileStage(), FileManagementHandler.getMonograph(), getReviewRound(), getRevisedFileId(), getRevisionOnly(), FileManagementHandler.getStageId(), and getUploaderRoles().

FileUploadWizardHandler.uploadFile ( $  args,
&$  request,
$  fileModifyCallback = null 
)

Upload a file and render the modified upload wizard.

Parameters:
$args array
$request Request
Returns:
string a serialized JSON object

Definition at line 292 of file FileUploadWizardHandler.inc.php.

References _checkForRevision(), _getUploadedFileInfo(), getAssocId(), getAssocType(), getFileStage(), FileManagementHandler.getMonograph(), getReviewRound(), getRevisionOnly(), and FileManagementHandler.getStageId().

The documentation for this class was generated from the following file:
Generated on Mon Sep 17 2012 13:58:57 for Open Monograph Press by  doxygen 1.7.1