classes/reviewForm/ReviewFormDAO.inc.php

<?php

import ('reviewForm.ReviewForm');

class ReviewFormDAO extends DAO {

   function ReviewFormDAO() {
      parent::DAO();
   }

   function &getReviewForm($reviewFormId, $journalId = null) {
      $params = array((int) $reviewFormId);
      if ($journalId !== null) $params[] = (int) $journalId;

      $result =& $this->retrieve (
         'SELECT  rf.review_form_id,
            rf.journal_id,
            rf.seq,
            rf.is_active,
            COUNT(rac.review_id) AS complete_count,
            COUNT(rai.review_id) AS incomplete_count
         FROM  review_forms rf
            LEFT JOIN review_assignments rac ON (
               rac.review_form_id = rf.review_form_id AND
               rac.date_confirmed IS NOT NULL
            )
            LEFT JOIN review_assignments rai ON (
               rai.review_form_id = rf.review_form_id AND
               rai.date_notified IS NOT NULL AND
               rai.date_confirmed IS NULL
            )
         WHERE rf.review_form_id = ?
            ' . ($journalId!==null?' AND rf.journal_id = ?':'') . '
         GROUP BY rf.journal_id, rf.review_form_id, rf.seq, rf.is_active',
         $params
      );

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

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

      return $returner;
   }

   function &_returnReviewFormFromRow(&$row) {
      $reviewForm =& new ReviewForm();
      $reviewForm->setReviewFormId($row['review_form_id']);
      $reviewForm->setJournalId($row['journal_id']);
      $reviewForm->setSequence($row['seq']);
      $reviewForm->setActive($row['is_active']);
      $reviewForm->setCompleteCount($row['complete_count']);
      $reviewForm->setIncompleteCount($row['incomplete_count']);

      $this->getDataObjectSettings('review_form_settings', 'review_form_id', $row['review_form_id'], $reviewForm);

      HookRegistry::call('ReviewFormDAO::_returnReviewFormFromRow', array(&$reviewForm, &$row));

      return $reviewForm;
   }

   function reviewFormExists($reviewFormId, $journalId) {
      $result = &$this->retrieve(
         'SELECT COUNT(*) FROM review_forms WHERE review_form_id = ? AND journal_id = ?',
         array($reviewFormId, $journalId)
      );
      $returner = isset($result->fields[0]) && $result->fields[0] == 1 ? true : false;

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

      return $returner;
   }

   function getLocaleFieldNames() {
      return array('title', 'description');
   }

   function updateLocaleFields(&$reviewForm) {
      $this->updateDataObjectSettings('review_form_settings', $reviewForm, array(
         'review_form_id' => $reviewForm->getReviewFormId()
      ));
   }

   function insertReviewForm(&$reviewForm) {
      $this->update(
         'INSERT INTO review_forms
            (journal_id, seq, is_active)
            VALUES
            (?, ?, ?)',
         array(
            $reviewForm->getJournalId(),
            $reviewForm->getSequence() == null ? 0 : $reviewForm->getSequence(),
            $reviewForm->getActive() ? 1 : 0
         )
      );

      $reviewForm->setReviewFormId($this->getInsertReviewFormId());
      $this->updateLocaleFields($reviewForm);

      return $reviewForm->getReviewFormId();
   }

   function updateReviewForm(&$reviewForm) {
      $returner = $this->update(
         'UPDATE review_forms
            SET
               journal_id = ?,
               seq = ?,
               is_active = ?
            WHERE review_form_id = ?',
         array(
            $reviewForm->getJournalId(),
            $reviewForm->getSequence(),
            $reviewForm->getActive(),
            $reviewForm->getReviewFormId()
         )
      );

      $this->updateLocaleFields($reviewForm);

      return $returner;
   }

   function deleteReviewForm(&$reviewForm) {
      return $this->deleteReviewFormById($reviewForm->getReviewFormId(), $reviewForm->getJournalId());
   }

