classes/rt/ojs/RTDAO.inc.php

<?php

// $Id: RTDAO.inc.php,v 1.38 2008/07/01 01:16:10 asmecher Exp $


import('rt.ojs.JournalRT');

class RTDAO extends DAO {
   //
   // RT
   //

   function &getJournalRTByJournal(&$journal) {
      $rt = &new JournalRT($journal->getJournalId());
      $rt->setEnabled($journal->getSetting('rtEnabled')?true:false);
      $rt->setVersion((int) $journal->getSetting('rtVersionId'));
      $rt->setAbstract($journal->getSetting('rtAbstract')?true:false);
      $rt->setCaptureCite($journal->getSetting('rtCaptureCite')?true:false);
      $rt->setViewMetadata($journal->getSetting('rtViewMetadata')?true:false);
      $rt->setSupplementaryFiles($journal->getSetting('rtSupplementaryFiles')?true:false);
      $rt->setPrinterFriendly($journal->getSetting('rtPrinterFriendly')?true:false);
      $rt->setAuthorBio($journal->getSetting('rtAuthorBio')?true:false);
      $rt->setDefineTerms($journal->getSetting('rtDefineTerms')?true:false);
      $rt->setEmailAuthor($journal->getSetting('rtEmailAuthor')?true:false);
      $rt->setEmailOthers($journal->getSetting('rtEmailOthers')?true:false);
      $rt->setFindingReferences($journal->getSetting('rtFindingReferences')?true:false);
      return $rt;
   }

   function updateJournalRT(&$rt) {
      $journalDao =& DAORegistry::getDAO('JournalDAO');
      $journal =& $journalDao->getJournal($rt->getJournalId());

      $journal->updateSetting('rtEnabled', $rt->getEnabled(), 'bool');
      $journal->updateSetting('rtVersionId', $rt->getVersion(), 'int');
      $journal->updateSetting('rtAbstract', $rt->getAbstract(), 'bool');
      $journal->updateSetting('rtCaptureCite', $rt->getCaptureCite(), 'bool');
      $journal->updateSetting('rtViewMetadata', $rt->getViewMetadata(), 'bool');
      $journal->updateSetting('rtSupplementaryFiles', $rt->getSupplementaryFiles(), 'bool');
      $journal->updateSetting('rtPrinterFriendly', $rt->getPrinterFriendly(), 'bool');
      $journal->updateSetting('rtAuthorBio', $rt->getAuthorBio(), 'bool');
      $journal->updateSetting('rtDefineTerms', $rt->getDefineTerms(), 'bool');
      $journal->updateSetting('rtEmailAuthor', $rt->getEmailAuthor(), 'bool');
      $journal->updateSetting('rtEmailOthers', $rt->getEmailOthers(), 'bool');
      $journal->updateSetting('rtFindingReferences', $rt->getFindingReferences());
      return true;
   }

   function insertJournalRT(&$rt) {
      return $this->updateJournalRT($rt);
   }

   //
   // RT Versions
   //

