IdentificationCodeForm.inc.php

<?php
 
import('lib.pkp.classes.form.Form');
 
class IdentificationCodeForm extends Form {
   var $_submission;
 
   var $_publication;
 
   var $_identificationCode;
 
   public function __construct($submission, $publication, $identificationCode) {
      parent::__construct('controllers/grid/catalogEntry/form/codeForm.tpl');
      $this->setSubmission($submission);
      $this->setPublication($publication);
      $this->setIdentificationCode($identificationCode);
 
      // Validation checks for this form
      $this->addCheck(new FormValidator($this, 'code', 'required', 'grid.catalogEntry.codeRequired'));
      $this->addCheck(new FormValidator($this, 'value', 'required', 'grid.catalogEntry.valueRequired'));
      $this->addCheck(new FormValidator($this, 'representationId', 'required', 'grid.catalogEntry.publicationFormatRequired'));
      $this->addCheck(new FormValidatorPost($this));
      $this->addCheck(new FormValidatorCSRF($this));
   }
 
   //
   // Getters and Setters
   //
   public function getIdentificationCode() {
      return $this->_identificationCode;
   }
 
   public function setIdentificationCode($identificationCode) {
      $this->_identificationCode = $identificationCode;
   }
 
   public function getSubmission() {
      return $this->_submission;
   }
 
   public function setSubmission($submission) {
      $this->_submission = $submission;
   }
 
   public function getPublication() {
      return $this->_publication;
   }
 
   public function setPublication($publication) {
      $this->_publication = $publication;
   }
 
 
   //
   // Overridden template methods
   //
   public function initData() {
      $code = $this->getIdentificationCode();
 
      if ($code) {
         $this->_data = array(
            'identificationCodeId' => $code->getId(),
            'code' => $code->getCode(),
            'value' => $code->getValue(),
         );
      }
   }
 
   public function fetch($request, $template = null, $display = false) {
      $templateMgr = TemplateManager::getManager($request);
      $submission = $this->getSubmission();
      $templateMgr->assign('submissionId', $submission->getId());
      $templateMgr->assign('publicationId', $this->getPublication()->getId());
      $identificationCode = $this->getIdentificationCode();
 
      if ($identificationCode) {
         $templateMgr->assign('identificationCodeId', $identificationCode->getId());
         $templateMgr->assign('code', $identificationCode->getCode());
         $templateMgr->assign('value', $identificationCode->getValue());
         $representationId = $identificationCode->getPublicationFormatId();
      } else { // loading a blank form
         $representationId = (int) $request->getUserVar('representationId');
      }
 
      $publicationFormatDao = DAORegistry::getDAO('PublicationFormatDAO'); /* @var $publicationFormatDao PublicationFormatDAO */
      $publicationFormat = $publicationFormatDao->getById($representationId, $this->getPublication()->getId());
 
      if ($publicationFormat) { // the format exists for this submission
         $templateMgr->assign('representationId', $representationId);
         $identificationCodes = $publicationFormat->getIdentificationCodes();
         $assignedCodes = array_keys($identificationCodes->toAssociativeArray('code')); // currently assigned codes
         if ($identificationCode) $assignedCodes = array_diff($assignedCodes, array($identificationCode->getCode())); // allow existing codes to keep their value
         $onixCodelistItemDao = DAORegistry::getDAO('ONIXCodelistItemDAO'); /* @var $onixCodelistItemDao ONIXCodelistItemDAO */
 
         // since the pubId DOI plugin may be enabled, we give that precedence and remove DOI from here if that is the case.
         $pubIdPlugins = PluginRegistry::loadCategory('pubIds', true);
         foreach ($pubIdPlugins as $plugin) {
            if ($plugin->getEnabled() && $plugin->getPubIdType() == 'doi') {
               $assignedCodes[] = '06'; // 06 is DOI in ONIX-speak.
            }
         }
         $codes = $onixCodelistItemDao->getCodes('List5', $assignedCodes); // ONIX list for these
         $templateMgr->assign('identificationCodes', $codes);
      } else {
         fatalError('Format not in authorized submission');
      }
 
      return parent::fetch($request, $template, $display);
   }
 
   public function readInputData() {
      $this->readUserVars(array(
         'identificationCodeId',
         'representationId',
         'code',
         'value',
      ));
   }
 
   public function execute(...$functionArgs) {
      parent::execute(...$functionArgs);
      $identificationCodeDao = DAORegistry::getDAO('IdentificationCodeDAO'); /* @var $identificationCodeDao IdentificationCodeDAO */
      $publicationFormatDao = DAORegistry::getDAO('PublicationFormatDAO'); /* @var $publicationFormatDao PublicationFormatDAO */
 
      $submission = $this->getSubmission();
      $identificationCode = $this->getIdentificationCode();
      $publicationFormat = $publicationFormatDao->getById($this->getData('representationId', $this->getPublication()->getId()));
 
      if (!$identificationCode) {
         // this is a new code to this published submission
         $identificationCode = $identificationCodeDao->newDataObject();
         $existingFormat = false;
         if ($publicationFormat != null) { // ensure this format is in this submission
            $identificationCode->setPublicationFormatId($publicationFormat->getId());
         } else {
            fatalError('This format not in authorized submission context!');
         }
      } else {
         $existingFormat = true;
         if ($publicationFormat->getId() !== $identificationCode->getPublicationFormatId()) fatalError('Invalid format!');
      }
 
      $identificationCode->setCode($this->getData('code'));
      $identificationCode->setValue($this->getData('value'));
 
      if ($existingFormat) {
         $identificationCodeDao->updateObject($identificationCode);
         $identificationCodeId = $identificationCode->getId();
      } else {
         $identificationCodeId = $identificationCodeDao->insertObject($identificationCode);
      }
 
      return $identificationCodeId;
   }
}