URNSettingsForm.inc.php

<?php
 
import('lib.pkp.classes.form.Form');
 
class URNSettingsForm extends Form {
 
   //
   // Private properties
   //
   var $_contextId;
 
   function _getContextId() {
      return $this->_contextId;
   }
 
   var $_plugin;
 
   function _getPlugin() {
      return $this->_plugin;
   }
 
   //
   // Constructor
   //
   public function __construct($plugin, $contextId) {
      $this->_contextId = $contextId;
      $this->_plugin = $plugin;
 
      parent::__construct($plugin->getTemplateResource('settingsForm.tpl'));
 
      $form = $this;
      $this->addCheck(new FormValidatorCustom($this, 'urnObjects', 'required', 'plugins.pubIds.urn.manager.settings.urnObjectsRequired', function($enableIssueURN) use ($form) {
         return $form->getData('enableIssueURN') || $form->getData('enablePublicationURN') || $form->getData('enableRepresentationURN');
      }));
      $this->addCheck(new FormValidatorRegExp($this, 'urnPrefix', 'required', 'plugins.pubIds.urn.manager.settings.form.urnPrefixPattern', '/^urn:[a-zA-Z0-9-]*:.*/'));
      $this->addCheck(new FormValidatorCustom($this, 'urnPublicationSuffixPattern', 'required', 'plugins.pubIds.urn.manager.settings.form.urnPublicationSuffixPatternRequired', function($urnPublicationSuffixPattern) use ($form) {
         if ($form->getData('urnSuffix') == 'pattern' && $form->getData('enablePublicationURN')) return $urnPublicationSuffixPattern != '';
         return true;
      }));
      $this->addCheck(new FormValidatorCustom($this, 'urnChapterSuffixPattern', 'required', 'plugins.pubIds.urn.manager.settings.form.urnChapterSuffixPatternRequired', function($urnChapterSuffixPattern) use ($form) {
         if ($form->getData('urnSuffix') == 'pattern' && $form->getData('enableChapterURN')) return $urnChapterSuffixPattern != '';
         return true;
      }));
      $this->addCheck(new FormValidatorCustom($this, 'urnRepresentationSuffixPattern', 'required', 'plugins.pubIds.urn.manager.settings.form.urnRepresentationSuffixPatternRequired', function($urnRepresentationSuffixPattern) use ($form) {
         if ($form->getData('urnSuffix') == 'pattern' && $form->getData('enableRepresentationURN')) return $urnRepresentationSuffixPattern != '';
         return true;
      }));
      $this->addCheck(new FormValidatorCustom($this, 'urnSubmissionFileSuffixPattern', 'required', 'plugins.pubIds.urn.manager.settings.form.urnSubmissionFileSuffixPattern', function($urnSubmissionFileSuffixPattern) use ($form) {
         if ($form->getData('urnSuffix') == 'pattern' && $form->getData('enableSubmissionFileURN')) return $urnSubmissionFileSuffixPattern != '';
         return true;
      }));
      $this->addCheck(new FormValidatorUrl($this, 'urnResolver', 'required', 'plugins.pubIds.urn.manager.settings.form.urnResolverRequired'));
      $this->addCheck(new FormValidatorPost($this));
      $this->addCheck(new FormValidatorCSRF($this));
 
      // for URN reset requests
      import('lib.pkp.classes.linkAction.request.RemoteActionConfirmationModal');
      $request = Application::get()->getRequest();
      $this->setData('clearPubIdsLinkAction', new LinkAction(
         'reassignURNs',
         new RemoteActionConfirmationModal(
            $request->getSession(),
            __('plugins.pubIds.urn.manager.settings.urnReassign.confirm'),
            __('common.delete'),
            $request->url(null, null, 'manage', null, array('verb' => 'clearPubIds', 'plugin' => $plugin->getName(), 'category' => 'pubIds')),
            'modal_delete'
         ),
         __('plugins.pubIds.urn.manager.settings.urnReassign'),
         'delete'
      ));
      $this->setData('pluginName', $plugin->getName());
   }
 
 
   //
   // Implement template methods from Form
   //
   public function fetch($request, $template = null, $display = false) {
      $urnNamespaces = array(
         '' => '',
         'urn:nbn:de' => 'urn:nbn:de',
         'urn:nbn:at' => 'urn:nbn:at',
         'urn:nbn:ch' => 'urn:nbn:ch',
         'urn:nbn' => 'urn:nbn',
         'urn' => 'urn'
      );
      $templateMgr = TemplateManager::getManager($request);
      $templateMgr->assign('urnNamespaces', $urnNamespaces);
      return parent::fetch($request, $template, $display);
   }
 
   public function initData() {
      $contextId = $this->_getContextId();
      $plugin = $this->_getPlugin();
      foreach($this->_getFormFields() as $fieldName => $fieldType) {
         $this->setData($fieldName, $plugin->getSetting($contextId, $fieldName));
      }
   }
 
   public function readInputData() {
      $this->readUserVars(array_keys($this->_getFormFields()));
   }
 
   public function execute(...$functionArgs) {
      $contextId = $this->_getContextId();
      $plugin = $this->_getPlugin();
      foreach($this->_getFormFields() as $fieldName => $fieldType) {
         $plugin->updateSetting($contextId, $fieldName, $this->getData($fieldName), $fieldType);
      }
      parent::execute(...$functionArgs);
   }
 
   //
   // Private helper methods
   //
   public function _getFormFields() {
      return array(
         'enablePublicationURN' => 'bool',
         'enableChapterURN' => 'bool',
         'enableRepresentationURN' => 'bool',
         'enableSubmissionFileURN' => 'bool',
         'urnPrefix' => 'string',
         'urnSuffix' => 'string',
         'urnPublicationSuffixPattern' => 'string',
         'urnChapterSuffixPattern' => 'string',
         'urnRepresentationSuffixPattern' => 'string',
         'urnSubmissionFileSuffixPattern' => 'string',
         'urnCheckNo' => 'bool',
         'urnNamespace' => 'string',
         'urnResolver' => 'string',
      );
   }
}