PKPPublication.inc.php

<?php
 
class PKPPublication extends DataObject {
 
   public function getLocalizedData($key, $preferredLocale = null) {
      // 1. Preferred locale
      if ($preferredLocale && $this->getData($key, $preferredLocale)) {
         return $this->getData($key, $preferredLocale);
      }
      // 2. User's current locale
      if (!empty($this->getData($key, AppLocale::getLocale()))) {
         return $this->getData($key, AppLocale::getLocale());
      }
      // 3. Publication's primary locale
      if (!empty($this->getData($key, $this->getData('locale')))) {
         return $this->getData($key, $this->getData('locale'));
      }
      // 4. The first locale we can find data for
      $data = $this->getData($key, null);
      foreach ((array) $data as $value) {
         if (!empty($value)) {
            return $value;
         }
      }
 
      return null;
   }
 
   public function getLocalizedFullTitle($preferredLocale = null) {
      $fullTitle = $this->getLocalizedTitle($preferredLocale);
      $subtitle = $this->getLocalizedData('subtitle', $preferredLocale);
      if ($subtitle) {
         return PKPString::concatTitleFields([$fullTitle, $subtitle]);
      }
      return $fullTitle;
   }
 
   public function getFullTitles() {
      $allTitles = (array) $this->getData('title');
      $return = [];
      foreach ($allTitles as $locale => $title) {
         if (!$title) {
            continue;
         }
         $return[$locale] = $this->getLocalizedFullTitle($locale);
      }
      return $return;
   }
 
   public function getLocalizedTitle($preferredLocale = null) {
      $prefix = $this->getLocalizedData('prefix', $preferredLocale);
      $title = $this->getLocalizedData('title', $preferredLocale);
      if ($prefix) {
         return $prefix . ' ' . $title;
      }
      return $title;
   }
 
   public function getTitles() {
      $allTitles = $this->getData('title');
      $return = [];
      foreach ($allTitles as $locale => $title) {
         if (!$title) {
            continue;
         }
         $return[] = $this->getLocalizedTitle($locale);
      }
      return $return;
   }
 
   public function getAuthorString($userGroups) {
      $authors = $this->getData('authors');
 
      if (empty($authors)) {
         return '';
      }
 
      $str = '';
      $lastUserGroupId = null;
      foreach($authors as $author) {
         if (!empty($str)) {
            if ($lastUserGroupId != $author->getData('userGroupId')) {
               foreach ($userGroups as $userGroup) {
                  if ($lastUserGroupId === $userGroup->getId()) {
                     if ($userGroup->getData('showTitle')) {
                        $str .= ' (' . $userGroup->getLocalizedData('name') . ')';
                     }
                     break;
                  }
               }
               $str .= __('common.semicolonListSeparator');
            } else {
               $str .= __('common.commaListSeparator');
            }
         }
         $str .= $author->getFullName();
         $lastUserGroupId = $author->getUserGroupId();
      }
 
      // If there needs to be a trailing user group title, add it
      if (isset($author)) {
         foreach($userGroups as $userGroup) {
            if ($author->getData('userGroupId') === $userGroup->getId()) {
               if ($userGroup->getData('showTitle')) {
                  $str .= ' (' . $userGroup->getLocalizedData('name') . ')';
               }
               break;
            }
         }
      }
 
      return $str;
   }
 
   public function getShortAuthorString() {
      $authors = $this->getData('authors');
 
      if (empty($authors)) {
         return '';
      }
 
      $str = $authors[0]->getLocalizedFamilyName();
      if (!$str) {
         $str = $authors[0]->getLocalizedGivenName();
      }
 
      if (count($authors) > 1) {
         AppLocale::requireComponents(LOCALE_COMPONENT_PKP_SUBMISSION);
         return __('submission.shortAuthor', ['author' => $str]);
      }
 
      return $str;
   }
 
   public function getPrimaryAuthor() {
      if (empty($this->getData('authors'))) {
         return null;
      }
      foreach ($this->getData('authors') as $author) {
         if ($author->getId() === $this->getData('primaryContactId')) {
            return $author;
         }
      }
   }
 
   public function stampModified() {
      return $this->setData('lastModified', Core::getCurrentDate());
   }
 
   public function getStartingPage() {
      $ranges = $this->getPageArray();
      $firstRange = array_shift($ranges);
      if (is_array($firstRange)) {
         return array_shift($firstRange);
      }
      return '';
   }
 
   public function getEndingPage() {
      $ranges = $this->getPageArray();
      $lastRange = array_pop($ranges);
      $lastPage = is_array($lastRange) ? array_pop($lastRange) : "";
      return isset($lastPage) ? $lastPage : "";
   }
 
   public function getPageArray() {
      $pages = $this->getData('pages');
      // Strip any leading word
      if (preg_match('/^[[:alpha:]]+\W/', $pages)) {
         // but don't strip a leading roman numeral
         if (!preg_match('/^[MDCLXVUI]+\W/i', $pages)) {
            // strip the word or abbreviation, including the period or colon
            $pages = preg_replace('/^[[:alpha:]]+[:.]?/', '', $pages);
         }
      }
      // strip leading and trailing space
      $pages = trim($pages);
      // shortcut the explode/foreach if the remainder is an empty value
      if ($pages === '') {
         return array();
      }
      // commas indicate distinct ranges
      $ranges = explode(',', $pages);
      $pageArray = array();
      foreach ($ranges as $range) {
         // hyphens (or double-hyphens) indicate range spans
         $pageArray[] = array_map('trim', explode('-', str_replace('--', '-', $range), 2));
      }
      return $pageArray;
   }
 
   function isCCLicense() {
      return preg_match('/creativecommons\.org/i', $this->getData('licenseUrl'));
   }
 
   function getStoredPubId($pubIdType) {
      return $this->getData('pub-id::' . $pubIdType);
   }
}