PKPSubmission.inc.php

<?php
 
// Submission status constants
define('STATUS_QUEUED', 1);
define('STATUS_PUBLISHED', 3);
define('STATUS_DECLINED', 4);
define('STATUS_SCHEDULED', 5);
 
// License settings (internal use only)
define ('PERMISSIONS_FIELD_LICENSE_URL', 1);
define ('PERMISSIONS_FIELD_COPYRIGHT_HOLDER', 2);
define ('PERMISSIONS_FIELD_COPYRIGHT_YEAR', 3);
 
abstract class PKPSubmission extends DataObject {
   function __construct() {
      // Switch on meta-data adapter support.
      $this->setHasLoadableAdapters(true);
 
      parent::__construct();
   }
 
   function getBestId() {
      return $this->getCurrentPublication()->getData('urlPath')
         ? $this->getCurrentPublication()->getData('urlPath')
         : $this->getId();
   }
 
   public function getCurrentPublication() {
      $publicationId = $this->getData('currentPublicationId');
      $publications = $this->getData('publications');
      if (!$publicationId || empty($publications)) {
         return null;
      }
      foreach ($publications as $publication) {
         if ($publication->getId() === $publicationId) {
            return $publication;
         }
      }
   }
 
   public function getLatestPublication() {
      $publications = $this->getData('publications');
      if (empty($publications)) {
         return null;
      }
      return array_reduce($publications, function($a, $b) {
         return $a && $a->getId() > $b->getId() ? $a : $b;
      });
   }
 
   public function getPublishedPublications() {
      $publications = $this->getData('publications');
      if (empty($publications)) {
         return [];
      }
      return array_filter($publications, function($publication) {
         return $publication->getData('status') === STATUS_PUBLISHED;
      });
   }
 
   public function stampModified() {
      return $this->setData('lastModified', Core::getCurrentDate());
   }
 
   public function stampLastActivity() {
      return $this->setData('dateLastActivity', Core::getCurrentDate());
   }
 
   public function stampStatusModified() {
      return $this->stampLastActivity();
   }
 
   function &getStatusMap() {
      static $statusMap;
      if (!isset($statusMap)) {
         $statusMap = array(
            STATUS_QUEUED => 'submissions.queued',
            STATUS_PUBLISHED => 'submission.status.published',
            STATUS_DECLINED => 'submission.status.declined',
            STATUS_SCHEDULED => 'submission.status.scheduled',
         );
      }
      return $statusMap;
   }
 
   function getStatusKey() {
      $statusMap =& $this->getStatusMap();
      return $statusMap[$this->getData('status')];
   }
 
   function getDAO() {
      return DAORegistry::getDAO('SubmissionDAO'); /* @var $submissionDao SubmissionDAO */
   }
 
   //
   // Abstract methods.
   //
   abstract function getSectionId();
 
   abstract function _getContextLicenseFieldValue($locale, $field);
 
   //
   // Deprecated methods
   //
 
   function getLocalizedCopyrightHolder($preferredLocale = null) {
      $publication = $this->getCurrentPublication();
      if (!$publication) {
         return '';
      }
      return $publication->getLocalizedData('copyrightHolder', $preferredLocale);
   }
 
   function getContextId() {
      return $this->getData('contextId');
   }
 
   function setContextId($contextId) {
      $this->setData('contextId', $contextId);
   }
 
   function &getLocalizedData($key, $preferredLocale = null) {
      $publication = $this->getCurrentPublication();
      if ($publication) {
         return $publication->getLocalizedData($key, $preferredLocale);
      }
      return null;
   }
 
   function getStoredPubId($pubIdType) {
      $publication = $this->getCurrentPublication();
      if (!$publication) {
         return '';
      }
      return $publication->getData('pub-id::'.$pubIdType);
   }
 
   function setStoredPubId($pubIdType, $pubId) {
      $publication = $this->getCurrentPublication();
      if ($publication) {
         $this->setData('pub-id::'.$pubIdType, $pubId);
      }
   }
 
   function getCopyrightHolder($locale) {
      $publication = $this->getCurrentPublication();
      if (!$publication) {
         return '';
      }
      return $publication->getData('copyrightHolder', $locale);
   }
 
   function setCopyrightHolder($copyrightHolder, $locale) {
      $publication = $this->getCurrentPublication();
      if ($publication) {
         $publication->setData('copyrightHolder', $copyrightHolder, $locale);
      }
   }
 
