classes/issue/Issue.inc.php

<?php

// $Id: Issue.inc.php,v 1.26 2008/07/01 01:16:10 asmecher Exp $


define('ISSUE_DEFAULT', 0);
define('OPEN_ACCESS', 1);
define('SUBSCRIPTION', 2);

class Issue extends DataObject {
   function getIssueId() {
      return $this->getData('issueId');
   }

   function setIssueId($issueId) {
      return $this->setData('issueId', $issueId);
   }

   function getJournalId() {
      return $this->getData('journalId');
   }

   function setJournalId($journalId) {
      return $this->setData('journalId', $journalId);
   }

   function getIssueTitle() {
      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 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 getIssueDescription() {
      return $this->getLocalizedData('description');
   }

   function getDescription($locale) {
      return $this->getData('description', $locale);
   }

   function setDescription($description, $locale) {
      return $this->setData('description', $description, $locale);
   }

   function getPublicIssueId() {
      // Ensure that blanks are treated as nulls
      $returner = $this->getData('publicIssueId');
      if ($returner === '') return null;
      return $returner;
   }

   function setPublicIssueId($publicIssueId) {
      return $this->setData('publicIssueId', $publicIssueId);
   }

   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 getIssueFileName() {
      return $this->getLocalizedData('fileName');
   }

   function getFileName($locale) {
      return $this->getData('fileName', $locale);
   }

   function setFileName($fileName, $locale) {
      return $this->setData('fileName', $fileName, $locale);
   }

   function getIssueWidth() {
      return $this->getLocalizedData('width');
   }

   function getWidth($locale) {
      return $this->getData('width', $locale);
   }

   function setWidth($width, $locale) {
      return $this->setData('width', $width, $locale);
   }

   function getIssueHeight() {
      return $this->getLocalizedData('height');
   }

   function getHeight($locale) {
      return $this->getData('height', $locale);
   }

   function setHeight($height, $locale) {
      return $this->setData('height', $height, $locale);
   }

   function getIssueOriginalFileName() {
      return $this->getLocalizedData('originalFileName');
   }

   function getOriginalFileName($locale) {
      return $this->getData('originalFileName', $locale);
   }

   function setOriginalFileName($originalFileName, $locale) {
      return $this->setData('originalFileName', $originalFileName, $locale);
   }

   function getIssueCoverPageAltText() {
      return $this->getLocalizedData('coverPageAltText');
   }

   function getCoverPageAltText($locale) {
      return $this->getData('coverPageAltText', $locale);
   }

   function setCoverPageAltText($coverPageAltText, $locale) {
      return $this->setData('coverPageAltText', $coverPageAltText, $locale);
   }

   function getIssueCoverPageDescription() {
      return $this->getLocalizedData('coverPageDescription');
   }

   function getCoverPageDescription($locale) {
      return $this->getData('coverPageDescription', $locale);
   }

   function setCoverPageDescription($coverPageDescription, $locale) {
      return $this->setData('coverPageDescription', $coverPageDescription, $locale);
   }

   function getIssueShowCoverPage() {
      return $this->getLocalizedData('showCoverPage');
   }

   function getShowCoverPage($locale) {
      return $this->getData('showCoverPage', $locale);
   }

   function setShowCoverPage($showCoverPage, $locale) {
      return $this->setData('showCoverPage', $showCoverPage, $locale);
   }

   function getHideCoverPageArchives($locale) {
      return $this->getData('hideCoverPageArchives', $locale);
   }

   function setHideCoverPageArchives($hideCoverPageArchives, $locale) {
      return $this->setData('hideCoverPageArchives', $hideCoverPageArchives, $locale);
   }

   function getHideCoverPageCover($locale) {
      return $this->getData('hideCoverPageCover', $locale);
   }

   function setHideCoverPageCover($hideCoverPageCover, $locale) {
      return $this->setData('hideCoverPageCover', $hideCoverPageCover, $locale);
   }

   function getStyleFileName() {
      return $this->getData('styleFileName');
   }

   function setStyleFileName($styleFileName) {
      return $this->setData('styleFileName', $styleFileName);
   }

   function getOriginalStyleFileName() {
      return $this->getData('originalStyleFileName');
   }

   function setOriginalStyleFileName($originalStyleFileName) {
      return $this->setData('originalStyleFileName', $originalStyleFileName);
   }

   function getAuthorString($lastOnly = false, $separator = ', ') {
      $str = '';
      foreach ($this->getAuthors() as $a) {
         if (!empty($str)) {
            $str .= $separator;
         }
         $str .= $lastOnly ? $a->getLastName() : $a->getFullName();
      }
      return $str;
   }

   function getIssueIdentification($default = false, $breadcrumb = false, $long = false) {

      if ($default) {
         $showVolume = 1;
         $showNumber = 1;
         $showYear = 1;
         $showTitle = 0;
      } else {
         $showVolume = $this->getData('showVolume');
         $showNumber = $this->getData('showNumber');
         $showYear = $this->getData('showYear');
         $showTitle = $this->getData('showTitle');
      }

      if ($breadcrumb && ($showVolume || $showNumber || $showYear)) {
         $showTitle = 0;
      }

      $volLabel = Locale::translate('issue.vol');
      $numLabel = Locale::translate('issue.no');

      $vol = $this->getData('volume');
      $num = $this->getData('number');
      $year = $this->getData('year');
      $title = $this->getLocalizedData('title');

      $identification = '';

      if ($showVolume) {
         $identification = "$volLabel $vol";
      }
      if ($showNumber) {
         if (!empty($identification)) {
            $identification .= ", ";
         }
         $identification .= "$numLabel $num";
      }
      if ($showYear) {
         if (!empty($identification)) {
            $identification .= " ($year)";
         } else {
            $identification = "$year";
         }
      }

      if ($showTitle || ($long && !empty($title))) {
         if (!empty($identification)) {
            $identification .= ': ';
         }
         $identification .= "$title";
      }

      if (empty($identification)) {
         $identification = "$volLabel $vol, $numLabel $num ($year)";
      }

      return $identification;
   }

   function getNumArticles() {
      return $this->getData('numArticles');
   }

   function setNumArticles($numArticles) {
      return $this->setData('numArticles', $numArticles);
   }

   function getBestIssueId($journal = null) {
      // Retrieve the journal, if necessary.
      if (!isset($journal)) {
         $journalDao = &DAORegistry::getDAO('JournalDAO');
         $journal = $journalDao->getJournal($this->getJournalId());
      }

      if ($journal->getSetting('enablePublicIssueId')) {
         $publicIssueId = $this->getPublicIssueId();
         if (!empty($publicIssueId)) return $publicIssueId;
      }
      return $this->getIssueId();
   }
}

?>

---