classes/paper/PaperFileDAO.inc.php

Go to the documentation of this file.

<?php

//$Id$

import('paper.PaperFile');

class PaperFileDAO extends DAO {
   var $inlineableTypes;

   function &getPaperFile($fileId, $revision = null, $paperId = null) {
      if ($fileId === null) {
         $returner = null;
         return $returner;
      }
      if ($revision == null) {
         if ($paperId != null) {
            $result =& $this->retrieveLimit(
               'SELECT a.* FROM paper_files a WHERE file_id = ? AND paper_id = ? ORDER BY revision DESC',
               array($fileId, $paperId),
               1
            );
         } else {
            $result =& $this->retrieveLimit(
               'SELECT a.* FROM paper_files a WHERE file_id = ? ORDER BY revision DESC',
               $fileId,
               1
            );
         }

      } else {
         if ($paperId != null) {
            $result =& $this->retrieve(
               'SELECT a.* FROM paper_files a WHERE file_id = ? AND revision = ? AND paper_id = ?',
               array($fileId, $revision, $paperId)
            );
         } else {
            $result =& $this->retrieve(
               'SELECT a.* FROM paper_files a WHERE file_id = ? AND revision = ?',
               array($fileId, $revision)
            );
         }
      }

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

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

      return $returner;
   }

   function &getPaperFileRevisions($fileId, $stage = null) {
      if ($fileId === null) {
         $returner = null;
         return $returner;
      }
      $paperFiles = array();

      $params = array($fileId);
      if ($stage !== null) $params[] = $stage;

      $result =& $this->retrieve(
         'SELECT a.* FROM paper_files a WHERE file_id = ? ' .
         ($stage!==null?'AND a.stage = ? ':'') .
         'ORDER BY revision',
         array($params)
      );

      while (!$result->EOF) {
         $paperFiles[] =& $this->_returnPaperFileFromRow($result->GetRowAssoc(false));
         $result->moveNext();
      }

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

      return $paperFiles;
   }

   function &getPaperFileRevisionsInRange($fileId, $start = 1, $end = null) {
      if ($fileId === null) {
         $returner = null;
         return $returner;
      }
      $paperFiles = array();

      if ($end == null) {
         $result =& $this->retrieve(
            'SELECT a.* FROM paper_files a WHERE file_id = ? AND revision >= ?',
            array($fileId, $start)
         );
      } else {
         $result =& $this->retrieve(
            'SELECT a.* FROM paper_files a WHERE file_id = ? AND revision >= ? AND revision <= ?',
            array($fileId, $start, $end)
         );    
      }

      while (!$result->EOF) {
         $paperFiles[] =& $this->_returnPaperFileFromRow($result->GetRowAssoc(false));
         $result->moveNext();
      }

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

      return $paperFiles;
   }

   function &getRevisionNumber($fileId) {
      if ($fileId === null) {
         $returner = null;
         return $returner;
      }
      $result =& $this->retrieve(
         'SELECT MAX(revision) AS max_revision FROM paper_files a WHERE file_id = ?',
         $fileId
      );

      if ($result->RecordCount() == 0) {
         $returner = null;
      } else {
         $row = $result->FetchRow();
         $returner = $row['max_revision'];
      }

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

      return $returner;
   }

   function &getPaperFilesByPaper($paperId) {
      $paperFiles = array();

      $result =& $this->retrieve(
         'SELECT * FROM paper_files WHERE paper_id = ?',
         $paperId
      );

      while (!$result->EOF) {
         $paperFiles[] =& $this->_returnPaperFileFromRow($result->GetRowAssoc(false));
         $result->moveNext();
      }

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

      return $paperFiles;
   }