   function getCopyrightYear() {
      $publication = $this->getCurrentPublication();
      if (!$publication) {
         return '';
      }
      return $publication->getData('copyrightYear');
   }
 
   function setCopyrightYear($copyrightYear) {
      $publication = $this->getCurrentPublication();
      if ($publication) {
         $publication->setData('copyrightYear', $copyrightYear);
      }
   }
 
   function getLicenseURL() {
      $publication = $this->getCurrentPublication();
      if (!$publication) {
         return '';
      }
      return $publication->getData('licenseUrl');
   }
 
   function setLicenseURL($licenseURL) {
      $publication = $this->getCurrentPublication();
      if ($publication) {
         $publication->setData('licenseUrl', $licenseURL);
      }
   }
 
   function setHideAuthor($hideAuthor) {
      $publication = $this->getCurrentPublication();
      if ($publication) {
         $publication->setData('hideAuthor', $hideAuthor);
      }
   }
 
   function getAuthorString($preferred = true, $familyOnly = false) {
      $publication = $this->getCurrentPublication();
      if (!$publication) {
         return '';
      }
 
      $userGroupIds = array_map(function($author) {
         return $author->getData('userGroupId');
      }, $this->getAuthors());
      $userGroups = array_map(function($userGroupId) {
         $userGroupDao = DAORegistry::getDAO('UserGroupDAO'); /* @var $userGroupDao UserGroupDAO */
         return $userGroupDao->getbyId($userGroupId);
      }, array_unique($userGroupIds));
 
      return $publication->getAuthorString($userGroups);
   }
 
   function getShortAuthorString() {
      $publication = $this->getCurrentPublication();
      if (!$publication) {
         return '';
      }
      return $publication->getShortAuthorString();
   }
 
   function getAuthorEmails() {
      $authors = $this->getAuthors();
 
      import('lib.pkp.classes.mail.Mail');
      $returner = array();
      foreach($authors as $author) {
         $returner[] = Mail::encodeDisplayName($author->getFullName()) . ' <' . $author->getEmail() . '>';
      }
      return $returner;
   }
 
   function getAuthors($onlyIncludeInBrowse = false) {
      $publication = $this->getCurrentPublication();
      if (!$publication) {
         return [];
      }
      $authors = $publication->getData('authors');
      if (empty($authors)) {
         return [];
      }
      if ($onlyIncludeInBrowse) {
         return array_filter($authors, function($author) { return $author->getData('includeInBrowse'); });
      }
      return $authors;
   }
 
   function getPrimaryAuthor() {
      $publication = $this->getCurrentPublication();
      if (!$publication) {
         return null;
      }
      return $publication->getPrimaryAuthor();
   }
 
   function getLocale() {
      $publication = $this->getCurrentPublication();
      if (!$publication) {
         return '';
      }
      return $publication->getData('locale');
   }
 
   function setLocale($locale) {
      $publication = $this->getCurrentPublication();
      if ($publication) {
         $publication->setData('locale', $locale);
      }
   }
 
   function getLocalizedTitle($preferredLocale = null, $includePrefix = true) {
      $publication = $this->getCurrentPublication();
      if (!$publication) {
         return '';
      }
      return $publication->getLocalizedTitle($preferredLocale);
   }
 
   function getTitle($locale, $includePrefix = true) {
      $publication = $this->getCurrentPublication();
      if (!$publication) {
         return $locale ? '' : [];
      }
      if ($includePrefix) {
         if (is_null($locale)) {
            return $publication->getTitles();
         }
         return $publication->getLocalizedTitle($locale);
      }
      return $publication->getData('title');
   }
 
   function setTitle($title, $locale) {
      $this->setData('title', $title, $locale);
   }
 
   function getLocalizedSubtitle() {
      $publication = $this->getCurrentPublication();
      if (!$publication) {
         return '';
      }
      return $publication->getLocalizedData('subtitle');
   }
 
   function getSubtitle($locale) {
      $publication = $this->getCurrentPublication();
      if (!$publication) {
         return '';
      }
      return $publication->getData('subtitle', $locale);
   }
 
   function setSubtitle($subtitle, $locale) {
      $publication = $this->getCurrentPublication();
      if ($publication) {
         $this->setData('subtitle', $subtitle, $locale);
      }
   }
 
