classes/article/Article.inc.php

<?php

// $Id: Article.inc.php,v 1.37 2008/07/01 01:16:09 asmecher Exp $


// Submission status constants
define('STATUS_ARCHIVED', 0);
define('STATUS_QUEUED', 1);
// define('STATUS_SCHEDULED', 2); // #2187: Scheduling queue removed.
define('STATUS_PUBLISHED', 3);
define('STATUS_DECLINED', 4);

// AuthorSubmission::getSubmissionStatus will return one of these in place of QUEUED:
define ('STATUS_QUEUED_UNASSIGNED', 5);
define ('STATUS_QUEUED_REVIEW', 6);
define ('STATUS_QUEUED_EDITING', 7);
define ('STATUS_INCOMPLETE', 8);

// Author display in ToC
define ('AUTHOR_TOC_DEFAULT', 0);
define ('AUTHOR_TOC_HIDE', 1);
define ('AUTHOR_TOC_SHOW', 2);

// Article RT comments
define ('COMMENTS_SECTION_DEFAULT', 0);
define ('COMMENTS_DISABLE', 1);
define ('COMMENTS_ENABLE', 2);

class Article extends DataObject {

   var $authors;

   var $removedAuthors;

   function Article() {
      parent::DataObject();
      $this->authors = array();
      $this->removedAuthors = array();
   }

   function addAuthor($author) {
      if ($author->getArticleId() == null) {
         $author->setArticleId($this->getArticleId());
      }
      if ($author->getSequence() == null) {
         $author->setSequence(count($this->authors) + 1);
      }
      array_push($this->authors, $author);
   }

   function removeAuthor($authorId) {
      $found = false;

      if ($authorId != 0) {
         // FIXME maintain a hash of ID to author for quicker get/remove
         $authors = array();
         for ($i=0, $count=count($this->authors); $i < $count; $i++) {
            if ($this->authors[$i]->getAuthorId() == $authorId) {
               array_push($this->removedAuthors, $authorId);
               $found = true;
            } else {
               array_push($authors, $this->authors[$i]);
            }
         }
         $this->authors = $authors;
      }
      return $found;
   }

   function getArticleTitle() {
      return $this->getLocalizedData('title');
   }

   function getArticleAbstract() {
      return $this->getLocalizedData('abstract');
   }

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

   function getAuthorEmails() {
      import('mail.Mail');
      $returner = array();
      foreach ($this->authors as $a) {
         $returner[] = Mail::encodeDisplayName($a->getFullName()) . ' <' . $a->getEmail() . '>';
      }
      return $returner;
   }

   function getFirstAuthor($lastOnly = false) {
      $author = $this->authors[0];
      return $lastOnly ? $author->getLastName() : $author->getFullName();
   }


   //
   // Get/set methods
   //

   function &getAuthors() {
      return $this->authors;
   }

   function &getAuthor($authorId) {
      $author = null;

      if ($authorId != 0) {
         for ($i=0, $count=count($this->authors); $i < $count && $author == null; $i++) {
            if ($this->authors[$i]->getAuthorId() == $authorId) {
               $author = &$this->authors[$i];
            }
         }
      }
      return $author;
   }

   function &getRemovedAuthors() {
      return $this->removedAuthors;
   }

   function setAuthors($authors) {
      return $this->authors = $authors;
   }

   function getArticleId() {
      return $this->getData('articleId');
   }

   function setArticleId($articleId) {
      return $this->setData('articleId', $articleId);
   }

   function getUserId() {
      return $this->getData('userId');
   }

   function setUserId($userId) {
      return $this->setData('userId', $userId);
   }

   function getUser() {
      $userDao = &DAORegistry::getDAO('UserDAO');
      return $userDao->getUser($this->getUserId(), true);
   }

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

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

   function getSectionId() {
      return $this->getData('sectionId');
   }

   function setSectionId($sectionId) {
      return $this->setData('sectionId', $sectionId);
   }

   function getSectionTitle() {
      return $this->getData('sectionTitle');
   }

   function setSectionTitle($sectionTitle) {
      return $this->setData('sectionTitle', $sectionTitle);
   }