   function deleteReviewFormById($reviewFormId, $journalId = null) {
      if (isset($journalId)) {
         $reviewForm =& $this->getReviewForm($reviewFormId, $journalId);
         if (!$reviewForm) return null;
         unset($reviewForm);
      }

      $reviewFormElementDao =& DAORegistry::getDAO('ReviewFormElementDAO');
      $reviewFormElementDao->deleteReviewFormElementsByReviewForm($reviewFormId);

      $this->update('DELETE FROM review_form_settings WHERE review_form_id = ?', array($reviewFormId));
      return $this->update('DELETE FROM review_forms WHERE review_form_id = ?', array($reviewFormId));
   }

   function deleteReviewFormsByJournalId($journalId) {
      $reviewForms = $this->getJournalReviewForms($journalId);

      while (!$reviewForms->eof()) {
         $reviewForm =& $reviewForms->next();
         $this->deleteReviewFormById($reviewForm->getReviewFormId());
      }
   }

   function &getJournalReviewForms($journalId) {
      $result =& $this->retrieveRange(
         'SELECT  rf.review_form_id,
            rf.journal_id,
            rf.seq,
            rf.is_active,
            COUNT(rac.review_id) AS complete_count,
            COUNT(rai.review_id) AS incomplete_count
         FROM  review_forms rf
            LEFT JOIN review_assignments rac ON (
               rac.review_form_id = rf.review_form_id AND
               rac.date_confirmed IS NOT NULL
            )
            LEFT JOIN review_assignments rai ON (
               rai.review_form_id = rf.review_form_id AND
               rai.date_notified IS NOT NULL AND
               rai.date_confirmed IS NULL
            )
         WHERE rf.journal_id = ?
         GROUP BY rf.journal_id, rf.review_form_id, rf.seq, rf.is_active
         ORDER BY rf.seq',
         $journalId
      );

      $returner =& new DAOResultFactory($result, $this, '_returnReviewFormFromRow');
      return $returner;
   }

   function &getJournalActiveReviewForms($journalId, $rangeInfo = null) {
      $result =& $this->retrieveRange(
         'SELECT  rf.review_form_id,
            rf.journal_id,
            rf.seq,
            rf.is_active,
            COUNT(rac.review_id) AS complete_count,
            COUNT(rai.review_id) AS incomplete_count
         FROM  review_forms rf
            LEFT JOIN review_assignments rac ON (
               rac.review_form_id = rf.review_form_id AND
               rac.date_confirmed IS NOT NULL
            )
            LEFT JOIN review_assignments rai ON (
               rai.review_form_id = rf.review_form_id AND
               rai.date_notified IS NOT NULL AND
               rai.date_confirmed IS NULL
            )
         WHERE rf.journal_id = ? AND
            rf.is_active = 1
         GROUP BY rf.journal_id, rf.review_form_id, rf.seq, rf.is_active
         ORDER BY rf.seq',
         $journalId, $rangeInfo
      );

      $returner =& new DAOResultFactory($result, $this, '_returnReviewFormFromRow');
      return $returner;
   }

   function &getJournalUsedReviewForms($journalId, $rangeInfo = null) {
      $result =& $this->retrieveRange(
         'SELECT  rf.review_form_id,
            rf.journal_id,
            rf.seq,
            rf.is_active,
            COUNT(rac.review_id) AS complete_count,
            COUNT(rai.review_id) AS incomplete_count
         FROM  review_forms rf
            LEFT JOIN review_assignments rac ON (
               rac.review_form_id = rf.review_form_id AND
               rac.date_confirmed IS NOT NULL
            )
            LEFT JOIN review_assignments rai ON (
               rai.review_form_id = rf.review_form_id AND
               rai.date_notified IS NOT NULL AND
               rai.date_confirmed IS NULL
            )
         WHERE rf.journal_id = ? AND
            rf.is_active = 1
         GROUP BY rf.journal_id, rf.review_form_id, rf.seq, rf.is_active
         HAVING COUNT(rac.review_id) > 0 OR COUNT(rai.review_id) > 0
         ORDER BY rf.seq',
         $journalId, $rangeInfo
      );

      $returner =& new DAOResultFactory($result, $this, '_returnReviewFormFromRow');
      return $returner;
   }

