classes/submission/reviewAssignment/ReviewAssignmentDAO.inc.php

<?php

import('classes.submission.reviewAssignment.ReviewAssignment');
import('lib.pkp.classes.submission.reviewAssignment.PKPReviewAssignmentDAO');

class ReviewAssignmentDAO extends PKPReviewAssignmentDAO {
   var $submissionFileDao;
   var $monographCommentsDao;

   function ReviewAssignmentDAO() {
      parent::PKPReviewAssignmentDAO();
      $this->submissionFileDao =& DAORegistry::getDAO('SubmissionFileDAO');
      $this->monographCommentDao =& DAORegistry::getDAO('MonographCommentDAO');
   }

   function &getLastReviewRoundReviewAssignmentByReviewer($monographId, $reviewerId) {
      $params = array(
         (int) $monographId,
         (int) $reviewerId
      );

      $result =& $this->retrieve(
         $this->_getSelectQuery() .
         ' WHERE  r.submission_id = ? AND
            r.reviewer_id = ? AND
            r.cancelled <> 1
         ORDER BY r2.stage_id DESC, r2.round DESC LIMIT 1',
         $params
      );

      $returner = null;
      if ($result->RecordCount() != 0) {
         $returner =& $this->_fromRow($result->GetRowAssoc(false));
      }

      $result->Close();
      unset($result);

      return $returner;
   }

   function getInsertReviewId() {
      return $this->getInsertId('review_assignments', 'review_id');
   }

   function getAverageQualityRatings($pressId) {
      $averageQualityRatings = array();
      $result =& $this->retrieve(
         'SELECT  r.reviewer_id, AVG(r.quality) AS average, COUNT(r.quality) AS count
         FROM  review_assignments r, monographs a
         WHERE r.submission_id = a.monograph_id AND
            a.press_id = ?
         GROUP BY r.reviewer_id',
         (int) $pressId
         );

      while (!$result->EOF) {
         $row = $result->GetRowAssoc(false);
         $averageQualityRatings[$row['reviewer_id']] = array('average' => $row['average'], 'count' => $row['count']);
         $result->MoveNext();
      }

      $result->Close();
      unset($result);

      return $averageQualityRatings;
   }

   function newDataObject() {
      return new ReviewAssignment();
   }


   function &_fromRow(&$row) {
      $reviewAssignment =& parent::_fromRow($row);

      // Comments
      $reviewAssignment->setMostRecentPeerReviewComment($this->monographCommentDao->getMostRecentMonographComment($row['submission_id'], COMMENT_TYPE_PEER_REVIEW, $row['review_id']));

      HookRegistry::call('ReviewAssignmentDAO::_fromRow', array(&$reviewAssignment, &$row));
      return $reviewAssignment;
   }

   function getReviewMethodsTranslationKeys() {
      return array(
         SUBMISSION_REVIEW_METHOD_DOUBLEBLIND => 'editor.submissionReview.doubleBlind',
         SUBMISSION_REVIEW_METHOD_BLIND => 'editor.submissionReview.blind',
         SUBMISSION_REVIEW_METHOD_OPEN => 'editor.submissionReview.open',
      );
   }

   function getReviewRoundJoin() {
      return 'r.review_round_id = r2.review_round_id';
   }

   //
   // Add class to temporarily consolidate PKPReviewAssignmentDAO and ReviewAssignmentDAO
   //
   function updateObject(&$reviewAssignment) {
      parent::updateReviewAssignment($reviewAssignment);
   }


   //
   // Override methods from PKPSubmissionFileDAO
   // FIXME *6902* Move this code to PKPReviewAssignmentDAO after the review round
   // refactoring is ported to other applications.
   function &getReviewAssignment($reviewRoundId, $reviewerId) {
      $params = array(
      (int) $reviewRoundId,
      (int) $reviewerId
      );

      $result =& $this->retrieve(
         $this->_getSelectQuery() .
         ' WHERE  r.review_round_id = ? AND
            r.reviewer_id = ? AND
            r.cancelled <> 1',
         $params
      );

      $returner = null;
      if ($result->RecordCount() != 0) {
         $returner =& $this->_fromRow($result->GetRowAssoc(false));
      }

      $result->Close();
      unset($result);

      return $returner;
   }

   function &getByReviewRoundId($reviewRoundId, $excludeCancelled = false) {
      $params = array((int)$reviewRoundId);

      $query = $this->_getSelectQuery() .
         ' WHERE r.review_round_id = ?';

      if ($excludeCancelled) {
         $query .= ' AND (r.cancelled = 0 OR r.cancelled IS NULL)';
      }

      $query .= ' ORDER BY review_id';

      return $this->_getReviewAssignmentsArray($query, $params);
   }