   function getLocalizedFullTitle() {
      $publication = $this->getCurrentPublication();
      if (!$publication) {
         return '';
      }
      return $publication->getLocalizedFullTitle();
   }
 
   function getFullTitle($locale) {
      $publication = $this->getCurrentPublication();
      if (!$publication) {
         return $locale ? '' : [];
      }
      if ($locale) {
         return $publication->getLocalizedFullTitle($locale);
      }
      return $publication->getFullTitles();
   }
 
   function getLocalizedPrefix() {
      $publication = $this->getCurrentPublication();
      if (!$publication) {
         return '';
      }
      return $publication->getLocalizedData('prefix');
   }
 
   function getPrefix($locale) {
      $publication = $this->getCurrentPublication();
      if (!$publication) {
         return $locale ? '' : [];
      }
      return $publication->getData('prefix', $locale);
   }
 
   function setPrefix($prefix, $locale) {
      $publication = $this->getCurrentPublication();
      if ($publication) {
         $publication->setData('prefix', $prefix, $locale);
      }
   }
 
   function getLocalizedAbstract() {
      $publication = $this->getCurrentPublication();
      if (!$publication) {
         return '';
      }
      return $publication->getLocalizedData('abstract');
   }
 
   function getAbstract($locale) {
      $publication = $this->getCurrentPublication();
      if (!$publication) {
         return $locale ? '' : [];
      }
      return $publication->getData('abstract', $locale);
   }
 
   function setAbstract($abstract, $locale) {
      $publication = $this->getCurrentPublication();
      if ($publication) {
         $publication->setData('abstract', $abstract, $locale);
      }
   }
 
   function getLocalizedDiscipline() {
      $publication = $this->getCurrentPublication();
      if (!$publication) {
         return '';
      }
      return $publication->getLocalizedData('discipline');
   }
 
   function getDiscipline($locale) {
      $publication = $this->getCurrentPublication();
      if (!$publication) {
         return $locale ? '' : [];
      }
      return $publication->getData('discipline', $locale);
   }
 
   function setDiscipline($discipline, $locale) {
      $publication = $this->getCurrentPublication();
      if ($publication) {
         $publication->setData('discipline', $discipline, $locale);
      }
   }
 
   function getLocalizedSubject() {
      $publication = $this->getCurrentPublication();
      if (!$publication) {
         return '';
      }
      return $publication->getLocalizedData('subject');
   }
 
   function getSubject($locale) {
      $publication = $this->getCurrentPublication();
      if (!$publication) {
         return $locale ? '' : [];
      }
      return $publication->getData('subjects', $locale);
   }
 
   function setSubject($subject, $locale) {
      $publication = $this->getCurrentPublication();
      if ($publication) {
         $publication->setData('subjects', $subject, $locale);
      }
   }
 
   function getLocalizedCoverage() {
      $publication = $this->getCurrentPublication();
      if (!$publication) {
         return '';
      }
      return $publication->getLocalizedData('coverage');
   }
 
   function getCoverage($locale) {
      $publication = $this->getCurrentPublication();
      if (!$publication) {
         return $locale ? '' : [];
      }
      return $publication->getData('coverage', $locale);
   }
 
   function setCoverage($coverage, $locale) {
      $publication = $this->getCurrentPublication();
      if ($publication) {
         $publication->setData('coverage', $coverage, $locale);
      }
   }
 
   function getLocalizedType() {
      $publication = $this->getCurrentPublication();
      if (!$publication) {
         return '';
      }
      return $publication->getLocalizedData('type');
   }
 
   function getType($locale) {
      $publication = $this->getCurrentPublication();
      if (!$publication) {
         return $locale ? '' : [];
      }
      return $publication->getData('type', $locale);
   }
 
   function setType($type, $locale) {
      $publication = $this->getCurrentPublication();
      if ($publication) {
         $publication->setData('type', $type, $locale);
      }
   }
 
   function getRights($locale) {
      $publication = $this->getCurrentPublication();
      if (!$publication) {
         return $locale ? '' : [];
      }
      return $publication->getData('rights', $locale);
   }
 
   function setRights($rights, $locale) {
      $publication = $this->getCurrentPublication();
      if ($publication) {
         $publication->setData('rights', $rights, $locale);
      }
   }
 
   function getSource($locale) {
      $publication = $this->getCurrentPublication();
      if (!$publication) {
         return $locale ? '' : [];
      }
      return $publication->getData('source', $locale);
   }
 