   function &getJournalUnusedReviewForms($journalId, $rangeInfo = null) {
      $result =& $this->retrieveRange(
         'SELECT  rf.review_form_id,
            rf.journal_id,
            rf.seq,
            rf.is_active,
            COUNT(rac.review_id) AS complete_count,
            COUNT(rai.review_id) AS incomplete_count
         FROM  review_forms rf
            LEFT JOIN review_assignments rac ON (
               rac.review_form_id = rf.review_form_id AND
               rac.date_confirmed IS NOT NULL
            )
            LEFT JOIN review_assignments rai ON (
               rai.review_form_id = rf.review_form_id AND
               rai.date_notified IS NOT NULL AND
               rai.date_confirmed IS NULL
            )
         WHERE rf.journal_id = ?
         GROUP BY rf.journal_id, rf.review_form_id, rf.seq, rf.is_active
         HAVING COUNT(rac.review_id) = 0 AND COUNT(rai.review_id) = 0
         ORDER BY rf.seq',
         $journalId, $rangeInfo
      );

      $returner =& new DAOResultFactory($result, $this, '_returnReviewFormFromRow');
      return $returner;
   }

   function &getJournalReviewFormTitles($journalId, $used) {
      $reviewFormTitles = array();

      if ($used) {
         $reviewForms =& $this->getJournalUsedReviewForms($journalId);
      } else {
         $reviewForms =& $this->getJournalUnusedReviewForms($journalId);
      }
      while (($reviewForm =& $reviewForms->next())) {
         $reviewFormTitles[$reviewForm->getReviewFormId()] = $reviewForm->getReviewFormTitle();
         unset($reviewForm);
      }

      return $reviewFormTitles;
   }

   function unusedReviewFormExists($reviewFormId, $journalId = null) {
      $params = array((int) $reviewFormId);
      if ($journalId !== null) $params[] = (int) $journalId;

      $result =& $this->retrieve (
         'SELECT  rf.review_form_id,
            COUNT(rac.review_id) AS complete_count,
            COUNT(rai.review_id) AS incomplete_count
         FROM  review_forms rf
            LEFT JOIN review_assignments rac ON (
               rac.review_form_id = rf.review_form_id AND
               rac.date_confirmed IS NOT NULL
            )
            LEFT JOIN review_assignments rai ON (
               rai.review_form_id = rf.review_form_id AND
               rai.date_notified IS NOT NULL AND
               rai.date_confirmed IS NULL
            )
         WHERE rf.review_form_id = ?
            ' . ($journalId!==null?' AND rf.journal_id = ?':'') . '
         GROUP BY rf.review_form_id
         HAVING COUNT(rac.review_id) = 0 AND COUNT(rai.review_id) = 0',
         $params
      );

      $returner = $result->RecordCount() != 0;

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

      return $returner;
   }

   function resequenceReviewForms($journalId) {
      $result =& $this->retrieve(
         'SELECT review_form_id FROM review_forms WHERE journal_id = ? ORDER BY seq',
         (int) $journalId
      );

      for ($i=1; !$result->EOF; $i++) {
         list($reviewFormId) = $result->fields;
         $this->update(
            'UPDATE review_forms SET seq = ? WHERE review_form_id = ?',
            array(
               $i,
               $reviewFormId
            )
         );

         $result->moveNext();
      }

      $result->close();
      unset($result);
   }

   function getInsertReviewFormId() {
      return $this->getInsertId('review_forms', 'review_form_id');
   }
}

?>

---