ReviewFormDAO.inc.php

<?php
 
import('lib.pkp.classes.reviewForm.ReviewForm');
 
class ReviewFormDAO extends DAO {
 
   function getById($reviewFormId, $assocType = null, $assocId = null) {
      $params = array((int) $reviewFormId);
      if ($assocType) {
         $params[] = (int) $assocType;
         $params[] = (int) $assocId;
      }
 
      $result = $this->retrieve (
         'SELECT  rf.*,
            SUM(CASE WHEN ra.date_completed IS NOT NULL THEN 1 ELSE 0 END) AS complete_count,
            SUM(CASE WHEN ra.review_id IS NOT NULL AND ra.date_completed IS NULL THEN 1 ELSE 0 END) AS incomplete_count
         FROM  review_forms rf
            LEFT JOIN review_assignments ra ON (ra.review_form_id = rf.review_form_id AND ra.declined<>1)
         WHERE rf.review_form_id = ? AND rf.assoc_type = ? AND rf.assoc_id = ?
         GROUP BY rf.review_form_id',
         $params
      );
 
      $returner = null;
      if ($result->RecordCount() != 0) {
         $returner = $this->_fromRow($result->GetRowAssoc(false));
      }
 
      $result->Close();
      return $returner;
   }
 
   function newDataObject() {
      return new ReviewForm();
   }
 
   function _fromRow($row) {
      $reviewForm = $this->newDataObject();
      $reviewForm->setId($row['review_form_id']);
      $reviewForm->setAssocType($row['assoc_type']);
      $reviewForm->setAssocId($row['assoc_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::_fromRow', array(&$reviewForm, &$row));
 
      return $reviewForm;
   }
 
   function reviewFormExists($reviewFormId, $assocType, $assocId) {
      $result = $this->retrieve(
         'SELECT COUNT(*) FROM review_forms WHERE review_form_id = ? AND assoc_type = ? AND assoc_id = ?',
         array((int) $reviewFormId, (int) $assocType, (int) $assocId)
      );
      $returner = isset($result->fields[0]) && $result->fields[0] == 1 ? true : false;
 
      $result->Close();
      return $returner;
   }
 
   function getLocaleFieldNames() {
      return array('title', 'description');
   }
 
   function updateLocaleFields(&$reviewForm) {
      $this->updateDataObjectSettings('review_form_settings', $reviewForm, array(
         'review_form_id' => $reviewForm->getId()
      ));
   }
 
   function insertObject($reviewForm) {
      $this->update(
         'INSERT INTO review_forms
            (assoc_type, assoc_id, seq, is_active)
            VALUES
            (?, ?, ?, ?)',
         array(
            (int) $reviewForm->getAssocType(),
            (int) $reviewForm->getAssocId(),
            $reviewForm->getSequence() == null ? 0 : (float) $reviewForm->getSequence(),
            $reviewForm->getActive()?1:0
         )
      );
 
      $reviewForm->setId($this->getInsertId());
      $this->updateLocaleFields($reviewForm);
 
      return $reviewForm->getId();
   }
 
   function updateObject($reviewForm) {
      $returner = $this->update(
         'UPDATE review_forms
            SET
               assoc_type = ?,
               assoc_id = ?,
               seq = ?,
               is_active = ?
            WHERE review_form_id = ?',
         array(
            (int) $reviewForm->getAssocType(),
            (int) $reviewForm->getAssocId(),
            (float) $reviewForm->getSequence(),
            $reviewForm->getActive()?1:0,
            (int) $reviewForm->getId()
         )
      );
 
      $this->updateLocaleFields($reviewForm);
 
      return $returner;
   }
 
   function deleteObject($reviewForm) {
      return $this->deleteById($reviewForm->getId());
   }
 
   function deleteById($reviewFormId) {
      $reviewFormElementDao = DAORegistry::getDAO('ReviewFormElementDAO'); /* @var $reviewFormElementDao ReviewFormElementDAO */
      $reviewFormElementDao->deleteByReviewFormId($reviewFormId);
 
      $this->update('DELETE FROM review_form_settings WHERE review_form_id = ?', (int) $reviewFormId);
      $this->update('DELETE FROM review_forms WHERE review_form_id = ?', (int) $reviewFormId);
   }
 
   function deleteByAssoc($assocType, $assocId) {
      $reviewForms = $this->getByAssocId($assocType, $assocId);
 
      while ($reviewForm = $reviewForms->next()) {
         $this->deleteById($reviewForm->getId());
      }
   }
 
   function getByAssocId($assocType, $assocId, $rangeInfo = null) {
      $result = $this->retrieveRange(
         'SELECT rf.*,
            SUM(CASE WHEN ra.date_completed IS NOT NULL THEN 1 ELSE 0 END) AS complete_count,
            SUM(CASE WHEN ra.review_id IS NOT NULL AND ra.date_completed IS NULL THEN 1 ELSE 0 END) AS incomplete_count
         FROM  review_forms rf
            LEFT JOIN review_assignments ra ON (ra.review_form_id = rf.review_form_id AND ra.declined<>1)
         WHERE   rf.assoc_type = ? AND rf.assoc_id = ?
         GROUP BY rf.review_form_id
         ORDER BY rf.seq',
         array((int) $assocType, (int) $assocId), $rangeInfo
      );
 
      return new DAOResultFactory($result, $this, '_fromRow');
   }
 
   function getActiveByAssocId($assocType, $assocId, $rangeInfo = null) {
      $result = $this->retrieveRange(
         'SELECT  rf.*,
            SUM(CASE WHEN ra.date_completed IS NOT NULL THEN 1 ELSE 0 END) AS complete_count,
            SUM(CASE WHEN ra.review_id IS NOT NULL AND ra.date_completed IS NULL THEN 1 ELSE 0 END) AS incomplete_count
         FROM  review_forms rf
            LEFT JOIN review_assignments ra ON (ra.review_form_id = rf.review_form_id AND ra.declined<>1)
         WHERE rf.assoc_type = ? AND rf.assoc_id = ? AND rf.is_active = 1
         GROUP BY rf.review_form_id
         ORDER BY rf.seq',
         array((int) $assocType, (int) $assocId), $rangeInfo
      );
 
      return new DAOResultFactory($result, $this, '_fromRow');
   }
 
   function unusedReviewFormExists($reviewFormId, $assocType = null, $assocId = null) {
      $reviewForm = $this->getById($reviewFormId, $assocType, $assocId);
      if (!$reviewForm) return false;
      if ($reviewForm->getCompleteCount()!=0 || $reviewForm->getIncompleteCount()!=0) return false;
      return true;
   }
 
   function resequenceReviewForms($assocType, $assocId) {
      $result = $this->retrieve(
         'SELECT review_form_id FROM review_forms WHERE assoc_type = ? AND assoc_id = ? ORDER BY seq',
         array((int) $assocType, (int) $assocId)
      );
 
      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();
   }
 
   function getInsertId() {
      return $this->_getInsertId('review_forms', 'review_form_id');
   }
}