ReviewRoundDAO.inc.php

<?php
 
import('lib.pkp.classes.submission.reviewRound.ReviewRound');
 
class ReviewRoundDAO extends DAO {
 
   //
   // Public methods
   //
   function build($submissionId, $stageId, $round, $status = null) {
      // If one exists, fetch and return.
      $reviewRound = $this->getReviewRound($submissionId, $stageId, $round);
      if ($reviewRound) return $reviewRound;
 
      // Otherwise, check the args to build one.
      if ($stageId == WORKFLOW_STAGE_ID_INTERNAL_REVIEW ||
         $stageId == WORKFLOW_STAGE_ID_EXTERNAL_REVIEW &&
         $round > 0
      ) {
         unset($reviewRound);
         $reviewRound = $this->newDataObject();
         $reviewRound->setSubmissionId($submissionId);
         $reviewRound->setRound($round);
         $reviewRound->setStageId($stageId);
         $reviewRound->setStatus($status);
         $this->insertObject($reviewRound);
         $reviewRound->setId($this->getInsertId());
 
         return $reviewRound;
      } else {
         assert(false);
         return null;
      }
   }
 
   function newDataObject() {
      return new ReviewRound();
   }
 
   function insertObject($reviewRound) {
      $this->update(
            'INSERT INTO review_rounds
            (submission_id, stage_id, round, status)
            VALUES
            (?, ?, ?, ?)',
            array(
               (int)$reviewRound->getSubmissionId(),
               (int)$reviewRound->getStageId(),
               (int)$reviewRound->getRound(),
               (int)$reviewRound->getStatus()
            )
      );
      return $reviewRound;
   }
 
   function updateObject($reviewRound) {
      $returner = $this->update(
         'UPDATE  review_rounds
         SET   status = ?
         WHERE submission_id = ? AND
            stage_id = ? AND
            round = ?',
         array(
            (int)$reviewRound->getStatus(),
            (int)$reviewRound->getSubmissionId(),
            (int)$reviewRound->getStageId(),
            (int)$reviewRound->getRound()
         )
      );
      return $returner;
   }
 
   function getReviewRound($submissionId, $stageId, $round) {
      $result = $this->retrieve(
         'SELECT * FROM review_rounds WHERE submission_id = ? AND stage_id = ? AND round = ?',
         array((int) $submissionId, (int) $stageId, (int) $round)
      );
 
      $returner = null;
      if ($result->RecordCount() != 0) {
         $returner = $this->_fromRow($result->GetRowAssoc(false));
      }
      $result->Close();
      return $returner;
   }
 
   function getById($reviewRoundId) {
      $result = $this->retrieve(
         'SELECT * FROM review_rounds WHERE review_round_id = ?',
         (int) $reviewRoundId
      );
 
      $returner = null;
      if ($result->RecordCount() != 0) {
         $returner = $this->_fromRow($result->GetRowAssoc(false));
      }
      $result->Close();
      return $returner;
   }
 
   function getBySubmissionFileId($submissionFileId) {
      $result = $this->retrieve(
            'SELECT * FROM review_rounds rr
            INNER JOIN review_round_files rrf
            ON rr.review_round_id = rrf.review_round_id
            WHERE rrf.file_id = ?',
            array((int) $submissionFileId));
 
      $returner = null;
      if ($result->RecordCount() != 0) {
         $returner = $this->_fromRow($result->GetRowAssoc(false));
      }
      $result->Close();
      return $returner;
   }
 
   function getBySubmissionId($submissionId, $stageId = null, $round = null) {
      $params = array($submissionId);
      if ($stageId) $params[] = $stageId;
      if ($round) $params[] = $round;
 
      $result = $this->retrieve(
         'SELECT * FROM review_rounds WHERE submission_id = ?' .
         ($stageId ? ' AND stage_id = ?' : '') .
         ($round ? ' AND round = ?' : '') .
         ' ORDER BY stage_id ASC, round ASC',
         $params
      );
 
      return new DAOResultFactory($result, $this, '_fromRow');
   }
 
   function getCurrentRoundBySubmissionId($submissionId, $stageId = null) {
      $params = array((int)$submissionId);
      if ($stageId) $params[] = (int) $stageId;
      $result = $this->retrieve(
         'SELECT MAX(stage_id) as stage_id, MAX(round) as round
         FROM review_rounds
         WHERE submission_id = ?' .
         ($stageId ? ' AND stage_id = ?' : ''),
         $params
      );
      $returner = isset($result->fields['round']) ? (int)$result->fields['round'] : 1;
      $result->Close();
      return $returner;
   }
 
   function getLastReviewRoundBySubmissionId($submissionId, $stageId = null) {
      $params = array((int)$submissionId);
      if ($stageId) $params[] = (int) $stageId;
      $result = $this->retrieveLimit(
         'SELECT  *
         FROM  review_rounds
         WHERE submission_id = ?
         ' . ($stageId ? ' AND stage_id = ?' : '') . '
         ORDER BY stage_id DESC, round DESC',
         $params,
         1
      );
 
      $returner = null;
      if ($result->RecordCount() != 0) {
         $returner = $this->_fromRow($result->GetRowAssoc(false));
      }
      $result->Close();
      return $returner;
   }
 
   function getInsertId() {
      return $this->_getInsertId('review_rounds', 'review_round_id');
   }
 
   function updateStatus($reviewRound, $status = null) {
      assert(is_a($reviewRound, 'ReviewRound'));
      $currentStatus = $reviewRound->getStatus();
 
      if (is_null($status)) {
         $status = $reviewRound->determineStatus();
      }
 
      // Avoid unnecessary database access.
      if ($status != $currentStatus) {
         $this->update('UPDATE review_rounds SET status = ? WHERE review_round_id = ?',
            array((int)$status, (int)$reviewRound->getId())
         );
         // Update the data in object too.
         $reviewRound->setStatus($status);
      }
   }
 
 
   function deleteBySubmissionId($submissionId) {
      $reviewRounds = $this->getBySubmissionId($submissionId);
      while ($reviewRound = $reviewRounds->next()) {
         $this->deleteObject($reviewRound);
      }
   }
 
   function deleteObject($reviewRound) {
      $this->deleteById($reviewRound->getId());
   }
 
   function deleteById($reviewRoundId) {
      $this->update('DELETE FROM notifications WHERE assoc_type = ? AND assoc_id = ?', array((int) ASSOC_TYPE_REVIEW_ROUND, (int) $reviewRoundId));
      return $this->update('DELETE FROM review_rounds WHERE review_round_id = ?', array((int) $reviewRoundId));
   }
 
   //
   // Private methods
   //
   function _fromRow($row) {
      $reviewRound = $this->newDataObject();
 
      $reviewRound->setId((int)$row['review_round_id']);
      $reviewRound->setSubmissionId((int)$row['submission_id']);
      $reviewRound->setStageId((int)$row['stage_id']);
      $reviewRound->setRound((int)$row['round']);
      $reviewRound->setStatus((int)$row['status']);
 
      return $reviewRound;
   }
}