classes/paper/Paper.inc.php

Go to the documentation of this file.

<?php

// $Id$


// Submission status constants
define('STATUS_ARCHIVED', 0);
define('STATUS_QUEUED', 1);
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);

define ('REVIEW_STAGE_ABSTRACT', 1);
define ('REVIEW_STAGE_PRESENTATION', 2);

/* These constants are used as search fields for the various submission lists */
define('SUBMISSION_FIELD_AUTHOR', 1);
define('SUBMISSION_FIELD_DIRECTOR', 2);
define('SUBMISSION_FIELD_TITLE', 3);
define('SUBMISSION_FIELD_REVIEWER', 4);

define('SUBMISSION_FIELD_DATE_SUBMITTED', 5);

// Paper RT comments
define ('COMMENTS_TRACK_DEFAULT', 0);
define ('COMMENTS_DISABLE', 1);
define ('COMMENTS_ENABLE', 2);

import('submission.Submission');

class Paper extends Submission {
   function Paper() {
      parent::Submission();
   }

   function addAuthor($author) {
      if ($author->getPaperId() == null) {
         $author->setPaperId($this->getId());
      }
      parent::addAuthor($author);
   }

   function getPaperTitle() {
      if (Config::getVar('debug', 'deprecation_warnings')) trigger_error('Deprecated function.');
      return $this->getLocalizedTitle();
   }

   function getPaperAbstract() {
      if (Config::getVar('debug', 'deprecation_warnings')) trigger_error('Deprecated function.');
      return $this->getLocalizedAbstract();
   }

   //
   // Get/set methods
   //

   function getPaperId() {
      if (Config::getVar('debug', 'deprecation_warnings')) trigger_error('Deprecated function.');
      return $this->getId();
   }

   function setPaperId($paperId) {
      if (Config::getVar('debug', 'deprecation_warnings')) trigger_error('Deprecated function.');
      return $this->setId($paperId);
   }

   function getSchedConfId() {
      return $this->getData('schedConfId');
   }

   function setSchedConfId($schedConfId) {
      return $this->setData('schedConfId', $schedConfId);
   }

   function getTrackId() {
      return $this->getData('trackId');
   }

   function setTrackId($trackId) {
      return $this->setData('trackId', $trackId);
   }

   function getTrackTitle() {
      return $this->getData('trackTitle');
   }

   function setTrackTitle($trackTitle) {
      return $this->setData('trackTitle', $trackTitle);
   }

   function getTrackAbbrev() {
      return $this->getData('trackAbbrev');
   }

   function setTrackAbbrev($trackAbbrev) {
      return $this->setData('trackAbbrev', $trackAbbrev);
   }

   function getPaperDiscipline() {
      if (Config::getVar('debug', 'deprecation_warnings')) trigger_error('Deprecated function.');
      return $this->getLocalizedDiscipline();
   }

   function getPaperSubjectClass() {
      if (Config::getVar('debug', 'deprecation_warnings')) trigger_error('Deprecated function.');
      return $this->getLocalizedSubjectClass();
   }

   function getPaperSubject() {
      if (Config::getVar('debug', 'deprecation_warnings')) trigger_error('Deprecated function.');
      return $this->getLocalizedSubject();
   }

   function getPaperCoverageGeo() {
      if (Config::getVar('debug', 'deprecation_warnings')) trigger_error('Deprecated function.');
      return $this->getLocalizedCoverageGeo();
   }

   function getPaperCoverageChron() {
      if (Config::getVar('debug', 'deprecation_warnings')) trigger_error('Deprecated function.');
      return $this->getLocalizedCoverageChron();
   }

   function getPaperCoverageSample() {
      if (Config::getVar('debug', 'deprecation_warnings')) trigger_error('Deprecated function.');
      return $this->getLocalizedCoverageSample();
   }

   function getPaperType() {
      if (Config::getVar('debug', 'deprecation_warnings')) trigger_error('Deprecated function.');
      return $this->getLocalizedType();
   }

   function getPaperSponsor() {
      if (Config::getVar('debug', 'deprecation_warnings')) trigger_error('Deprecated function.');
      return $this->getLocalizedSponsor();
   }

   function getCommentsToDirector() {
      return $this->getData('commentsToDirector');
   }

   function setCommentsToDirector($commentsToDirector) {
      return $this->setData('commentsToDirector', $commentsToDirector);
   }