   function &getBySubmissionId($submissionId, $reviewRoundId = null, $stageId = null) {
      $query = $this->_getSelectQuery() .
         ' WHERE  r.submission_id = ?';

      $orderBy = ' ORDER BY review_id';

      $queryParams[] = (int) $submissionId;

      if ($reviewRoundId != null) {
         $query .= ' AND r2.review_round_id = ?';
         $queryParams[] = (int) $reviewRoundId;
      } else {
         $orderBy .= ', r2.review_round_id';
      }

      if ($stageId != null) {
         $query .= ' AND r2.stage_id = ?';
         $queryParams[] = (int) $stageId;
      } else {
         $orderBy .= ', r2.stage_id';
      }

      $query .= $orderBy;

      return $this->_getReviewAssignmentsArray($query, $queryParams);
   }

   function &getReviewerIdsBySubmissionId($submissionId, $stageId = null, $reviewRoundId = null) {
      $query = 'SELECT r.reviewer_id
         FROM  review_assignments r
         WHERE r.submission_id = ?';

      $queryParams[] = (int) $submissionId;

      if ($reviewRoundId != null) {
         $query .= ' AND r.review_round_id = ?';
         $queryParams[] = (int) $reviewRoundId;
      }

      if ($stageId != null) {
         $query .= ' AND r.stage_id = ?';
         $queryParams[] = (int) $stageId;
      }

      $result =& $this->retrieve($query, $queryParams);

      $reviewAssignments = array();
      while (!$result->EOF) {
         $row = $result->GetRowAssoc(false);
         $reviewAssignments[] = $row['reviewer_id'];
         $result->MoveNext();
      }

      $result->Close();
      unset($result);

      return $reviewAssignments;
   }

   function &getReviewIndexesForRound($submissionId, $reviewRoundId) {
      $result =& $this->retrieve(
         'SELECT  review_id
         FROM  review_assignments
         WHERE submission_id = ? AND
            review_round_id = ? AND
            (cancelled = 0 OR cancelled IS NULL)
         ORDER BY review_id',
         array((int) $submissionId, (int) $reviewRoundId)
      );

      $index = 0;
      $returner = array();
      while (!$result->EOF) {
         $row = $result->GetRowAssoc(false);
         $returner[$row['review_id']] = $index++;
         $result->MoveNext();
      }

      $result->Close();
      unset($result);

      return $returner;
   }

   function &getLastModifiedByRound($submissionId) {
      $returner = array();

      $result =& $this->retrieve(
         'SELECT  review_round_id, MAX(last_modified) as last_modified
         FROM  review_assignments
         WHERE submission_id = ?
         GROUP BY review_round_id',
         (int) $submissionId
      );

      while (!$result->EOF) {
         $row = $result->GetRowAssoc(false);
         $returner[$row['review_round_id']] = $this->datetimeFromDB($row['last_modified']);
         $result->MoveNext();
      }

      $result->Close();
      unset($result);

      return $returner;
   }

   function &getEarliestNotificationByRound($submissionId) {
      $returner = array();

      $result =& $this->retrieve(
         'SELECT  review_round_id, MIN(date_notified) as earliest_date
         FROM  review_assignments
         WHERE submission_id = ?
         GROUP BY review_round_id',
         (int) $submissionId
      );

      while (!$result->EOF) {
         $row = $result->GetRowAssoc(false);
         $returner[$row['review_round_id']] = $this->datetimeFromDB($row['earliest_date']);
         $result->MoveNext();
      }

      $result->Close();
      unset($result);

      return $returner;
   }

   function _getSelectQuery() {
      return 'SELECT r.*, r2.review_revision, u.first_name, u.last_name FROM review_assignments r
         LEFT JOIN users u ON (r.reviewer_id = u.user_id)
         LEFT JOIN review_rounds r2 ON (r.review_round_id = r2.review_round_id)';
   }

   function &_getReviewAssignmentsArray($query, $queryParams) {
      $reviewAssignments = array();

      $result =& $this->retrieve($query, $queryParams);

      while (!$result->EOF) {
         $reviewAssignments[$result->fields['review_id']] =& $this->_fromRow($result->GetRowAssoc(false));
         $result->MoveNext();
      }

      $result->Close();
      unset($result);

      return $reviewAssignments;
   }
}

?>