PKPAuthorForm.inc.php

<?php
 
import('lib.pkp.classes.form.Form');
 
class PKPAuthorForm extends Form {
   var $_publication;
 
   var $_author;
 
   function __construct($publication, $author) {
      parent::__construct('controllers/grid/users/author/form/authorForm.tpl');
      $this->setPublication($publication);
      $this->setAuthor($author);
 
      // the publication locale should be the default/required locale
      $this->setDefaultFormLocale($publication->getData('locale'));
 
      // Validation checks for this form
      $form = $this;
      $this->addCheck(new FormValidatorLocale($this, 'givenName', 'required', 'user.profile.form.givenNameRequired', $this->defaultLocale));
      $this->addCheck(new FormValidatorCustom($this, 'familyName', 'optional', 'user.profile.form.givenNameRequired.locale', function($familyName) use ($form) {
         $givenNames = $form->getData('givenName');
         foreach ($familyName as $locale => $value) {
            if (!empty($value) && empty($givenNames[$locale])) {
               return false;
            }
         }
         return true;
      }));
      $this->addCheck(new FormValidatorEmail($this, 'email', 'required', 'form.emailRequired'));
      $this->addCheck(new FormValidatorUrl($this, 'userUrl', 'optional', 'user.profile.form.urlInvalid'));
      $this->addCheck(new FormValidator($this, 'userGroupId', 'required', 'submission.submit.form.contributorRoleRequired'));
      $this->addCheck(new FormValidatorORCID($this, 'orcid', 'optional', 'user.orcid.orcidInvalid'));
      $this->addCheck(new FormValidatorPost($this));
      $this->addCheck(new FormValidatorCSRF($this));
   }
 
   //
   // Getters and Setters
   //
   function getAuthor() {
      return $this->_author;
   }
 
   function setAuthor($author) {
      $this->_author = $author;
   }
 
   function getPublication() {
      return $this->_publication;
   }
 
   function setPublication($publication) {
      $this->_publication = $publication;
   }
 
 
   //
   // Overridden template methods
   //
   function initData() {
      $author = $this->getAuthor();
 
      if ($author) {
         $this->_data = array(
            'authorId' => $author->getId(),
            'givenName' => $author->getGivenName(null),
            'familyName' => $author->getFamilyName(null),
            'preferredPublicName' => $author->getPreferredPublicName(null),
            'affiliation' => $author->getAffiliation(null),
            'country' => $author->getCountry(),
            'email' => $author->getEmail(),
            'userUrl' => $author->getUrl(),
            'orcid' => $author->getOrcid(),
            'userGroupId' => $author->getUserGroupId(),
            'biography' => $author->getBiography(null),
            'primaryContact' => $this->getPublication()->getData('primaryContactId') === $author->getId(),
            'includeInBrowse' => $author->getIncludeInBrowse(),
         );
      } else {
         // assume authors should be listed unless otherwise specified.
         $this->_data = array('includeInBrowse' => true);
      }
      // in order to be able to use the hook
      return parent::initData();
   }
 
   function fetch($request, $template = null, $display = false) {
      $userGroupDao = DAORegistry::getDAO('UserGroupDAO'); /* @var $userGroupDao UserGroupDAO */
      $authorUserGroups = $userGroupDao->getByRoleId($request->getContext()->getId(), ROLE_ID_AUTHOR);
      $publication = $this->getPublication();
      $isoCodes = new \Sokil\IsoCodes\IsoCodesFactory();
      $countries = array();
      foreach ($isoCodes->getCountries() as $country) {
         $countries[$country->getAlpha2()] = $country->getLocalName();
      }
      asort($countries);
      $templateMgr = TemplateManager::getManager($request);
      $templateMgr->assign(array(
         'submissionId' => $publication->getData('submissionId'),
         'publicationId' => $publication->getId(),
         'countries' => $countries,
         'authorUserGroups' => $authorUserGroups,
      ));
 
      return parent::fetch($request, $template, $display);
   }
 
   function readInputData() {
      $this->readUserVars(array(
         'authorId',
         'givenName',
         'familyName',
         'preferredPublicName',
         'affiliation',
         'country',
         'email',
         'userUrl',
         'orcid',
         'userGroupId',
         'biography',
         'primaryContact',
         'includeInBrowse',
      ));
   }
 
   function execute(...$functionParams) {
      $authorDao = DAORegistry::getDAO('AuthorDAO'); /* @var $authorDao AuthorDAO */
      $publication = $this->getPublication();
 
      $author = $this->getAuthor();
      if (!$author) {
         // this is a new submission contributor
         $this->_author = $authorDao->newDataObject();
         $author = $this->getAuthor();
         $author->setData('publicationId', $publication->getId());
         $author->setData('seq', count($publication->getData('authors')));
         $existingAuthor = false;
      } else {
         $existingAuthor = true;
         if ($publication->getId() !== $author->getData('publicationId')) fatalError('Invalid author!');
      }
 
      $author->setGivenName($this->getData('givenName'), null);
      $author->setFamilyName($this->getData('familyName'), null);
      $author->setPreferredPublicName($this->getData('preferredPublicName'), null);
      $author->setAffiliation($this->getData('affiliation'), null); // localized
      $author->setCountry($this->getData('country'));
      $author->setEmail($this->getData('email'));
      $author->setUrl($this->getData('userUrl'));
      $author->setOrcid($this->getData('orcid'));
      $author->setUserGroupId($this->getData('userGroupId'));
      $author->setBiography($this->getData('biography'), null); // localized
      $author->setIncludeInBrowse(($this->getData('includeInBrowse') ? true : false));
 
      // in order to be able to use the hook
      parent::execute(...$functionParams);
 
      if ($existingAuthor) {
         $authorDao->updateObject($author);
         $authorId = $author->getId();
      } else {
         $authorId = $authorDao->insertObject($author);
      }
 
      if ($this->getData('primaryContact')) {
         $submission = Services::get('submission')->get($publication->getData('submissionId'));
         $context = Services::get('context')->get($submission->getData('contextId'));
         $params = ['primaryContactId' => $authorId];
         $errors = Services::get('publication')->validate(
            VALIDATE_ACTION_EDIT,
            $params,
            $context->getData('supportedLocales'),
            $publication->getData('locale')
         );
         if (!empty($errors)) {
            throw new Exception('Invalid primary contact ID. This author can not be a primary contact.');
         }
         $publication = Services::get('publication')->edit($publication, $params, Application::get()->getRequest());
      }
 
      return $authorId;
   }
}