GenreDAO.inc.php

<?php
 
import('lib.pkp.classes.submission.Genre');
import('lib.pkp.classes.db.DAO');
 
class GenreDAO extends DAO {
 
   function getById($genreId, $contextId = null) {
      $params = array((int) $genreId);
      if ($contextId) $params[] = (int) $contextId;
 
      $result = $this->retrieve(
         'SELECT * FROM genres WHERE genre_id = ?' .
         ($contextId ? ' AND context_id = ?' : '') .
         ' ORDER BY seq',
         $params
      );
      $returner = null;
      if ($result->RecordCount() != 0) {
         $returner = $this->_fromRow($result->GetRowAssoc(false));
      }
      $result->Close();
      return $returner;
   }
 
   function getEnabledByContextId($contextId, $rangeInfo = null) {
      $params = array(1, (int) $contextId);
 
      $result = $this->retrieveRange(
         'SELECT * FROM genres
         WHERE enabled = ? AND context_id = ?
         ORDER BY seq',
         $params, $rangeInfo
      );
 
      return new DAOResultFactory($result, $this, '_fromRow', array('id'));
   }
 
   function getByDependenceAndContextId($dependentFilesOnly, $contextId, $rangeInfo = null) {
      $result = $this->retrieveRange(
         'SELECT * FROM genres
         WHERE enabled = ? AND context_id = ? AND dependent = ?
         ORDER BY seq',
         array(1, (int) $contextId, (int) $dependentFilesOnly),
         $rangeInfo
      );
 
      return new DAOResultFactory($result, $this, '_fromRow', array('id'));
   }
 
   public function getBySupplementaryAndContextId($supplementaryFilesOnly, $contextId, $rangeInfo = null) {
      $result = $this->retrieveRange(
         'SELECT * FROM genres
         WHERE enabled = ? AND context_id = ? AND supplementary = ?
         ORDER BY seq',
         array(1, (int) $contextId, (int) $supplementaryFilesOnly),
         $rangeInfo
      );
 
      return new DAOResultFactory($result, $this, '_fromRow', array('id'));
   }
 
   public function getPrimaryByContextId($contextId, $rangeInfo = null) {
      $result = $this->retrieveRange(
         'SELECT * FROM genres
         WHERE enabled = ? AND context_id = ? AND dependent = ? AND supplementary = ?
         ORDER BY seq',
         array(1, (int) $contextId, 0, 0),
         $rangeInfo
      );
 
      return new DAOResultFactory($result, $this, '_fromRow', array('id'));
   }
 
   function getByContextId($contextId, $rangeInfo = null) {
      $result = $this->retrieveRange(
         'SELECT * FROM genres WHERE context_id = ? ORDER BY seq',
         array((int) $contextId),
         $rangeInfo
      );
 
      return new DAOResultFactory($result, $this, '_fromRow', array('id'));
   }
 
   function getByKey($key, $contextId = null) {
      $params = array($key);
      if ($contextId) $params[] = (int) $contextId;
 
      $sql = 'SELECT * FROM genres WHERE entry_key = ? ' .
      ($contextId ? ' AND context_id = ?' : '');
 
      $result = $this->retrieve($sql, $params);
 
      $returner = null;
      if ($result->RecordCount() != 0) {
         $returner = $this->_fromRow($result->GetRowAssoc(false));
      }
      $result->Close();
      return $returner;
   }
 
   function getLocaleFieldNames() {
      return array('name');
   }
 
   function updateLocaleFields($genre) {
      $this->updateDataObjectSettings(
         'genre_settings', $genre,
         array('genre_id' => $genre->getId())
      );
   }
 
   function newDataObject() {
      return new Genre();
   }
 
   function _fromRow($row) {
      $genre = $this->newDataObject();
      $genre->setId($row['genre_id']);
      $genre->setKey($row['entry_key']);
      $genre->setContextId($row['context_id']);
      $genre->setCategory($row['category']);
      $genre->setDependent($row['dependent']);
      $genre->setSupplementary($row['supplementary']);
      $genre->setSequence($row['seq']);
      $genre->setEnabled($row['enabled']);
 
      $this->getDataObjectSettings('genre_settings', 'genre_id', $row['genre_id'], $genre);
 
      HookRegistry::call('GenreDAO::_fromRow', array(&$genre, &$row));
 
      return $genre;
   }
 
