SubmissionFilesCategoryGridDataProvider.inc.php

<?php
 
import('lib.pkp.classes.controllers.grid.CategoryGridDataProvider');
 
class SubmissionFilesCategoryGridDataProvider extends CategoryGridDataProvider {
 
   var $_submissionFiles;
 
 
   function __construct($fileStage, $dataProviderInitParams = null) {
      parent::__construct();
      $this->setDataProvider($this->initGridDataProvider($fileStage, $dataProviderInitParams));
   }
 
 
   //
   // Extended method from CategoryGridDataProvider.
   //
   function setDataProvider($gridDataProvider) {
      assert(is_a($gridDataProvider, 'SubmissionFilesGridDataProvider'));
      parent::setDataProvider($gridDataProvider);
   }
 
 
   //
   // Implement template methods from GridDataProvider
   //
   function getAuthorizationPolicy($request, $args, $roleAssignments) {
      // Get the submission files grid data provider authorization policy.
      $dataProvider = $this->getDataProvider();
      return $dataProvider->getAuthorizationPolicy($request, $args, $roleAssignments);
   }
 
   function getRequestArgs() {
      $dataProvider = $this->getDataProvider();
      return $dataProvider->getRequestArgs();
   }
 
   function loadData($filter = array()) {
      // Return only the user accessible workflow stages.
      return array_keys($this->getAuthorizedContextObject(ASSOC_TYPE_ACCESSIBLE_WORKFLOW_STAGES));
   }
 
 
   //
   // Implement template methods from CategoryGridDataProvider
   //
   function loadCategoryData($request, $categoryDataElement, $filter = null, $reviewRound = null) {
      $submissionFileDao = DAORegistry::getDAO('SubmissionFileDAO'); /* @var $submissionFileDao SubmissionFileDAO */
      $dataProvider = $this->getDataProvider();
      $submission = $this->getAuthorizedContextObject(ASSOC_TYPE_SUBMISSION);
      $stageId = $categoryDataElement;
      $fileStage = $this->_getFileStageByStageId($stageId);
      $stageSubmissionFiles = null;
 
      // For review stages, get the revisions of the review round that user is currently accessing.
      if ($stageId == WORKFLOW_STAGE_ID_INTERNAL_REVIEW || $stageId == WORKFLOW_STAGE_ID_EXTERNAL_REVIEW) {
         if (is_null($reviewRound) || $reviewRound->getStageId() != $stageId) {
            $reviewRoundDao = DAORegistry::getDAO('ReviewRoundDAO'); /* @var $reviewRoundDao ReviewRoundDAO */
            $reviewRound = $reviewRoundDao->getLastReviewRoundBySubmissionId($submission->getId(), $stageId);
         }
         $stageSubmissionFiles = $submissionFileDao->getLatestRevisionsByReviewRound($reviewRound, $fileStage);
      } else {
         // Filter the passed workflow stage files.
         if (!$this->_submissionFiles) {
            $this->_submissionFiles = $submissionFileDao->getLatestRevisions($submission->getId());
         }
         $submissionFiles = $this->_submissionFiles;
         $stageSubmissionFiles = array();
         foreach ($submissionFiles as $key => $submissionFile) {
            if (in_array($submissionFile->getFileStage(), (array) $fileStage)) {
               $stageSubmissionFiles[$key] = $submissionFile;
            } elseif ($submissionFile->getFileStage() == SUBMISSION_FILE_QUERY) {
               // Determine the stage from the query.
               if ($submissionFile->getAssocType()!=ASSOC_TYPE_NOTE) break;
               $noteDao = DAORegistry::getDAO('NoteDAO'); /* @var $noteDao NoteDAO */
               $note = $noteDao->getById($submissionFile->getAssocId());
               assert($note && $note->getAssocType()==ASSOC_TYPE_QUERY);
               $queryDao = DAORegistry::getDAO('QueryDAO'); /* @var $queryDao QueryDAO */
               $query = $queryDao->getById($note->getAssocId());
               if ($query && $query->getStageId() == $stageId) $stageSubmissionFiles[$key] = $submissionFile;
            }
         }
      }
      return $dataProvider->prepareSubmissionFileData($stageSubmissionFiles, false, $filter);
   }
 
 
   //
   // Public methods
   //
   function getAddFileAction($request) {
      $dataProvider = $this->getDataProvider();
      return $dataProvider->getAddFileAction($request);
   }
 
   function setStageId($stageId) {
      $dataProvider = $this->getDataProvider();
      $dataProvider->setStageId($stageId);
   }
 
   function getFileStage() {
      $dataProvider = $this->getDataProvider();
      return $dataProvider->getFileStage();
   }
 
 
   //
   // Protected methods.
   //
   function initGridDataProvider($fileStage, $initParams = null) {
      // By default, this category grid data provider use the
      // SubmissionFilesGridDataProvider.
      import('lib.pkp.controllers.grid.files.SubmissionFilesGridDataProvider');
      return new SubmissionFilesGridDataProvider($fileStage);
   }
 
 
   //
   // Private helper methods.
   //
   function _getFileStageByStageId($stageId) {
      switch($stageId) {
         case WORKFLOW_STAGE_ID_SUBMISSION:
            return SUBMISSION_FILE_SUBMISSION;
            break;
         case WORKFLOW_STAGE_ID_INTERNAL_REVIEW:
         case WORKFLOW_STAGE_ID_EXTERNAL_REVIEW:
            return SUBMISSION_FILE_REVIEW_FILE;
            break;
         case WORKFLOW_STAGE_ID_EDITING:
            return array(SUBMISSION_FILE_FINAL, SUBMISSION_FILE_COPYEDIT);
            break;
         case WORKFLOW_STAGE_ID_PRODUCTION:
            return SUBMISSION_FILE_PRODUCTION_READY;
            break;
         default:
            break;
      }
   }
}