SubmissionFilesMetadataForm.inc.php

<?php
 
import('lib.pkp.classes.form.Form');
 
class SubmissionFilesMetadataForm extends Form {
 
   var $_submissionFile;
 
   var $_stageId;
 
   var $_reviewRound;
 
   function __construct($submissionFile, $stageId, $reviewRound = null, $template = null) {
      if ($template === null) $template = 'controllers/wizard/fileUpload/form/submissionFileMetadataForm.tpl';
      parent::__construct($template);
      AppLocale::requireComponents(LOCALE_COMPONENT_PKP_SUBMISSION);
 
      // Initialize the object.
      $this->_submissionFile = $submissionFile;
      $this->_stageId = $stageId;
      if (is_a($reviewRound, 'ReviewRound')) {
         $this->_reviewRound = $reviewRound;
      }
 
      $submissionLocale = $submissionFile->getSubmissionLocale();
      $this->setDefaultFormLocale($submissionLocale);
 
      // Add validation checks.
      $this->addCheck(new FormValidatorLocale($this, 'name', 'required', 'submission.submit.fileNameRequired', $submissionLocale));
      $this->addCheck(new FormValidatorPost($this));
      $this->addCheck(new FormValidatorCSRF($this));
   }
 
 
   //
   // Getters and Setters
   //
   function getSubmissionFile() {
      return $this->_submissionFile;
   }
 
   function getStageId() {
      return $this->_stageId;
   }
 
   function getReviewRound() {
      return $this->_reviewRound;
   }
 
   function setShowButtons($showButtons) {
      $this->setData('showButtons', $showButtons);
   }
 
   function getShowButtons() {
      return $this->getData('showButtons');
   }
 
 
   //
   // Implement template methods from Form
   //
   function getLocaleFieldNames() {
      return array('name');
   }
 
   function readInputData() {
      $this->readUserVars(array('name', 'showButtons'));
   }
 
   function fetch($request, $template = null, $display = false) {
      $templateMgr = TemplateManager::getManager($request);
      $reviewRound = $this->getReviewRound();
      $templateMgr->assign(array(
         'submissionFile' => $this->getSubmissionFile(),
         'stageId' => $this->getStageId(),
         'reviewRoundId' => $reviewRound?$reviewRound->getId():null
      ));
      return parent::fetch($request, $template, $display);
   }
 
   function execute(...$functionParams) {
      parent::execute(...$functionParams);
 
      // Update the submission file with data from the form.
      $submissionFile = $this->getSubmissionFile();
      $submissionFile->setName($this->getData('name'), null); // Localized
      $submissionFileDao = DAORegistry::getDAO('SubmissionFileDAO'); /* @var $submissionFileDao SubmissionFileDAO */
      $submissionFileDao->updateObject($submissionFile);
   }
}