   function getSectionAbbrev() {
      return $this->getData('sectionAbbrev');
   }

   function setSectionAbbrev($sectionAbbrev) {
      return $this->setData('sectionAbbrev', $sectionAbbrev);
   }

   function getTitle($locale) {
      return $this->getData('title', $locale);
   }

   function setTitle($title, $locale) {
      return $this->setData('title', $title, $locale);
   }

   function getAbstract($locale) {
      return $this->getData('abstract', $locale);
   }

   function setAbstract($abstract, $locale) {
      return $this->setData('abstract', $abstract, $locale);
   }

   function getArticleDiscipline() {
      return $this->getLocalizedData('discipline');
   }

   function getDiscipline($locale) {
      return $this->getData('discipline', $locale);
   }

   function setDiscipline($discipline, $locale) {
      return $this->setData('discipline', $discipline, $locale);
   }

   function getArticleSubjectClass() {
      return $this->getLocalizedData('subjectClass');
   }

   function getSubjectClass($locale) {
      return $this->getData('subjectClass', $locale);
   }

   function setSubjectClass($subjectClass, $locale) {
      return $this->setData('subjectClass', $subjectClass, $locale);
   }

   function getArticleSubject() {
      return $this->getLocalizedData('subject');
   }

   function getSubject($locale) {
      return $this->getData('subject', $locale);
   }

   function setSubject($subject, $locale) {
      return $this->setData('subject', $subject, $locale);
   }

   function getArticleCoverageGeo() {
      return $this->getLocalizedData('coverageGeo');
   }

   function getCoverageGeo($locale) {
      return $this->getData('coverageGeo', $locale);
   }

   function setCoverageGeo($coverageGeo, $locale) {
      return $this->setData('coverageGeo', $coverageGeo, $locale);
   }

   function getArticleCoverageChron() {
      return $this->getLocalizedData('coverageChron');
   }

   function getCoverageChron($locale) {
      return $this->getData('coverageChron', $locale);
   }

   function setCoverageChron($coverageChron, $locale) {
      return $this->setData('coverageChron', $coverageChron, $locale);
   }

   function getArticleCoverageSample() {
      return $this->getLocalizedData('coverageSample');
   }

   function getCoverageSample($locale) {
      return $this->getData('coverageSample', $locale);
   }

   function setCoverageSample($coverageSample, $locale) {
      return $this->setData('coverageSample', $coverageSample, $locale);
   }

   function getArticleType() {
      return $this->getLocalizedData('type');
   }

   function getType($locale) {
      return $this->getData('type', $locale);
   }

   function setType($type, $locale) {
      return $this->setData('type', $type, $locale);
   }

   function getLanguage() {
      return $this->getData('language');
   }

   function setLanguage($language) {
      return $this->setData('language', $language);
   }

   function getArticleSponsor() {
      return $this->getLocalizedData('sponsor');
   }

   function getSponsor($locale) {
      return $this->getData('sponsor', $locale);
   }

   function setSponsor($sponsor, $locale) {
      return $this->setData('sponsor', $sponsor, $locale);
   }

   function getArticleFileName() {
      return $this->getLocalizedData('fileName');
   }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

   function getHideCoverPageToc($locale) {
      return $this->getData('hideCoverPageToc', $locale);
   }

   function setHideCoverPageToc($hideCoverPageToc, $locale) {
      return $this->setData('hideCoverPageToc', $hideCoverPageToc, $locale);
   }

   function getHideCoverPageAbstract($locale) {
      return $this->getData('hideCoverPageAbstract', $locale);
   }

   function setHideCoverPageAbstract($hideCoverPageAbstract, $locale) {
      return $this->setData('hideCoverPageAbstract', $hideCoverPageAbstract, $locale);
   }

   function getCommentsToEditor() {
      return $this->getData('commentsToEditor');
   }

   function setCommentsToEditor($commentsToEditor) {
      return $this->setData('commentsToEditor', $commentsToEditor);
   }

   function getDateSubmitted() {
      return $this->getData('dateSubmitted');
   }

