Issue.inc.php

<?php
 
define('ISSUE_ACCESS_OPEN', 1);
define('ISSUE_ACCESS_SUBSCRIPTION', 2);
 
class Issue extends DataObject {
   function getJournalId() {
      return $this->getData('journalId');
   }
 
   function setJournalId($journalId) {
      return $this->setData('journalId', $journalId);
   }
 
   function getLocalizedTitle() {
      return $this->getLocalizedData('title');
   }
 
   function getTitle($locale) {
      return $this->getData('title', $locale);
   }
 
   function setTitle($title, $locale) {
      return $this->setData('title', $title, $locale);
   }
 
   function getVolume() {
      return $this->getData('volume');
   }
 
   function setVolume($volume) {
      return $this->setData('volume', $volume);
   }
 
   function getNumber() {
      return $this->getData('number');
   }
 
   function setNumber($number) {
      return $this->setData('number', $number);
   }
 
   function getYear() {
      return $this->getData('year');
   }
 
   function setYear($year) {
      return $this->setData('year', $year);
   }
 
   function getPublished() {
      return $this->getData('published');
   }
 
   function setPublished($published) {
      return $this->setData('published', $published);
   }
 
   function getCurrent() {
      return $this->getData('current');
   }
 
   function setCurrent($current) {
      return $this->setData('current', $current);
   }
 
   function getDatePublished() {
      return $this->getData('datePublished');
   }
 
   function setDatePublished($datePublished) {
      return $this->setData('datePublished', $datePublished);
   }
 
   function getDateNotified() {
      return $this->getData('dateNotified');
   }
 
   function setDateNotified($dateNotified) {
      return $this->setData('dateNotified', $dateNotified);
   }
 
   function getLastModified() {
      return $this->getData('lastModified');
   }
 
   function setLastModified($lastModified) {
      return $this->setData('lastModified', $lastModified);
   }
 
   function stampModified() {
      return $this->setLastModified(Core::getCurrentDate());
   }
 
   function getAccessStatus() {
      return $this->getData('accessStatus');
   }
 
   function setAccessStatus($accessStatus) {
      return $this->setData('accessStatus', $accessStatus);
   }
 
   function getOpenAccessDate() {
      return $this->getData('openAccessDate');
   }
 
   function setOpenAccessDate($openAccessDate) {
      return $this->setData('openAccessDate', $openAccessDate);
   }
 
   function getLocalizedDescription() {
      return $this->getLocalizedData('description');
   }
 
   function getDescription($locale) {
      return $this->getData('description', $locale);
   }
 
   function setDescription($description, $locale) {
      return $this->setData('description', $description, $locale);
   }
 
   function getStoredPubId($pubIdType) {
      return $this->getData('pub-id::'.$pubIdType);
   }
 
   function setStoredPubId($pubIdType, $pubId) {
      return $this->setData('pub-id::'.$pubIdType, $pubId);
   }
 
   function getShowVolume() {
      return $this->getData('showVolume');
   }
 
   function setShowVolume($showVolume) {
      return $this->setData('showVolume', $showVolume);
   }
 
   function getShowNumber() {
      return $this->getData('showNumber');
   }
 
   function setShowNumber($showNumber) {
      return $this->setData('showNumber', $showNumber);
   }
 
   function getShowYear() {
      return $this->getData('showYear');
   }
 
   function setShowYear($showYear) {
      return $this->setData('showYear', $showYear);
   }
 
   function getShowTitle() {
      return $this->getData('showTitle');
   }
 
   function setShowTitle($showTitle) {
      return $this->setData('showTitle', $showTitle);
   }
 
   function getLocalizedCoverImage() {
      return $this->getLocalizedData('coverImage');
   }
 
   function getCoverImage($locale) {
      return $this->getData('coverImage', $locale);
   }
 
   function setCoverImage($coverImage, $locale) {
      return $this->setData('coverImage', $coverImage, $locale);
   }
 
   function getLocalizedCoverImageAltText() {
      return $this->getLocalizedData('coverImageAltText');
   }
 
