Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
PKPSubmissionFilesUploadForm Class Reference
Inheritance diagram for PKPSubmissionFilesUploadForm:
SubmissionFilesUploadBaseForm SubmissionFilesUploadForm

Public Member Functions

 _logEvent ($request, $user, $submissionFile, $assocType, $revisedFileId, $fileStage)
 
_retrieveGenreList ($request)
 
 _uploadFile ($request, $user, $uploaderUserGroupId, $revisedFileId, $fileGenre, $assocType, $assocId)
 
execute ($request)
 
 fetch ($request)
 
 getUploaderGroupIds ()
 
 getUploaderRoles ()
 
 PKPSubmissionFilesUploadForm ($request, $submissionId, $stageId, $uploaderRoles, $uploaderGroupIds, $fileStage, $revisionOnly=false, $reviewRound=null, $revisedFileId=null, $assocType=null, $assocId=null)
 
 readInputData ()
 
 validate ($request)
 
- Public Member Functions inherited from SubmissionFilesUploadBaseForm
getSubmissionFiles ()
 
 SubmissionFilesUploadBaseForm ($request, $template, $submissionId, $stageId, $fileStage, $revisionOnly=false, $reviewRound=null, $revisedFileId=null, $assocType=null, $assocId=null)
 

Detailed Description

Form for adding/editing a submission file.

Definition at line 19 of file PKPSubmissionFilesUploadForm.inc.php.

Member Function Documentation

PKPSubmissionFilesUploadForm::_logEvent (   $request,
  $user,
  $submissionFile,
  $assocType,
  $revisedFileId,
  $fileStage 
)

Log the upload event. Must be overridden in subclasses.

Parameters
PKPRequest$request
PKPUser$user
SubmissionFile$submissionFile
int$assocType
int$revisedFileId
int$fileStage

Definition at line 336 of file PKPSubmissionFilesUploadForm.inc.php.

& PKPSubmissionFilesUploadForm::_retrieveGenreList (   $request)

Retrieve the genre list.

Parameters
$requestRequest
Returns
array

Definition at line 294 of file PKPSubmissionFilesUploadForm.inc.php.

PKPSubmissionFilesUploadForm::_uploadFile (   $request,
  $user,
  $uploaderUserGroupId,
  $revisedFileId,
  $fileGenre,
  $assocType,
  $assocId 
)

Upload the file in an app-specific manner. must be overridden in subclasses.

Parameters
PKPRequest$request
PKPUser$user
$uploaderUserGroupIdint
int$revisedFileId
int$fileGenre
int$assocType
int$assocType
Returns
SubmissionFile

Definition at line 322 of file PKPSubmissionFilesUploadForm.inc.php.

& PKPSubmissionFilesUploadForm::execute (   $request)

Save the submission file upload form.

See Also
Form::execute()
Parameters
$requestRequest
Returns
SubmissionFile if successful, otherwise null

Definition at line 245 of file PKPSubmissionFilesUploadForm.inc.php.

PKPSubmissionFilesUploadForm::fetch (   $request)

Returns a string of the rendered form

Parameters
$requestPKPRequest
$templatestring the template to be rendered, mandatory if no template has been specified on class instantiation.
$displayboolean
Returns
string the rendered form

Definition at line 157 of file PKPSubmissionFilesUploadForm.inc.php.

PKPSubmissionFilesUploadForm::getUploaderGroupIds ( )

Get the uploader group IDs.

Returns
array|null

Definition at line 87 of file PKPSubmissionFilesUploadForm.inc.php.

PKPSubmissionFilesUploadForm::getUploaderRoles ( )

Get the uploader roles.

Returns
array

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

PKPSubmissionFilesUploadForm::PKPSubmissionFilesUploadForm (   $request,
  $submissionId,
  $stageId,
  $uploaderRoles,
  $uploaderGroupIds,
  $fileStage,
  $revisionOnly = false,
  $reviewRound = null,
  $revisedFileId = null,
  $assocType = null,
  $assocId = null 
)

Constructor.

Parameters
$requestRequest
$submissionIdinteger
$uploaderRolesarray
$uploaderGroupIdsarray|null
$stageIdinteger One of the WORKFLOW_STAGE_ID_* constants.
$fileStageinteger
$revisionOnlyboolean
$stageIdinteger
$reviewRoundReviewRound
$revisedFileIdinteger

Definition at line 47 of file PKPSubmissionFilesUploadForm.inc.php.

PKPSubmissionFilesUploadForm::readInputData ( )

Assign form data to user-submitted data. Can be overridden from subclasses.

Definition at line 98 of file PKPSubmissionFilesUploadForm.inc.php.

PKPSubmissionFilesUploadForm::validate (   $request)

Validate form data.

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

References DAORegistry\getDAO().


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