PKPPublicIdentifiersForm.inc.php

<?php
 
import('lib.pkp.classes.form.Form');
import('lib.pkp.classes.plugins.PKPPubIdPluginHelper');
 
class PKPPublicIdentifiersForm extends Form {
 
   var $_contextId;
 
   var $_pubObject;
 
   var $_stageId;
 
   var $_formParams;
 
   function __construct($pubObject, $stageId = null, $formParams = null) {
      parent::__construct('controllers/tab/pubIds/form/publicIdentifiersForm.tpl');
 
      $this->_pubObject = $pubObject;
      $this->_stageId = $stageId;
      $this->_formParams = $formParams;
 
      $request = Application::get()->getRequest();
      $context = $request->getContext();
      $this->_contextId = $context->getId();
 
      AppLocale::requireComponents(LOCALE_COMPONENT_PKP_EDITOR);
 
      $this->addCheck(new FormValidatorPost($this));
      $this->addCheck(new FormValidatorCSRF($this));
 
      // action links for pub id reset requests
      $pubIdPluginHelper = new PKPPubIdPluginHelper();
      $pubIdPluginHelper->setLinkActions($this->getContextId(), $this, $pubObject);
   }
 
   function fetch($request, $template = null, $display = false) {
      $templateMgr = TemplateManager::getManager($request);
      $templateMgr->assign(array(
         'pubIdPlugins' => PluginRegistry::loadCategory('pubIds', true, $this->getContextId()),
         'pubObject' => $this->getPubObject(),
         'stageId' => $this->getStageId(),
         'formParams' => $this->getFormParams(),
      ));
      if (is_a($this->getPubObject(), 'Representation') || is_a($this->getPubObject(), 'Chapter')) {
         $publicationId = $this->getPubObject()->getData('publicationId');
         $publication = Services::get('publication')->get($publicationId);
         $templateMgr->assign([
            'submissionId' => $publication->getData('submissionId'),
         ]);
      }
      // consider JavaScripts
      $pubIdPluginHelper = new PKPPubIdPluginHelper();
      $pubIdPluginHelper->addJavaScripts($this->getContextId(), $request, $templateMgr);
      return parent::fetch($request, $template, $display);
   }
 
   function initData() {
      $pubObject = $this->getPubObject();
      $this->setData('publisherId', $pubObject->getStoredPubId('publisher-id'));
      $pubIdPluginHelper = new PKPPubIdPluginHelper();
      $pubIdPluginHelper->init($this->getContextId(), $this, $pubObject);
      return parent::initData();
   }
 
 
   //
   // Getters
   //
   function getPubObject() {
      return $this->_pubObject;
   }
 
   function getStageId() {
      return $this->_stageId;
   }
 
   function getContextId() {
      return $this->_contextId;
   }
 
   function getFormParams() {
      return $this->_formParams;
   }
 
 
   //
   // Form methods
   //
   function readInputData() {
      $this->readUserVars(array('publisherId'));
      $pubIdPluginHelper = new PKPPubIdPluginHelper();
      $pubIdPluginHelper->readInputData($this->getContextId(), $this);
   }
 
   function validate($callHooks = true) {
      $pubObject = $this->getPubObject();
      $assocType = $this->getAssocType($pubObject);
      $publisherId = $this->getData('publisherId');
      $pubObjectId = $pubObject->getId();
      if ($assocType == ASSOC_TYPE_SUBMISSION_FILE) {
         $pubObjectId = $pubObject->getFileId();
      }
      $contextDao = Application::getContextDAO();
      if ($publisherId) {
         if (ctype_digit((string) $publisherId)) {
            $this->addError('publisherId', __('editor.publicIdentificationNumericNotAllowed', array('publicIdentifier' => $publisherId)));
            $this->addErrorField('$publisherId');
         } elseif (count(explode('/', $publisherId)) > 1) {
            $this->addError('publisherId', __('editor.publicIdentificationPatternNotAllowed', array('pattern' => '"/"')));
            $this->addErrorField('$publisherId');
         } elseif (is_a($pubObject, 'SubmissionFile') && preg_match('/^(\d+)-(\d+)$/', $publisherId)) {
            $this->addError('publisherId', __('editor.publicIdentificationPatternNotAllowed', array('pattern' => '\'/^(\d+)-(\d+)$/\' i.e. \'number-number\'')));
            $this->addErrorField('$publisherId');
         } elseif ($contextDao->anyPubIdExists($this->getContextId(), 'publisher-id', $publisherId, $assocType, $pubObjectId, true)) {
            $this->addError('publisherId', __('editor.publicIdentificationExistsForTheSameType', array('publicIdentifier' => $publisherId)));
            $this->addErrorField('$publisherId');
         }
      }
      $pubIdPluginHelper = new PKPPubIdPluginHelper();
      $pubIdPluginHelper->validate($this->getContextId(), $this, $this->getPubObject());
      return parent::validate($callHooks);
   }
 
   function execute(...$functionArgs) {
      parent::execute(...$functionArgs);
 
      $pubObject = $this->getPubObject();
      $pubObject->setStoredPubId('publisher-id', $this->getData('publisherId'));
 
      $pubIdPluginHelper = new PKPPubIdPluginHelper();
      $pubIdPluginHelper->execute($this->getContextId(), $this, $pubObject);
 
      if (is_a($pubObject, 'Representation')) {
         $representationDao = Application::getRepresentationDAO();
         $representationDao->updateObject($pubObject);
      } elseif (is_a($pubObject, 'SubmissionFile')) {
         $submissionFileDao = DAORegistry::getDAO('SubmissionFileDAO'); /* @var $submissionFileDao SubmissionFileDAO */
         $submissionFileDao->updateObject($pubObject);
      }
   }
 
   function clearPubId($pubIdPlugInClassName) {
      $pubIdPluginHelper = new PKPPubIdPluginHelper();
      $pubIdPluginHelper->clearPubId($this->getContextId(), $pubIdPlugInClassName, $this->getPubObject());
   }
 
   function getAssocType($pubObject) {
      $assocType = null;
      if (is_a($pubObject, 'Submission')) {
         $assocType = ASSOC_TYPE_SUBMISSION;
      } elseif (is_a($pubObject, 'Publication')) {
         $assocType = ASSOC_TYPE_PUBLICATION;
      } elseif (is_a($pubObject, 'Representation')) {
         $assocType = ASSOC_TYPE_REPRESENTATION;
      } elseif (is_a($pubObject, 'SubmissionFile')) {
         $assocType = ASSOC_TYPE_SUBMISSION_FILE;
      }
      return $assocType;
   }
}