   function setSource($source, $locale) {
      $publication = $this->getCurrentPublication();
      if ($publication) {
         $publication->setData('source', $source, $locale);
      }
   }
 
   function getLanguage() {
      $publication = $this->getCurrentPublication();
      if (!$publication) {
         return '';
      }
      return $publication->getData('languages');
   }
 
   function setLanguage($language) {
      $publication = $this->getCurrentPublication();
      if ($publication) {
         $publication->setData('languages', $language);
      }
   }
 
   function getLocalizedSponsor() {
      $publication = $this->getCurrentPublication();
      if (!$publication) {
         return '';
      }
      return $publication->getLocalizedData('sponsor');
   }
 
   function getSponsor($locale) {
      $publication = $this->getCurrentPublication();
      if (!$publication) {
         return $locale ? '' : [];
      }
      return $publication->getData('sponsor', $locale);
   }
 
   function setSponsor($sponsor, $locale) {
      $publication = $this->getCurrentPublication();
      if ($publication) {
         $publication->setData('sponsor', $sponsor, $locale);
      }
   }
 
   function getCopyrightNotice($locale) {
      $publication = $this->getCurrentPublication();
      if (!$publication) {
         return $locale ? '' : [];
      }
      return $publication->getData('copyrightNotice', $locale);
   }
 
   function setCopyrightNotice($copyrightNotice, $locale) {
      $publication = $this->getCurrentPublication();
      if ($publication) {
         $publication->setData('copyrightNotice', $copyrightNotice, $locale);
      }
   }
 
   function getCitations() {
      $publication = $this->getCurrentPublication();
      if (!$publication) {
         return '';
      }
      return $publication->getData('citationsRaw');
   }
 
   function setCitations($citations) {
      $publication = $this->getCurrentPublication();
      if ($publication) {
         $publication->setData('citationsRaw', $citations);
      }
   }
 
   function getDateSubmitted() {
      return $this->getData('dateSubmitted');
   }
 
   function setDateSubmitted($dateSubmitted) {
      $this->setData('dateSubmitted', $dateSubmitted);
   }
 
   function getDateStatusModified() {
      return $this->getData('dateLastActivity');
   }
 
   function setDateStatusModified($dateModified) {
      $this->setData('dateLastActivity', $dateModified);
   }
 
   function getLastModified() {
      return $this->getData('lastModified');
   }
 
   function setLastModified($dateModified) {
      $this->setData('lastModified', $dateModified);
   }
 
   function getStatus() {
      return $this->getData('status');
   }
 
   function setStatus($status) {
      $this->setData('status', $status);
   }
 
   function getSubmissionProgress() {
      return $this->getData('submissionProgress');
   }
 
   function setSubmissionProgress($submissionProgress) {
      $this->setData('submissionProgress', $submissionProgress);
   }
 
   function getPages() {
      $publication = $this->getCurrentPublication();
      if (!$publication) {
         return '';
      }
      return $publication->getData('pages');
   }
 
   function getStartingPage() {
      $publication = $this->getCurrentPublication();
      return $publication ? $publication->getStartingPage() : '';
   }
 
   function getEndingPage() {
      $publication = $this->getCurrentPublication();
      return $publication ? $publication->getEndingPage() : '';
   }
 
   function getPageArray() {
      $publication = $this->getCurrentPublication();
      return $publication ? $publication->getPageArray() : '';
   }
 
   function setPages($pages) {
      $publication = $this->getCurrentPublication();
      if ($publication) {
         $publication->setData('pages', $pages);
      }
   }
 
   function getStageId() {
      return $this->getData('stageId');
   }
 
   function setStageId($stageId) {
      $this->setData('stageId', $stageId);
   }
 
   function getDatePublished() {
      $publication = $this->getCurrentPublication();
      if (!$publication) {
         return '';
      }
      return $publication->getData('datePublished');
   }
 
   function setDatePublished($datePublished) {
      $publication = $this->getCurrentPublication();
      if ($publication) {
         $publication->setData('datePublished', $datePublished);
      }
   }
 
   function isCCLicense() {
      $publication = $this->getCurrentPublication();
      return $publication && $publication->isCCLicense();
   }
 
        function getViews() {
                $application = Application::getApplication();
                return $application->getPrimaryMetricByAssoc(ASSOC_TYPE_SUBMISSION, $this->getId());
        }
}