ReviewFormElementDAO.inc.php

<?php
 
import ('lib.pkp.classes.reviewForm.ReviewFormElement');
 
class ReviewFormElementDAO extends DAO {
 
   function getById($reviewFormElementId, $reviewFormId = null) {
      $params = array((int) $reviewFormElementId);
      if ($reviewFormId) {
         $params[] = (int) $reviewFormId;
      }
      $result = $this->retrieve(
         'SELECT  *
         FROM  review_form_elements
         WHERE review_form_element_id = ?
         ' . ($reviewFormId?' AND review_form_id = ?':''),
         $params
      );
 
      $returner = null;
      if ($result->RecordCount() != 0) {
         $returner = $this->_fromRow($result->GetRowAssoc(false));
      }
 
      $result->Close();
      return $returner;
   }
 
   function newDataObject() {
      return new ReviewFormElement();
   }
 
   function _fromRow($row) {
      $reviewFormElement = $this->newDataObject();
      $reviewFormElement->setId($row['review_form_element_id']);
      $reviewFormElement->setReviewFormId($row['review_form_id']);
      $reviewFormElement->setSequence($row['seq']);
      $reviewFormElement->setElementType($row['element_type']);
      $reviewFormElement->setRequired($row['required']);
      $reviewFormElement->setIncluded($row['included']);
 
      $this->getDataObjectSettings('review_form_element_settings', 'review_form_element_id', $row['review_form_element_id'], $reviewFormElement);
 
      HookRegistry::call('ReviewFormElementDAO::_fromRow', array(&$reviewFormElement, &$row));
 
      return $reviewFormElement;
   }
 
   function getLocaleFieldNames() {
      return array('question', 'description', 'possibleResponses');
   }
 
   function updateLocaleFields($reviewFormElement) {
      $this->updateDataObjectSettings('review_form_element_settings', $reviewFormElement, array(
         'review_form_element_id' => (int) $reviewFormElement->getId()
      ));
   }
 
   function insertObject($reviewFormElement) {
      $this->update(
         'INSERT INTO review_form_elements
            (review_form_id, seq, element_type, required, included)
         VALUES
            (?, ?, ?, ?, ?)',
         array(
            (int) $reviewFormElement->getReviewFormId(),
            $reviewFormElement->getSequence() == null ? 0 : (float) $reviewFormElement->getSequence(),
            (int) $reviewFormElement->getElementType(),
            (int) $reviewFormElement->getRequired(),
            (int) $reviewFormElement->getIncluded(),
         )
      );
 
      $reviewFormElement->setId($this->getInsertId());
      $this->updateLocaleFields($reviewFormElement);
      return $reviewFormElement->getId();
   }
 
   function updateObject($reviewFormElement) {
      $returner = $this->update(
         'UPDATE review_form_elements
            SET   review_form_id = ?,
               seq = ?,
               element_type = ?,
               required = ?,
               included = ?
            WHERE review_form_element_id = ?',
         array(
            (int) $reviewFormElement->getReviewFormId(),
            (float) $reviewFormElement->getSequence(),
            (int) $reviewFormElement->getElementType(),
            (int) $reviewFormElement->getRequired(),
            (int) $reviewFormElement->getIncluded(),
            (int) $reviewFormElement->getId()
         )
      );
      $this->updateLocaleFields($reviewFormElement);
      return $returner;
   }
 
   function deleteObject($reviewFormElement) {
      return $this->deleteById($reviewFormElement->getId());
   }
 
   function deleteById($reviewFormElementId) {
      $reviewFormResponseDao = DAORegistry::getDAO('ReviewFormResponseDAO'); /* @var $reviewFormResponseDao ReviewFormResponseDAO */
      $reviewFormResponseDao->deleteByReviewFormElementId($reviewFormElementId);
 
      $this->update('DELETE FROM review_form_element_settings WHERE review_form_element_id = ?', (int) $reviewFormElementId);
      return $this->update('DELETE FROM review_form_elements WHERE review_form_element_id = ?', (int) $reviewFormElementId);
   }
 
   function deleteByReviewFormId($reviewFormId) {
      $reviewFormElements = $this->getByReviewFormId($reviewFormId);
      while ($reviewFormElement = $reviewFormElements->next()) {
         $this->deleteById($reviewFormElement->getId());
      }
   }
 
   function deleteSetting($reviewFormElementId, $name, $locale = null) {
      $params = array((int) $reviewFormElementId, $name);
      if ($locale) $params[] = $locale;
 
      $this->update(
         'DELETE FROM review_form_element_settings
         WHERE review_form_element_id = ? AND setting_name = ?
         ' . ($locale?' AND locale = ?':''),
         $params
      );
   }
 
   function getByReviewFormId($reviewFormId, $rangeInfo = null, $included = null) {
      $result = $this->retrieveRange(
         'SELECT * 
         FROM review_form_elements 
         WHERE review_form_id = ?
         ' . ($included === true?' AND included = 1':'') . '
         ' . ($included === false?' AND included = 0':'') . ' 
         ORDER BY seq',
         (int) $reviewFormId, $rangeInfo
      );
 
      return new DAOResultFactory($result, $this, '_fromRow');
   }
 
   function getRequiredReviewFormElementIds($reviewFormId) {
      $result = $this->retrieve(
         'SELECT review_form_element_id FROM review_form_elements WHERE review_form_id = ? AND required = 1 ORDER BY seq',
         $reviewFormId
      );
 
      $requiredReviewFormElementIds = array();
      while (!$result->EOF) {
         $requiredReviewFormElementIds[] = $result->fields[0];
         $result->MoveNext();
      }
 
      $result->Close();
      return $requiredReviewFormElementIds;
   }
 
   function reviewFormElementExists($reviewFormElementId, $reviewFormId = null) {
      $params = array((int) $reviewFormElementId);
      if ($reviewFormId) $params[] = (int) $reviewFormId;
 
      $result = $this->retrieve(
         'SELECT  COUNT(*)
         FROM  review_form_elements
         WHERE review_form_element_id = ?
            ' . ($reviewFormId?' AND review_form_id = ?':''),
         $params
      );
 
      $returner = isset($result->fields[0]) && $result->fields[0] == 1 ? true : false;
 
      $result->Close();
      return $returner;
   }
 
   function resequenceReviewFormElements($reviewFormId) {
      $result = $this->retrieve(
         'SELECT review_form_element_id FROM review_form_elements WHERE review_form_id = ? ORDER BY seq',
         (int) $reviewFormId
      );
 
      for ($i=1; !$result->EOF; $i++) {
         list($reviewFormElementId) = $result->fields;
         $this->update(
            'UPDATE review_form_elements SET seq = ? WHERE review_form_element_id = ?',
            array(
               $i,
               $reviewFormElementId
            )
         );
 
         $result->MoveNext();
      }
      $result->Close();
   }
 
   function getInsertId() {
      return $this->_getInsertId('review_form_elements', 'review_form_element_id');
   }
}