   function &getVersions($journalId, $pagingInfo = null) {
      $versions = array();

      $result = &$this->retrieveRange(
         'SELECT * FROM rt_versions WHERE journal_id = ? ORDER BY version_key',
         $journalId,
         $pagingInfo
      );

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

   function &getVersion($versionId, $journalId) {
      $result = &$this->retrieve(
         'SELECT * FROM rt_versions WHERE version_id = ? AND journal_id = ?',
         array($versionId, $journalId)
      );

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

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

      return $returner;
   }

   function insertVersion($journalId, &$version) {
      $this->update(
         'INSERT INTO rt_versions
         (journal_id, version_key, locale, title, description)
         VALUES
         (?, ?, ?, ?, ?)',
         array((int) $journalId, $version->key, $version->locale, $version->title, $version->description)
      );

      $version->versionId = $this->getInsertId('rt_versions', 'version_id');

      foreach ($version->contexts as $context) {
         $context->versionId = $version->versionId;
         $this->insertContext($context);
      }

      return $version->versionId;
   }

   function updateVersion($journalId, &$version) {
      // FIXME Update contexts and searches?
      return $this->update(
         'UPDATE rt_versions
         SET
            title = ?,
            description = ?,
            version_key = ?,
            locale = ?
         WHERE version_id = ? AND journal_id = ?',
         array(
            $version->getTitle(),
            $version->getDescription(),
            $version->getKey(),
            $version->getLocale(),
            (int) $version->getVersionId(),
            (int) $journalId
         )
      );
   }

   function deleteVersionsByJournalId($journalId) {
      $versions = &$this->getVersions($journalId);
      foreach ($versions->toArray() as $version) {
         $this->deleteVersion($version->getVersionId(), $journalId);
      }
   }

   function deleteVersion($versionId, $journalId) {
      $this->deleteContextsByVersionId($versionId);
      return $this->update(
         'DELETE FROM rt_versions WHERE version_id = ? AND journal_id = ?',
         array((int) $versionId, (int) $journalId)
      );
   }

   function deleteVersionsByJournal($journalId) {
      $versions = &RTDAO::getVersions($journalId);
      while (!$versions->eof()) {
         $version = &$versions->next();
         $this->deleteVersion($version->getVersionId(), $journalId);
      }
   }

   function &_returnJournalRTFromRow(&$row) {
      $rt = &new JournalRT($row['journal_id']);
      $rt->setVersion($row['version_id']);
      $rt->setCaptureCite($row['capture_cite']);
      $rt->setViewMetadata($row['view_metadata']);
      $rt->setSupplementaryFiles($row['supplementary_files']);
      $rt->setPrinterFriendly($row['printer_friendly']);
      $rt->setAuthorBio($row['author_bio']);
      $rt->setDefineTerms($row['define_terms']);
      $rt->setEmailAuthor($row['email_author']);
      $rt->setEmailOthers($row['email_others']);

      HookRegistry::call('RTDAO::_returnJournalRTFromRow', array(&$rt, &$row));

      return $rt;
   }

   function &_returnVersionFromRow(&$row) {
      $version = &new RTVersion();
      $version->setVersionId($row['version_id']);
      $version->setKey($row['version_key']);
      $version->setLocale($row['locale']);
      $version->setTitle($row['title']);
      $version->setDescription($row['description']);

      if (!HookRegistry::call('RTDAO::_returnVersionFromRow', array(&$version, &$row))) {
         $contextsIterator = &$this->getContexts($row['version_id']);
         $version->setContexts($contextsIterator->toArray());
      }

      return $version;
   }

   function &_returnSearchFromRow(&$row) {
      $search = &new RTSearch();
      $search->setSearchId($row['search_id']);
      $search->setContextId($row['context_id']);
      $search->setTitle($row['title']);
      $search->setDescription($row['description']);
      $search->setUrl($row['url']);
      $search->setSearchUrl($row['search_url']);
      $search->setSearchPost($row['search_post']);
      $search->setOrder($row['seq']);

      HookRegistry::call('RTDAO::_returnSearchFromRow', array(&$search, &$row));

      return $search;
   }



   //
   // RT Contexts
   //

   function &getContext($contextId) {
      $result = &$this->retrieve(
         'SELECT * FROM rt_contexts WHERE context_id = ?',
         array((int) $contextId)
      );

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

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

      return $returner;
   }

   function &getContexts($versionId, $pagingInfo = null) {
      $contexts = array();

      $result = &$this->retrieveRange(
         'SELECT * FROM rt_contexts WHERE version_id = ? ORDER BY seq',
         array((int) $versionId),
         $pagingInfo
      );

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

   function insertContext(&$context) {
      $this->update(
         'INSERT INTO rt_contexts
         (version_id, title, abbrev, description, cited_by, author_terms, geo_terms, define_terms, seq)
         VALUES
         (?, ?, ?, ?, ?, ?, ?, ?, ?)',
         array(
            (int) $context->versionId,
            $context->title,
            $context->abbrev,
            $context->description,
            $context->citedBy?1:0,
            $context->authorTerms?1:0,
            $context->geoTerms?1:0,
            $context->defineTerms?1:0,
            (int) $context->order
         )
      );

      $context->contextId = $this->getInsertId('rt_contexts', 'context_id');

      foreach ($context->searches as $search) {
         $search->contextId = $context->contextId;
         $this->insertSearch($search);
      }

      return $context->contextId;
   }

   function updateContext(&$context) {
      // FIXME Update searches?
      return $this->update(
         'UPDATE rt_contexts
         SET title = ?, abbrev = ?, description = ?, cited_by = ?, author_terms = ?, geo_terms = ?, define_terms = ?, seq = ?
         WHERE context_id = ? AND version_id = ?',
         array($context->title, $context->abbrev, $context->description, $context->citedBy?1:0, $context->authorTerms?1:0, $context->geoTerms?1:0, $context->defineTerms?1:0, (int) $context->order, (int) $context->contextId, (int) $context->versionId)
      );
   }

   function deleteContextsByVersionId($versionId) {
      $contexts = &$this->getContexts($versionId);
      foreach ($contexts->toArray() as $context) {
         $this->deleteContext(
            $context->getContextId(),
            $context->getVersionId()
         );
      }
   }

   function deleteContext($contextId, $versionId) {
      $result = $this->update(
         'DELETE FROM rt_contexts WHERE context_id = ? AND version_id = ?',
         array((int) $contextId, (int) $versionId)
      );
      if ($result) $this->deleteSearchesByContextId($contextId);
      return $result;
   }

   function resequenceContexts($versionId) {
      $result = &$this->retrieve(
         'SELECT context_id FROM rt_contexts WHERE version_id = ? ORDER BY seq',
         array((int) $versionId)
      );

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

         $result->moveNext();
      }

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

   function &_returnContextFromRow(&$row) {
      $context = &new RTContext();
      $context->setContextId($row['context_id']);
      $context->setVersionId($row['version_id']);
      $context->setTitle($row['title']);
      $context->setAbbrev($row['abbrev']);
      $context->setDescription($row['description']);
      $context->setCitedBy($row['cited_by']);
      $context->setAuthorTerms($row['author_terms']);
      $context->setGeoTerms($row['geo_terms']);
      $context->setDefineTerms($row['define_terms']);
      $context->setOrder($row['seq']);

      if (!HookRegistry::call('RTDAO::_returnContextFromRow', array(&$context, &$row))) {
         $searchesIterator = &$this->getSearches($row['context_id']);
         $context->setSearches($searchesIterator->toArray());
      }

      return $context;
   }



   //
   // RT Searches
   //

   function &getSearch($searchId) {
      $result = &$this->retrieve(
         'SELECT * FROM rt_searches WHERE search_id = ?',
         array((int) $searchId)
      );

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

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

      return $returner;
   }

   function &getSearches($contextId, $pagingInfo = null) {
      $searches = array();

      $result = &$this->retrieveRange(
         'SELECT * FROM rt_searches WHERE context_id = ? ORDER BY seq',
         array((int) $contextId),
         $pagingInfo
      );

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

   function insertSearch(&$search) {
      $this->update(
         'INSERT INTO rt_searches
         (context_id, title, description, url, search_url, search_post, seq)
         VALUES
         (?, ?, ?, ?, ?, ?, ?)',
         array(
            (int) $search->getContextId(),
            $search->getTitle(),
            $search->getDescription(),
            $search->getUrl(),
            $search->getSearchUrl(),
            $search->getSearchPost(),
            (int) $search->getOrder()
         )
      );

      $search->searchId = $this->getInsertId('rt_searches', 'search_id');
      return $search->searchId;
   }

   function updateSearch(&$search) {
      return $this->update(
         'UPDATE rt_searches
         SET title = ?, description = ?, url = ?, search_url = ?, search_post = ?, seq = ?
         WHERE search_id = ? AND context_id = ?',
         array(
            $search->getTitle(),
            $search->getDescription(),
            $search->getUrl(),
            $search->getSearchUrl(),
            $search->getSearchPost(),
            (int) $search->getOrder(),
            (int) $search->getSearchId(),
            (int) $search->getContextId()
         )
      );
   }

   function deleteSearchesByContextId($contextId) {
      return $this->update(
         'DELETE FROM rt_searches WHERE context_id = ?',
         array((int) $contextId)
      );
   }

   function deleteSearch($searchId, $contextId) {
      return $this->update(
         'DELETE FROM rt_searches WHERE search_id = ? AND context_id = ?',
         array((int) $searchId, (int) $contextId)
      );
   }

   function resequenceSearches($contextId) {
      $result = &$this->retrieve(
         'SELECT search_id FROM rt_searches WHERE context_id = ? ORDER BY seq',
         array((int) $contextId)
      );

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

         $result->moveNext();
      }

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

?>

---