PKPPubIdPluginHelper.inc.php

<?php
 
class PKPPubIdPluginHelper {
 
   function validate($contextId, $form, $pubObject) {
      $pubIdPlugins = PluginRegistry::loadCategory('pubIds', true, $contextId);
      if (!empty($pubIdPlugins)) {
         foreach ($pubIdPlugins as $pubIdPlugin) {
            $fieldNames = $pubIdPlugin->getFormFieldNames();
            foreach ($fieldNames as $fieldName) {
               $fieldValue = $form->getData($fieldName);
               $errorMsg = '';
               if(!$pubIdPlugin->verifyData($fieldName, $fieldValue, $pubObject, $contextId, $errorMsg)) {
                  $form->addError($fieldName, $errorMsg);
               }
            }
         }
      }
   }
 
   function setLinkActions($contextId, $form, $pubObject) {
      $pubIdPlugins = PluginRegistry::loadCategory('pubIds', true, $contextId);
      if (!empty($pubIdPlugins)) {
         foreach ($pubIdPlugins as $pubIdPlugin) {
            $linkActions = $pubIdPlugin->getLinkActions($pubObject);
            foreach ($linkActions as $linkActionName => $linkAction) {
               $form->setData($linkActionName, $linkAction);
               unset($linkAction);
            }
         }
      }
   }
 
   function addJavaScripts($contextId, $request, $templateMgr) {
      $pubIdPlugins = PluginRegistry::loadCategory('pubIds', true, $contextId);
      if (!empty($pubIdPlugins)) {
         foreach ($pubIdPlugins as $pubIdPlugin) {
            $pubIdPlugin->addJavaScript($request, $templateMgr);
         }
      }
   }
 
   function init($contextId, $form, $pubObject) {
      if (isset($pubObject)) {
         $pubIdPlugins = PluginRegistry::loadCategory('pubIds', true, $contextId);
         if (!empty($pubIdPlugins)) {
            foreach ($pubIdPlugins as $pubIdPlugin) {
               $fieldNames = $pubIdPlugin->getFormFieldNames();
               foreach ($fieldNames as $fieldName) {
                  $form->setData($fieldName, $pubObject->getData($fieldName));
               }
            }
         }
      }
   }
 
   function readInputData($contextId, $form) {
      $pubIdPlugins = PluginRegistry::loadCategory('pubIds', true, $contextId);
      if (!empty($pubIdPlugins)) {
         foreach ($pubIdPlugins as $pubIdPlugin) {
            $form->readUserVars($pubIdPlugin->getFormFieldNames());
            $form->readUserVars(array($pubIdPlugin->getAssignFormFieldName()));
         }
      }
   }
 
   function readAssignInputData($form) {
      $request = Application::get()->getRequest();
      $context = $request->getContext();
      $pubIdPlugins = PluginRegistry::loadCategory('pubIds', true, $context->getId());
      if (!empty($pubIdPlugins)) {
         foreach ($pubIdPlugins as $pubIdPlugin) {
            $form->readUserVars(array($pubIdPlugin->getAssignFormFieldName()));
         }
      }
   }
 
   function execute($contextId, $form, $pubObject) {
      $pubIdPlugins = PluginRegistry::loadCategory('pubIds', true, $contextId);
      if (!empty($pubIdPlugins)) {
         foreach ($pubIdPlugins as $pubIdPlugin) {
            // Public ID data can only be changed as long
            // as no ID has been generated.
            $storedId = $pubObject->getStoredPubId($pubIdPlugin->getPubIdType());
            if (!$storedId) {
               $fieldNames = $pubIdPlugin->getFormFieldNames();
               foreach ($fieldNames as $fieldName) {
                  $data = $form->getData($fieldName);
                  $pubObject->setData($fieldName, $data);
               }
               if ($form->getData($pubIdPlugin->getAssignFormFieldName())) {
                  $pubId = $pubIdPlugin->getPubId($pubObject);
                  $pubObject->setStoredPubId($pubIdPlugin->getPubIdType(), $pubId);
               }
            }
         }
      }
   }
 
   function assignPubId($contextId, $form, $pubObject, $save = false) {
      $pubIdPlugins = PluginRegistry::loadCategory('pubIds', true, $contextId);
      if (!empty($pubIdPlugins)) {
         foreach ($pubIdPlugins as $pubIdPlugin) {
            if ($form->getData($pubIdPlugin->getAssignFormFieldName())) {
               $pubId = $pubIdPlugin->getPubId($pubObject);
               if ($save) {
                  $pubIdPlugin->setStoredPubId($pubObject, $pubId);
               } else {
                  $pubObject->setStoredPubId($pubIdPlugin->getPubIdType(), $pubId);
               }
            }
         }
      }
   }
 
   function clearPubId($contextId, $pubIdPlugInClassName, $pubObject) {
      $pubIdPlugins = PluginRegistry::loadCategory('pubIds', true, $contextId);
      if (!empty($pubIdPlugins)) {
         foreach ($pubIdPlugins as $pubIdPlugin) {
            if (get_class($pubIdPlugin) == $pubIdPlugInClassName) {
               // clear the pubId:
               // delete the pubId from the DB
               $dao = $pubObject->getDAO();
               $pubObjectId = $pubObject->getId();
               if (is_a($pubObject, 'SubmissionFile')) {
                  $pubObjectId = $pubObject->getFileId();
               }
               $dao->deletePubId($pubObjectId, $pubIdPlugin->getPubIdType());
               // set the object setting/data 'pub-id::...' to null, in order
               // not to be considered in the DB object update later in the form
               $settingName = 'pub-id::'.$pubIdPlugin->getPubIdType();
               $pubObject->setData($settingName, null);
            }
         }
      }
   }
 
}