   function getDateToPresentations() {
      return $this->getData('dateToPresentations');
   }

   function setDateToPresentations($dateToPresentations) {
      return $this->setData('dateToPresentations', $dateToPresentations);
   }

   function getDateToArchive() {
      return $this->getData('dateToArchive');
   }

   function setDateToArchive($dateToArchive) {
      return $this->setData('dateToArchive', $dateToArchive);
   }

   function stampDateToArchive() {
      return $this->setDateToArchive(Core::getCurrentDate());
   }

   function stampDateToPresentations() {
      return $this->setDateToPresentations(Core::getCurrentDate());
   }

   function getDateReminded() {
      return $this->getData('dateReminded');
   }

   function setDateReminded($dateReminded) {
      return $this->setData('dateReminded', $dateReminded);
   }

   function getStartTime() {
      return $this->getData('startTime');
   }

   function setStartTime($startTime) {
      return $this->setData('startTime', $startTime);
   }

   function getEndTime() {
      return $this->getData('endTime');
   }

   function setEndTime($endTime) {
      return $this->setData('endTime', $endTime);
   }

   function getCurrentStage() {
      return $this->getData('currentStage');
   }

   function setCurrentStage($currentStage) {
      return $this->setData('currentStage', $currentStage);
   }

   function getReviewMode() {
      return $this->getData('reviewMode');
   }

   function setReviewMode($reviewMode) {
      return $this->setData('reviewMode', $reviewMode);
   }

   function getLayoutFileId() {
      return $this->getData('layoutFileId');
   }

   function setLayoutFileId($layoutFileId) {
      return $this->setData('layoutFileId', $layoutFileId);
   }

   function getDirectorFileId() {
      return $this->getData('directorFileId');
   }

   function setDirectorFileId($directorFileId) {
      return $this->setData('directorFileId', $directorFileId);
   }

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

   function getEnableComments() {
      switch ($this->getCommentsStatus()) {
         case COMMENTS_DISABLE:
            return false;
         case COMMENTS_ENABLE:
            return true;
         case COMMENTS_TRACK_DEFAULT:
            $trackDao =& DAORegistry::getDAO('TrackDAO');
            $track =& $trackDao->getTrack($this->getTrackId(), $this->getSchedConfId());
            if ($track->getDisableComments()) {
               return false;
            } else {
               return true;
            }
      }
   }

   function &getCommentsStatusOptions() {
      static $commentsStatusOptions = array(
         COMMENTS_TRACK_DEFAULT => 'paper.comments.trackDefault',
         COMMENTS_DISABLE => 'paper.comments.disable',
         COMMENTS_ENABLE => 'paper.comments.enable'
      );
      return $commentsStatusOptions;
   }

   function getAssociatedUserIds($authors = true, $reviewers = true, $trackDirectors = true, $directors = true) {
      $paperId = $this->getId();

      $userIds = array();

      if($authors) {
         $userId = $this->getUserId();
         if ($userId) $userIds[] = array('id' => $userId, 'role' => 'author');
      }

      if($reviewers) {
         $reviewAssignmentDao =& DAORegistry::getDAO('ReviewAssignmentDAO');
         $reviewAssignments =& $reviewAssignmentDao->getReviewAssignmentsByPaperId($paperId);
         foreach ($reviewAssignments as $reviewAssignment) {
            $userId = $reviewAssignment->getReviewerId();
            if ($userId) $userIds[] = array('id' => $userId, 'role' => 'reviewer');
            unset($reviewAssignment);
         }
      }

      $editAssignmentDao =& DAORegistry::getDAO('EditAssignmentDAO');

      if($trackDirectors) {
         $editAssignments =& $editAssignmentDao->getTrackDirectorAssignmentsByPaperId($paperId);
         while ($editAssignment =& $editAssignments->next()) {
            $userId = $editAssignment->getDirectorId();
            if ($userId) $userIds[] = array('id' => $userId, 'role' => 'trackDirector');
            unset($editAssignment);
         }
      }

      if($directors) {
         $editAssignments =& $editAssignmentDao->getDirectorAssignmentsByPaperId($paperId);
         while ($editAssignment =& $editAssignments->next()) {
            $userId = $editAssignment->getDirectorId();
            if ($userId) $userIds[] = array('id' =>  $userId, 'role' => 'director');
         }
      }

      return $userIds;
   }
}

?>

---