   function setDateSubmitted($dateSubmitted) {
      return $this->setData('dateSubmitted', $dateSubmitted);
   }

   function getDateStatusModified() {
      return $this->getData('dateStatusModified');
   }

   function setDateStatusModified($dateModified) {
      return $this->setData('dateStatusModified', $dateModified);
   }

   function getLastModified() {
      return $this->getData('lastModified');
   }

   function setLastModified($dateModified) {
      return $this->setData('lastModified', $dateModified);
   }

   function stampModified() {
      return $this->setLastModified(Core::getCurrentDate());
   }

   function stampStatusModified() {
      return $this->setDateStatusModified(Core::getCurrentDate());
   }

   function getStatus() {
      return $this->getData('status');
   }

   function setStatus($status) {
      return $this->setData('status', $status);
   }

   function getSubmissionProgress() {
      return $this->getData('submissionProgress');
   }

   function getCurrentRound() {
      return $this->getData('currentRound');
   }

   function setCurrentRound($currentRound) {
      return $this->setData('currentRound', $currentRound);
   }

   function setSubmissionProgress($submissionProgress) {
      return $this->setData('submissionProgress', $submissionProgress);
   }

   function getSubmissionFileId() {
      return $this->getData('submissionFileId');
   }

   function setSubmissionFileId($submissionFileId) {
      return $this->setData('submissionFileId', $submissionFileId);
   }

   function getRevisedFileId() {
      return $this->getData('revisedFileId');
   }

   function setRevisedFileId($revisedFileId) {
      return $this->setData('revisedFileId', $revisedFileId);
   }

   function getReviewFileId() {
      return $this->getData('reviewFileId');
   }

   function setReviewFileId($reviewFileId) {
      return $this->setData('reviewFileId', $reviewFileId);
   }

   function getEditorFileId() {
      return $this->getData('editorFileId');
   }

   function setEditorFileId($editorFileId) {
      return $this->setData('editorFileId', $editorFileId);
   }

   function getCopyeditFileId() {
      return $this->getData('copyeditFileId');
   }

   function setCopyeditFileId($copyeditFileId) {
      return $this->setData('copyeditFileId', $copyeditFileId);
   }

   function getPages() {
      return $this->getData('pages');
   }

   function setPages($pages) {
      return $this->setData('pages',$pages);
   }     

   function getFastTracked() {
      return $this->getData('fastTracked');
   }
    
   function setFastTracked($fastTracked) {
      return $this->setData('fastTracked',$fastTracked);
   }  

   function getHideAuthor() {
      return $this->getData('hideAuthor');
   }

   function setHideAuthor($hideAuthor) {
      return $this->setData('hideAuthor', $hideAuthor);
   }

   function getCommentsStatus() {
      return $this->getData('commentsStatus');
   }

   function setCommentsStatus($commentsStatus) {
      return $this->setData('commentsStatus', $commentsStatus);
   }

   function getCommentsStatusString() {
      switch ($this->getCommentsStatus()) {
         case COMMENTS_DISABLE:
            return 'article.comments.disable';
         case COMMENTS_ENABLE:
            return 'article.comments.enable';
         default:
            return 'article.comments.sectionDefault';
      }
   }

   function getEnableComments() {
      switch ($this->getCommentsStatus()) {
         case COMMENTS_DISABLE:
            return false;
         case COMMENTS_ENABLE:
            return true;
         case COMMENTS_SECTION_DEFAULT:
            $sectionDao =& DAORegistry::getDAO('SectionDAO');
            $section =& $sectionDao->getSection($this->getSectionId(), $this->getJournalId());
            if ($section->getDisableComments()) {
               return false;
            } else {
               return true;
            }
      }
   }

   function &getCommentsStatusOptions() {
      static $commentsStatusOptions = array(
         COMMENTS_SECTION_DEFAULT => 'article.comments.sectionDefault',
         COMMENTS_DISABLE => 'article.comments.disable',
         COMMENTS_ENABLE => 'article.comments.enable'
      );
      return $commentsStatusOptions;
   }
}

?>

---