MedraSettingsForm.inc.php

<?php
 
import('lib.pkp.classes.form.Form');
 
class MedraSettingsForm extends Form {
 
   //
   // Private properties
   //
   var $_contextId;
 
   function _getContextId() {
      return $this->_contextId;
   }
 
   var $_plugin;
 
   function _getPlugin() {
      return $this->_plugin;
   }
 
   //
   // Constructor
   //
   function __construct($plugin, $contextId) {
      $this->_contextId = $contextId;
      $this->_plugin = $plugin;
 
      parent::__construct($plugin->getTemplateResource('settingsForm.tpl'));
 
      // DOI plugin settings action link
      $pubIdPlugins = PluginRegistry::loadCategory('pubIds', true);
      if (isset($pubIdPlugins['doipubidplugin'])) {
         $application = Application::get();
         $request = $application->getRequest();
         $dispatcher = $application->getDispatcher();
         import('lib.pkp.classes.linkAction.request.AjaxModal');
         $doiPluginSettingsLinkAction = new LinkAction(
               'settings',
               new AjaxModal(
                     $dispatcher->url($request, ROUTE_COMPONENT, null, 'grid.settings.plugins.SettingsPluginGridHandler', 'manage', null, array('plugin' => 'doipubidplugin', 'category' => 'pubIds')),
                     __('plugins.importexport.common.settings.DOIPluginSettings')
                     ),
               __('plugins.importexport.common.settings.DOIPluginSettings'),
               null
               );
         $this->setData('doiPluginSettingsLinkAction', $doiPluginSettingsLinkAction);
      }
 
      // Add form validation checks.
      $this->addCheck(new FormValidator($this, 'registrantName', FORM_VALIDATOR_REQUIRED_VALUE, 'plugins.importexport.medra.settings.form.registrantNameRequired'));
      $this->addCheck(new FormValidator($this, 'fromCompany', FORM_VALIDATOR_REQUIRED_VALUE, 'plugins.importexport.medra.settings.form.fromCompanyRequired'));
      $this->addCheck(new FormValidator($this, 'fromName', FORM_VALIDATOR_REQUIRED_VALUE, 'plugins.importexport.medra.settings.form.fromNameRequired'));
      $this->addCheck(new FormValidatorEmail($this, 'fromEmail', FORM_VALIDATOR_REQUIRED_VALUE, 'plugins.importexport.medra.settings.form.fromEmailRequired'));
      $this->addCheck(new FormValidatorInSet($this, 'exportIssuesAs', FORM_VALIDATOR_REQUIRED_VALUE, 'plugins.importexport.medra.settings.form.exportIssuesAs', array(O4DOI_ISSUE_AS_WORK, O4DOI_ISSUE_AS_MANIFESTATION)));
      $this->addCheck(new FormValidatorInSet($this, 'publicationCountry', FORM_VALIDATOR_REQUIRED_VALUE, 'plugins.importexport.medra.settings.form.publicationCountry', array_keys($this->_getCountries())));
      // The username is used in HTTP basic authentication and according to RFC2617 it therefore may not contain a colon.
      $this->addCheck(new FormValidatorRegExp($this, 'username', FORM_VALIDATOR_OPTIONAL_VALUE, 'plugins.importexport.medra.settings.form.usernameRequired', '/^[^:]+$/'));
      $this->addCheck(new FormValidatorPost($this));
   }
 
 
   //
   // Implement template methods from Form
   //
   function initData() {
      $contextId = $this->_getContextId();
      $plugin = $this->_getPlugin();
      foreach($this->getFormFields() as $fieldName => $fieldType) {
         $this->setData($fieldName, $plugin->getSetting($contextId, $fieldName));
      }
   }
 
   function fetch($request) {
      $templateMgr = TemplateManager::getManager($request);
 
      // Issue export options.
      $exportIssueOptions = array(
         O4DOI_ISSUE_AS_WORK => __('plugins.importexport.medra.settings.form.work'),
         O4DOI_ISSUE_AS_MANIFESTATION => __('plugins.importexport.medra.settings.form.manifestation'),
      );
      $templateMgr->assign('exportIssueOptions', $exportIssueOptions);
 
      // Countries.
      $templateMgr->assign('countries', $this->_getCountries());
      return parent::fetch($request);
   }
 
   function readInputData() {
      $this->readUserVars(array_keys($this->getFormFields()));
   }
 
   function execute(...$functionArgs) {
      $plugin = $this->_getPlugin();
      $contextId = $this->_getContextId();
      parent::execute(...$functionArgs);
      foreach($this->getFormFields() as $fieldName => $fieldType) {
         $plugin->updateSetting($contextId, $fieldName, $this->getData($fieldName), $fieldType);
      }
   }
 
 
   //
   // Public helper methods
   //
   function getFormFields() {
      return array(
         'registrantName' => 'string',
         'fromCompany' => 'string',
         'fromName' => 'string',
         'fromEmail' => 'string',
         'publicationCountry' => 'string',
         'exportIssuesAs' => 'int',
         'username' => 'string',
         'password' => 'string',
         'automaticRegistration' => 'bool',
         'testMode' => 'bool'
      );
   }
 
   function isOptional($settingName) {
      return in_array($settingName, array('username', 'password', 'automaticRegistration', 'testMode'));
   }
 
 
   //
   // Private helper methods
   //
   function _getCountries() {
      $isoCodes = new \Sokil\IsoCodes\IsoCodesFactory();
      $countries = array();
      foreach ($isoCodes->getCountries() as $country) {
         $countries[$country->getAlpha2()] = $country->getLocalName();
      }
      asort($countries);
      return $countries;
   }
}