   function getCoverImageAltText($locale) {
      return $this->getData('coverImageAltText', $locale);
   }
 
   function getLocalizedCoverImageUrl() {
      $coverImage = $this->getLocalizedCoverImage();
      if (!$coverImage) {
         return '';
      }
 
      $request = Application::get()->getRequest();
 
      import('classes.file.PublicFileManager');
      $publicFileManager = new PublicFileManager();
 
      return $request->getBaseUrl() . '/' . $publicFileManager->getContextFilesPath($this->getJournalId()) . '/' . $coverImage;
   }
 
   function getCoverImageUrls() {
      $coverImages = $this->getCoverImage(null);
      if (empty($coverImages)) {
         return array();
      }
 
      $request = Application::get()->getRequest();
      import('classes.file.PublicFileManager');
      $publicFileManager = new PublicFileManager();
 
      $urls = array();
 
      foreach ($coverImages as $locale => $coverImage) {
         $urls[$locale] = sprintf('%s/%s/%s', $request->getBaseUrl(), $publicFileManager->getContextFilesPath($this->getJournalId()), $coverImage);
      }
 
      return $urls;
   }
 
   function setCoverImageAltText($coverImageAltText, $locale) {
      return $this->setData('coverImageAltText', $coverImageAltText, $locale);
   }
 
   function getIssueIdentification($force = array(), $locale = null) {
 
      $displayOptions = array(
         'showVolume' => $this->getData('showVolume'),
         'showNumber' => $this->getData('showNumber'),
         'showYear' => $this->getData('showYear'),
         'showTitle' => $this->getData('showTitle'),
      );
 
      $displayOptions = array_merge($displayOptions, $force);
      if(is_null($locale)){
         $locale = AppLocale::getLocale();
      }
 
      AppLocale::requireComponents(array(LOCALE_COMPONENT_APP_COMMON), $locale);
      $volLabel = PKPLocale::translate('issue.vol', array(), $locale);
      $numLabel = PKPLocale::translate('issue.no', array(), $locale);
 
      $vol = $this->getData('volume');
      $num = $this->getData('number');
      $year = $this->getData('year');
      $title = $this->getTitle($locale);
      if(empty($title)){
         $title = $this->getLocalizedTitle();
      }
 
      $identification = array();
      foreach($displayOptions as $opt => $val) {
 
         if (empty($val)) {
            continue;
         }
 
         if ($opt == 'showVolume') {
            $identification[] = "$volLabel $vol";
         } elseif ($opt == 'showNumber') {
            $identification[] = "$numLabel $num";
         } elseif ($opt == 'showYear') {
            $identification[] = !empty($identification) ? "($year)" : $year;
         } elseif ($opt == 'showTitle' ) {
            if (!empty($title)) {
               // Append a separator to the last key
               if (!empty($identification)) {
                  end($identification);
                  $identification[key($identification)] .= ':';
               }
               $identification[] = $title;
            }
         }
      }
 
      // If we've got an empty title, re-run the function and force a result
      if (empty($identification)) {
         return $this->getIssueIdentification(
            array(
               'showVolume' => true,
               'showNumber' => true,
               'showYear' => true,
               'showTitle' => false,
            ),
            $locale
         );
      }
 
      return join(' ', $identification);
   }
 
   function getIssueSeries() {
      if ($this->getShowVolume() || $this->getShowNumber() || $this->getShowYear()) {
         return $this->getIssueIdentification(array('showTitle' => false));
      }
      return null;
   }
 
   function getNumArticles() {
      $issueDao = DAORegistry::getDAO('IssueDAO'); 
      return $issueDao->getNumArticles($this->getId());
   }
 
   function getBestIssueId() {
      return $this->getData('urlPath')
         ? $this->getData('urlPath')
         : $this->getId();
   }
 
   function hasDescription() {
      $description = $this->getLocalizedDescription();
      return !empty($description);
   }
 
   function getDAO() {
      return DAORegistry::getDAO('IssueDAO');
   }
}