classes/monograph/SubmissionFileDAO.inc.php

<?php

import('lib.pkp.classes.submission.PKPSubmissionFileDAO');

class SubmissionFileDAO extends PKPSubmissionFileDAO {
   function SubmissionFileDAO() {
      return parent::PKPSubmissionFileDAO();
   }


   //
   // Implement protected template methods from PKPSubmissionFileDAO
   //
   function getSubmissionEntityName() {
      return 'monograph';
   }

   function getDelegateClassNames() {
      static $delegateClasses = array(
         'artworkfile' => 'classes.monograph.ArtworkFileDAODelegate',
         'monographfile' => 'classes.monograph.MonographFileDAODelegate'
      );
      return $delegateClasses;
   }

   function getGenreCategoryMapping() {
      static $genreCategoryMapping = array(
         GENRE_CATEGORY_ARTWORK => 'artworkfile',
         GENRE_CATEGORY_DOCUMENT => 'monographfile'
      );
      return $genreCategoryMapping;
   }

   function baseQueryForFileSelection() {
      // Build the basic query that joins the class tables.
      // The DISTINCT is required to de-dupe the review_round_files join in
      // PKPSubmissionFileDAO.
      return 'SELECT DISTINCT
            sf.file_id AS monograph_file_id, sf.revision AS monograph_revision,
            af.file_id AS artwork_file_id, af.revision AS artwork_revision,
            sf.*, af.*
         FROM  monograph_files sf
            LEFT JOIN monograph_artwork_files af ON sf.file_id = af.file_id AND sf.revision = af.revision ';
   }


   //
   // Override methods from PKPSubmissionFileDAO
   // FIXME *6902* Move this code to PKPSubmissionFileDAO after the review round
   // refactoring is ported to other applications.
   //
   function deleteAllRevisionsByReviewRound($reviewRoundId) {
      // Remove currently assigned review files.
      return $this->update('DELETE FROM review_round_files
                  WHERE review_round_id = ?',
      array((int)$reviewRoundId));
   }

   function assignRevisionToReviewRound($fileId, $revision, &$reviewRound) {
      if (!is_numeric($fileId) || !is_numeric($revision)) fatalError('Invalid file!');
      return $this->update('INSERT INTO review_round_files
                  ('.$this->getSubmissionEntityName().'_id, review_round_id, stage_id, file_id, revision)
                  VALUES (?, ?, ?, ?, ?)',
      array((int)$reviewRound->getSubmissionId(), (int)$reviewRound->getId(), (int)$reviewRound->getStageId(), (int)$fileId, (int)$revision));
   }

   function &getRevisionsByReviewRound(&$reviewRound, $fileStage = null,
   $uploaderUserId = null, $uploaderUserGroupId = null) {
      if (!is_a($reviewRound, 'ReviewRound')) {
         $nullVar = null;
         return $nullVar;
      }
      return $this->_getInternally($reviewRound->getSubmissionId(),
         $fileStage, null, null, null, null, null,
         $uploaderUserId, $uploaderUserGroupId, null, $reviewRound->getId()
      );
   }

   function &getLatestNewRevisionsByReviewRound($reviewRound, $fileStage = null) {
      if (!is_a($reviewRound, 'ReviewRound')) {
         $emptyArray = array();
         return $emptyArray;
      }
      return $this->_getInternally($reviewRound->getSubmissionId(),
         $fileStage, null, null, null, null, $reviewRound->getStageId(),
         null, null, null, $reviewRound->getId(), true
      );
   }

   function getAllFileStages() {
      // Bring in the file stages definition.
      import('classes.monograph.MonographFile');
      return array(
         MONOGRAPH_FILE_PUBLIC,
         MONOGRAPH_FILE_SUBMISSION,
         MONOGRAPH_FILE_NOTE,
         MONOGRAPH_FILE_REVIEW_FILE,
         MONOGRAPH_FILE_REVIEW_ATTACHMENT,
         MONOGRAPH_FILE_FINAL,
         MONOGRAPH_FILE_FAIR_COPY,
         MONOGRAPH_FILE_EDITOR,
         MONOGRAPH_FILE_COPYEDIT,
         MONOGRAPH_FILE_PROOF,
         MONOGRAPH_FILE_PRODUCTION_READY,
         MONOGRAPH_FILE_LAYOUT,
         MONOGRAPH_FILE_ATTACHMENT,
         MONOGRAPH_FILE_SIGNOFF,
         MONOGRAPH_FILE_REVIEW_REVISION,
      );
   }


   //
   // Protected helper methods
   //
   function &fromRow(&$row) {
      // Identify the appropriate file implementation for the
      // given row.
      if (isset($row['artwork_file_id']) && is_numeric($row['artwork_file_id'])) {
         $fileImplementation = 'ArtworkFile';
      } else {
         $fileImplementation = 'MonographFile';
      }

      // Let the superclass instantiate the file.
      return parent::fromRow($row, $fileImplementation);
   }
}

?>