   function &_returnPaperFileFromRow(&$row) {
      $paperFile = new PaperFile();
      $paperFile->setFileId($row['file_id']);
      $paperFile->setRevision($row['revision']);
      $paperFile->setPaperId($row['paper_id']);
      $paperFile->setFileName($row['file_name']);
      $paperFile->setFileType($row['file_type']);
      $paperFile->setFileSize($row['file_size']);
      $paperFile->setOriginalFileName($row['original_file_name']);
      $paperFile->setType($row['type']);
      $paperFile->setStage($row['stage']);
      $paperFile->setDateUploaded($this->datetimeFromDB($row['date_uploaded']));
      $paperFile->setDateModified($this->datetimeFromDB($row['date_modified']));
      $paperFile->setViewable($row['viewable']);
      HookRegistry::call('PaperFileDAO::_returnPaperFileFromRow', array(&$paperFile, &$row));
      return $paperFile;
   }

   function insertPaperFile(&$paperFile) {
      $fileId = $paperFile->getFileId();
      $params = array(
         $paperFile->getRevision() === null ? 1 : $paperFile->getRevision(),
         (int) $paperFile->getPaperId(),
         $paperFile->getFileName(),
         $paperFile->getFileType(),
         $paperFile->getFileSize(),
         $paperFile->getOriginalFileName(),
         $paperFile->getType(),
         (int) $paperFile->getStage(),
         $paperFile->getViewable()
      );

      if ($fileId) {
         array_unshift($params, $fileId);
      }

      $this->update(
         sprintf('INSERT INTO paper_files
            (' . ($fileId ? 'file_id, ' : '') . 'revision, paper_id, file_name, file_type, file_size, original_file_name, type, stage, date_uploaded, date_modified, viewable)
            VALUES
            (' . ($fileId ? '?, ' : '') . '?, ?, ?, ?, ?, ?, ?, ?, %s, %s, ?)',
            $this->datetimeToDB($paperFile->getDateUploaded()), $this->datetimeToDB($paperFile->getDateModified())),
         $params
      );

      if (!$fileId) {
         $paperFile->setFileId($this->getInsertPaperFileId());
      }

      return $paperFile->getFileId();
   }

   function updatePaperFile(&$paperFile) {
      $this->update(
         sprintf('UPDATE paper_files
            SET
               paper_id = ?,
               file_name = ?,
               file_type = ?,
               file_size = ?,
               original_file_name = ?,
               type = ?,
               stage = ?,
               date_uploaded = %s,
               date_modified = %s,
               viewable = ?
            WHERE file_id = ? AND revision = ?',
            $this->datetimeToDB($paperFile->getDateUploaded()), $this->datetimeToDB($paperFile->getDateModified())),
         array(
            (int) $paperFile->getPaperId(),
            $paperFile->getFileName(),
            $paperFile->getFileType(),
            $paperFile->getFileSize(),
            $paperFile->getOriginalFileName(),
            $paperFile->getType(),
            (int) $paperFile->getStage(),
            $paperFile->getViewable(),
            $paperFile->getFileId(),
            $paperFile->getRevision()
         )
      );

      return $paperFile->getFileId();

   }

   function deletePaperFile(&$paperFile) {
      return $this->deletePaperFileById($paperFile->getFileId(), $paperFile->getRevision());
   }

   function deletePaperFileById($fileId, $revision = null) {
      if ($revision == null) {
         return $this->update(
            'DELETE FROM paper_files WHERE file_id = ?', $fileId
         );
      } else {
         return $this->update(
            'DELETE FROM paper_files WHERE file_id = ? AND revision = ?', array($fileId, $revision)
         );
      }
   }

   function deletePaperFiles($paperId) {
      return $this->update(
         'DELETE FROM paper_files WHERE paper_id = ?', $paperId
      );
   }

   function getInsertPaperFileId() {
      return $this->getInsertId('paper_files', 'file_id');
   }

   function isInlineable(&$paperFile) {
      if (!isset($this->inlineableTypes)) {
         $this->inlineableTypes = array_filter(file(Config::getVar('general', 'registry_dir') . '/inlineTypes.txt'), create_function('&$a', 'return ($a = trim($a)) && !empty($a) && $a[0] != \'#\';'));
      }
      return in_array($paperFile->getFileType(), $this->inlineableTypes);
   }
}

?>

---