PublicationFormatForm.inc.php

<?php
 
import('lib.pkp.classes.form.Form');
 
class PublicationFormatForm extends Form {
   var $_monograph;
 
   var $_publicationFormat;
 
   var $_publication = null;
 
   function __construct($monograph, $publicationFormat, $publication) {
      parent::__construct('controllers/grid/catalogEntry/form/formatForm.tpl');
      $this->setMonograph($monograph);
      $this->setPublicationFormat($publicationFormat);
      $this->setPublication($publication);
 
      // Validation checks for this form
      $this->addCheck(new FormValidator($this, 'name', 'required', 'grid.catalogEntry.nameRequired'));
      $this->addCheck(new FormValidator($this, 'entryKey', 'required', 'grid.catalogEntry.publicationFormatRequired'));
      $this->addCheck(new FormValidatorRegExp($this, 'urlPath', 'optional', 'validator.alpha_dash', '/^[-_a-z0-9]*$/'));
      $this->addCheck(new FormValidatorPost($this));
      $this->addCheck(new FormValidatorCSRF($this));
   }
 
   //
   // Getters and Setters
   //
   function getPublicationFormat() {
      return $this->_publicationFormat;
   }
 
   function setPublicationFormat($publicationFormat) {
      $this->_publicationFormat = $publicationFormat;
   }
 
   function getMonograph() {
      return $this->_monograph;
   }
 
   function setMonograph($monograph) {
      $this->_monograph = $monograph;
   }
 
 
   function getPublication() {
      return $this->_publication;
   }
 
   function setPublication($publication) {
      $this->_publication = $publication;
   }
 
 
   //
   // Overridden template methods
   //
   function initData() {
      $format = $this->getPublicationFormat();
 
      if ($format) {
         $this->_data = array(
            'entryKey' => $format->getEntryKey(),
            'name' => $format->getName(null),
            'isPhysicalFormat' => $format->getPhysicalFormat()?true:false,
            'remoteURL' => $format->getRemoteURL(),
            'urlPath' => $format->getData('urlPath'),
         );
      } else {
         $this->setData('entryKey', 'DA');
      }
   }
 
   function fetch($request, $template = null, $display = false) {
      $templateMgr = TemplateManager::getManager($request);
      $onixCodelistItemDao = DAORegistry::getDAO('ONIXCodelistItemDAO'); /* @var $onixCodelistItemDao ONIXCodelistItemDAO */
      $templateMgr->assign('entryKeys', $onixCodelistItemDao->getCodes('List7')); // List7 is for object formats
 
      $monograph = $this->getMonograph();
      $templateMgr->assign('submissionId', $monograph->getId());
      $publicationFormat = $this->getPublicationFormat();
      if ($publicationFormat != null) {
         $templateMgr->assign('representationId', $publicationFormat->getId());
      }
      $templateMgr->assign('publicationId', $this->getPublication()->getId());
      return parent::fetch($request, $template, $display);
   }
 
   function readInputData() {
      $this->readUserVars(array(
         'name',
         'entryKey',
         'isPhysicalFormat',
         'remoteURL',
         'urlPath',
      ));
   }
 
   function execute(...$functionParams) {
      parent::execute(...$functionParams);
 
      $publicationFormatDao = DAORegistry::getDAO('PublicationFormatDAO'); /* @var $publicationFormatDao PublicationFormatDAO */
      $publicationFormat = $this->getPublicationFormat();
      if (!$publicationFormat) {
         // this is a new format to this published submission
         $publicationFormat = $publicationFormatDao->newDataObject();
         $publicationFormat->setData('publicationId', $this->getPublication()->getId());
         $existingFormat = false;
      } else {
         $existingFormat = true;
         if ($this->getPublication()->getId() != $publicationFormat->getData('publicationId')) {
            throw new Exception('Invalid publication format');
         }
      }
 
      $publicationFormat->setName($this->getData('name'));
      $publicationFormat->setEntryKey($this->getData('entryKey'));
      $publicationFormat->setPhysicalFormat($this->getData('isPhysicalFormat')?true:false);
      $publicationFormat->setRemoteURL($this->getData('remoteURL'));
      $publicationFormat->setData('urlPath', $this->getData('urlPath'));
 
      if ($existingFormat) {
         $publicationFormatDao->updateObject($publicationFormat);
         $representationId = $publicationFormat->getId();
      } else {
         $representationId = $publicationFormatDao->insertObject($publicationFormat);
         // log the creation of the format.
         import('lib.pkp.classes.log.SubmissionLog');
         import('classes.log.SubmissionEventLogEntry');
         SubmissionLog::logEvent(Application::get()->getRequest(), $this->getMonograph(), SUBMISSION_LOG_PUBLICATION_FORMAT_CREATE, 'submission.event.publicationFormatCreated', array('formatName' => $publicationFormat->getLocalizedName()));
      }
 
      return $representationId;
   }
}