Open Journal Systems  3.3.0
SubmissionFilesUploadForm Class Reference
Inheritance diagram for SubmissionFilesUploadForm:
PKPSubmissionFilesUploadBaseForm Form

Public Member Functions

 __construct ($request, $submissionId, $stageId, $uploaderRoles, $fileStage, $revisionOnly=false, $reviewRound=null, $revisedFileId=null, $assocType=null, $assocId=null)
 
 _retrieveGenreList ($request)
 
 execute (... $functionParams)
 
 fetch ($request, $template=null, $display=false)
 
 getUploaderRoles ()
 
 readInputData ()
 
 validate ($callHooks=true)
 
- Public Member Functions inherited from PKPSubmissionFilesUploadBaseForm
 getAssocId ()
 
 getAssocType ()
 
 getReviewRound ()
 
 getRevisedFileId ()
 
 getRevisionSubmissionFilesSelection ($user, $uploadedFile=null)
 
 getStageId ()
 
 getSubmissionFiles ()
 
- Public Member Functions inherited from Form
 __construct ($template=null, $callHooks=true, $requiredLocale=null, $supportedLocales=null)
 
 _decomposeArray ($name, $value, $stack)
 
 addCheck ($formValidator)
 
 addError ($field, $message)
 
 addErrorField ($field)
 
 addSupportedFormLocale ($supportedLocale)
 
 display ($request=null, $template=null)
 
 getData ($key)
 
 getDefaultFormLocale ()
 
 getErrorsArray ()
 
 getLocaleFieldNames ()
 
 getRequiredLocale ()
 
 getTemplate ()
 
 initData ()
 
 isValid ()
 
 readUserVars ($vars)
 
 setData ($key, $value=null)
 
 setDefaultFormLocale ($defaultLocale)
 
 setTemplate ($template)
 

Data Fields

 $_uploaderRoles
 
- Data Fields inherited from PKPSubmissionFilesUploadBaseForm
 $_reviewRound
 
 $_stageId
 
 $_submissionFiles
 
- Data Fields inherited from Form
 $_checks
 
 $_data
 
 $_errors
 
 $_template
 
 $cssValidation
 
 $defaultLocale
 
 $errorFields
 
 $errorsArray
 
 $formSectionErrors
 
 $requiredLocale
 
 $supportedLocales
 

Detailed Description

Form for adding/editing a submission file.

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

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

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

Reimplemented from PKPSubmissionFilesUploadBaseForm.

Definition at line 40 of file SubmissionFilesUploadForm.inc.php.

References AppLocale\requireComponents(), and Form\setData().

Member Function Documentation

◆ _retrieveGenreList()

SubmissionFilesUploadForm::_retrieveGenreList (   $request)

Retrieve the genre list.

Parameters
$requestRequest
Returns
array

Definition at line 201 of file SubmissionFilesUploadForm.inc.php.

References DAORegistry\getDAO().

Referenced by fetch().

◆ execute()

SubmissionFilesUploadForm::execute (   $functionParams)

Save the submission file upload form.

See also
Form::execute()
Returns
SubmissionFile if successful, otherwise null

Reimplemented from Form.

Definition at line 133 of file SubmissionFilesUploadForm.inc.php.

References PKPApplication\get(), Form\getData(), PKPSubmissionFilesUploadBaseForm\getRevisedFileId(), and SubmissionFileLog\logEvent().

◆ fetch()

SubmissionFilesUploadForm::fetch (   $request,
  $template = null,
  $display = false 
)

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

Reimplemented from PKPSubmissionFilesUploadBaseForm.

Definition at line 120 of file SubmissionFilesUploadForm.inc.php.

References _retrieveGenreList(), and Form\setData().

◆ getUploaderRoles()

SubmissionFilesUploadForm::getUploaderRoles ( )

Get the uploader roles.

Returns
array

Definition at line 68 of file SubmissionFilesUploadForm.inc.php.

References $_uploaderRoles.

◆ readInputData()

SubmissionFilesUploadForm::readInputData ( )

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

Reimplemented from PKPSubmissionFilesUploadBaseForm.

Definition at line 80 of file SubmissionFilesUploadForm.inc.php.

References Form\readUserVars().

◆ validate()

SubmissionFilesUploadForm::validate (   $callHooks = true)

Validate form data.

Parameters
$callHooksboolean True (default) iff hooks are to be called.

Reimplemented from Form.

Definition at line 88 of file SubmissionFilesUploadForm.inc.php.

References Form\addCheck(), PKPApplication\get(), DAORegistry\getDAO(), Form\getData(), and PKPSubmissionFilesUploadBaseForm\getRevisedFileId().

Field Documentation

◆ $_uploaderRoles

array SubmissionFilesUploadForm::$_uploaderRoles

Definition at line 25 of file SubmissionFilesUploadForm.inc.php.

Referenced by getUploaderRoles().


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