Свойство | Тип | Описание | |
---|---|---|---|
$_assocId | integer | ||
$_assocType | integer | ||
$_fileStage | integer | ||
$_reviewRound | integer | ||
$_revisedFileId | integer | ||
$_revisionOnly | boolean | ||
$_uploaderGroupIds | array | ||
$_uploaderRoles | array |
Метод | Описание | |
---|---|---|
__construct ( ) | Constructor | |
_checkForRevision ( &$uploadedFile, &$submissionFiles ) : integer | Check if the uploaded file has a similar name to an existing file which would then be a candidate for a revised file. | |
_getMetadataForm ( $request ) : SubmissionFilesMetadataForm | Retrieve the requested meta-data form. | |
_getUploadedFileInfo ( SubmissionFile $uploadedFile ) : array | Create an array that describes an uploaded file which can be used in a JSON response. | |
_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") | |
authorize ( $request, &$args, $roleAssignments ) | ||
confirmRevision ( $args, $request ) : JSONMessage | Confirm that the uploaded file is a revision of an earlier uploaded file. | |
displayFileUploadForm ( $args, $request ) : JSONMessage | Render the file upload form in its initial state. | |
editMetadata ( $args, $request ) : JSONMessage | Edit the metadata of the latest revision of the requested submission file. | |
finishFileSubmission ( $args, $request ) : JSONMessage | Display the final tab of the modal | |
getAssocId ( ) : integer | Get the assoc id (if any) | |
getAssocType ( ) : integer | Get the assoc type (if any) | |
getFileStage ( ) : integer | Get the workflow stage file storage that we upload files to. One of the SUBMISSION_FILE_* constants. | |
getReviewRound ( ) : ReviewRound | Get review round object. | |
getRevisedFileId ( ) : integer | Get the id of the file to be revised (if any). | |
getRevisionOnly ( ) : boolean | Does this uploader only allow revisions and no new files? | |
getStageId ( ) : integer | Get the authorized workflow stage. | |
getSubmission ( ) : Submission | The submission to which we upload files. | |
getUploaderGroupIds ( ) : array | Get the uploader group IDs. | |
getUploaderRoles ( ) : array | Get the uploader roles. | |
initialize ( $request, $args ) | ||
startWizard ( $args, $request ) : JSONMessage | Displays the file upload wizard. | |
uploadFile ( $args, $request ) : JSONMessage | Upload a file and render the modified upload wizard. |
Метод | Описание | |
---|---|---|
_attachEntities ( $submissionFile ) | Attach any dependent entities to a new file upload. |
protected _attachEntities ( $submissionFile ) | ||
$submissionFile | SubmissionFile |
public _checkForRevision ( &$uploadedFile, &$submissionFiles ) : integer | ||
$uploadedFile | SubmissionFile | |
$submissionFiles | array a list of submission files to check the uploaded file against. | |
Результат | integer | the if of the possibly revised file or null if no matches were found. |
public _getMetadataForm ( $request ) : SubmissionFilesMetadataForm | ||
$request | Request | |
Результат | SubmissionFilesMetadataForm |
public _getUploadedFileInfo ( SubmissionFile $uploadedFile ) : array | ||
$uploadedFile | SubmissionFile | |
Результат | array |
public _onlyNumbersDiffer ( $a, $b ) | ||
$a | string | |
$b | string |
public confirmRevision ( $args, $request ) : JSONMessage | ||
$args | array | |
$request | Request | |
Результат | JSONMessage | JSON object |
public displayFileUploadForm ( $args, $request ) : JSONMessage | ||
$args | array | |
$request | Request | |
Результат | JSONMessage | JSON object |
public editMetadata ( $args, $request ) : JSONMessage | ||
$args | array | |
$request | Request | |
Результат | JSONMessage | JSON object |
public finishFileSubmission ( $args, $request ) : JSONMessage | ||
$args | array | |
$request | Request | |
Результат | JSONMessage | JSON object |
public getAssocId ( ) : integer | ||
Результат | integer |
public getAssocType ( ) : integer | ||
Результат | integer |
public getFileStage ( ) : integer | ||
Результат | integer |
public getReviewRound ( ) : ReviewRound | ||
Результат | ReviewRound |
public getRevisedFileId ( ) : integer | ||
Результат | integer |
public getRevisionOnly ( ) : boolean | ||
Результат | boolean |
public getStageId ( ) : integer | ||
Результат | integer | One of the WORKFLOW_STAGE_ID_* constants. |
public getSubmission ( ) : Submission | ||
Результат | Submission |
public getUploaderGroupIds ( ) : array | ||
Результат | array |
public getUploaderRoles ( ) : array | ||
Результат | array |
public startWizard ( $args, $request ) : JSONMessage | ||
$args | array | |
$request | Request | |
Результат | JSONMessage | JSON object |
public uploadFile ( $args, $request ) : JSONMessage | ||
$args | array | |
$request | Request | |
Результат | JSONMessage | JSON object |