   function insertObject($genre) {
      $this->update(
         'INSERT INTO genres
            (entry_key, seq, context_id, category, dependent, supplementary)
         VALUES
            (?, ?, ?, ?, ?, ?)',
         array(
            $genre->getKey(),
            (float) $genre->getSequence(),
            (int) $genre->getContextId(),
            (int) $genre->getCategory(),
            $genre->getDependent() ? 1 : 0,
            $genre->getSupplementary() ? 1 : 0,
         )
      );
 
      $genre->setId($this->getInsertId());
      $this->updateLocaleFields($genre);
      return $genre->getId();
   }
 
   function updateObject($genre) {
      $this->update(
         'UPDATE genres
         SET   entry_key = ?,
            seq = ?,
            dependent = ?,
            supplementary = ?,
            enabled = ?,
            category = ?
         WHERE genre_id = ?',
         array(
            $genre->getKey(),
            (float) $genre->getSequence(),
            $genre->getDependent() ? 1 : 0,
            $genre->getSupplementary() ? 1 : 0,
            $genre->getEnabled() ? 1 : 0,
            $genre->getCategory(),
            (int) $genre->getId(),
         )
      );
      $this->updateLocaleFields($genre);
   }
 
   function deleteObject($genre) {
      return $this->deleteById($genre->getId());
   }
 
   function deleteById($genreId) {
      return $this->update(
         'UPDATE genres SET enabled = ? WHERE genre_id = ?',
         array(0, (int) $genreId)
      );
   }
 
   function deleteByContextId($contextId) {
      $genres = $this->getByContextId($contextId);
      while ($genre = $genres->next()) {
         $this->update('DELETE FROM genre_settings WHERE genre_id = ?', (int) $genre->getId());
      }
      $this->update(
         'DELETE FROM genres WHERE context_id = ?', (int) $contextId
      );
   }
 
   function getInsertId() {
      return $this->_getInsertId('genres', 'genre_id');
   }
 
   function installDefaults($contextId, $locales) {
      // Load all the necessary locales.
      foreach ($locales as $locale) AppLocale::requireComponents(LOCALE_COMPONENT_APP_DEFAULT, LOCALE_COMPONENT_PKP_DEFAULT, $locale);
 
      $xmlDao = new XMLDAO();
      $data = $xmlDao->parseStruct('registry/genres.xml', array('genre'));
      if (!isset($data['genre'])) return false;
      $seq = 0;
 
      foreach ($data['genre'] as $entry) {
         $attrs = $entry['attributes'];
         // attempt to retrieve an installed Genre with this key.
         // Do this to preserve the genreId.
         $genre = $this->getByKey($attrs['key'], $contextId);
         if (!$genre) $genre = $this->newDataObject();
         $genre->setContextId($contextId);
         $genre->setKey($attrs['key']);
         $genre->setCategory($attrs['category']);
         $genre->setDependent($attrs['dependent']);
         $genre->setSupplementary($attrs['supplementary']);
         $genre->setSequence($seq++);
         foreach ($locales as $locale) {
            $genre->setName(__($attrs['localeKey'], array(), $locale), $locale);
         }
 
         if ($genre->getId() > 0) { // existing genre.
            $genre->setEnabled(1);
            $this->updateObject($genre);
         } else {
            $this->insertObject($genre);
         }
      }
   }
 
   function getDefaultKeys() {
      $defaultKeys = array();
      $xmlDao = new XMLDAO();
      $data = $xmlDao->parseStruct('registry/genres.xml', array('genre'));
      if (isset($data['genre'])) foreach ($data['genre'] as $entry) {
         $attrs = $entry['attributes'];
         $defaultKeys[] = $attrs['key'];
      }
      return $defaultKeys;
   }
 
   function keyExists($key, $contextId, $genreId = null) {
      $params = array($key, (int) $contextId);
      if ($genreId) $params[] = (int) $genreId;
      $result = $this->retrieveRange(
         'SELECT COUNT(*) FROM genres WHERE entry_key = ? AND context_id = ?' . (isset($genreId) ? ' AND genre_id <> ?' : ''),
         $params
      );
      $returner = isset($result->fields[0]) && $result->fields[0] == 1 ? true : false;
      $result->Close();
      return $returner;
   }
 
   function deleteSettingsByLocale($locale) {
      $this->update('DELETE FROM genre_settings WHERE locale = ?', $locale);
   }
}