Open Journal Systems
3.3.0
|
Public Member Functions | |
__construct ($submissionFile, $stageId, $reviewRound=null, $template=null) | |
execute (... $functionParams) | |
fetch ($request, $template=null, $display=false) | |
getLocaleFieldNames () | |
getReviewRound () | |
getShowButtons () | |
getStageId () | |
getSubmissionFile () | |
readInputData () | |
setShowButtons ($showButtons) | |
Public Member Functions inherited from Form | |
_decomposeArray ($name, $value, $stack) | |
addCheck ($formValidator) | |
addError ($field, $message) | |
addErrorField ($field) | |
addSupportedFormLocale ($supportedLocale) | |
display ($request=null, $template=null) | |
getData ($key) | |
getDefaultFormLocale () | |
getErrorsArray () | |
getRequiredLocale () | |
getTemplate () | |
initData () | |
isValid () | |
readUserVars ($vars) | |
setData ($key, $value=null) | |
setDefaultFormLocale ($defaultLocale) | |
setTemplate ($template) | |
validate ($callHooks=true) | |
Data Fields | |
$_reviewRound | |
$_stageId | |
$_submissionFile | |
Data Fields inherited from Form | |
$_checks | |
$_data | |
$_errors | |
$_template | |
$cssValidation | |
$defaultLocale | |
$errorFields | |
$errorsArray | |
$formSectionErrors | |
$requiredLocale | |
$supportedLocales | |
Form for editing a submission file's metadata.
Definition at line 18 of file SubmissionFilesMetadataForm.inc.php.
SubmissionFilesMetadataForm::__construct | ( | $submissionFile, | |
$stageId, | |||
$reviewRound = null , |
|||
$template = null |
|||
) |
Constructor.
$submissionFile | SubmissionFile |
$stageId | int One of the WORKFLOW_STAGE_ID_* constants. |
$reviewRound | ReviewRound (optional) Current review round, if any. |
$template | string Path and filename to template file (optional). |
Reimplemented from Form.
Definition at line 45 of file SubmissionFilesMetadataForm.inc.php.
References Form\addCheck(), AppLocale\requireComponents(), and Form\setDefaultFormLocale().
SubmissionFilesMetadataForm::execute | ( | $functionParams | ) |
Execute the form's action. (Note that it is assumed that the form has already been validated.)
mixed | $functionArgs,... | Arguments from the caller to be passed to the hook consumer |
Reimplemented from Form.
Reimplemented in SubmissionFilesArtworkMetadataForm, and SupplementaryFileMetadataForm.
Definition at line 145 of file SubmissionFilesMetadataForm.inc.php.
References DAORegistry\getDAO(), Form\getData(), and getSubmissionFile().
SubmissionFilesMetadataForm::fetch | ( | $request, | |
$template = null , |
|||
$display = false |
|||
) |
Returns a string of the rendered form
$request | PKPRequest |
$template | string the template to be rendered, mandatory if no template has been specified on class instantiation. |
$display | boolean |
Reimplemented from Form.
Definition at line 131 of file SubmissionFilesMetadataForm.inc.php.
References PKPTemplateManager\getManager(), getReviewRound(), getStageId(), and getSubmissionFile().
SubmissionFilesMetadataForm::getLocaleFieldNames | ( | ) |
Get the list of field names that need to support multiple locales
Reimplemented from Form.
Definition at line 117 of file SubmissionFilesMetadataForm.inc.php.
SubmissionFilesMetadataForm::getReviewRound | ( | ) |
Get review round.
Definition at line 90 of file SubmissionFilesMetadataForm.inc.php.
References $_reviewRound.
Referenced by fetch().
SubmissionFilesMetadataForm::getShowButtons | ( | ) |
Get the "show buttons" flag
Definition at line 106 of file SubmissionFilesMetadataForm.inc.php.
References Form\getData().
SubmissionFilesMetadataForm::getStageId | ( | ) |
Get the workflow stage id.
Definition at line 82 of file SubmissionFilesMetadataForm.inc.php.
References $_stageId.
Referenced by fetch().
SubmissionFilesMetadataForm::getSubmissionFile | ( | ) |
Get the submission file.
Definition at line 74 of file SubmissionFilesMetadataForm.inc.php.
References $_submissionFile.
Referenced by SupplementaryFileMetadataForm\execute(), SubmissionFilesArtworkMetadataForm\execute(), execute(), and fetch().
SubmissionFilesMetadataForm::readInputData | ( | ) |
Assign form data to user-submitted data. Can be overridden from subclasses.
Reimplemented from Form.
Reimplemented in SubmissionFilesArtworkMetadataForm, and SupplementaryFileMetadataForm.
Definition at line 124 of file SubmissionFilesMetadataForm.inc.php.
References Form\readUserVars().
SubmissionFilesMetadataForm::setShowButtons | ( | $showButtons | ) |
Set the "show buttons" flag
$showButtons | boolean |
Definition at line 98 of file SubmissionFilesMetadataForm.inc.php.
References Form\setData().
ReviewRound SubmissionFilesMetadataForm::$_reviewRound |
Definition at line 36 of file SubmissionFilesMetadataForm.inc.php.
Referenced by getReviewRound().
integer SubmissionFilesMetadataForm::$_stageId |
Definition at line 30 of file SubmissionFilesMetadataForm.inc.php.
Referenced by getStageId().
SubmissionFile SubmissionFilesMetadataForm::$_submissionFile |
Definition at line 24 of file SubmissionFilesMetadataForm.inc.php.
Referenced by getSubmissionFile().