controllers/grid/files/SubmissionFilesCategoryGridDataProvider.inc.php

<?php

import('lib.pkp.classes.controllers.grid.CategoryGridDataProvider');

class SubmissionFilesCategoryGridDataProvider extends CategoryGridDataProvider {

   var $_monographFiles;


   function SubmissionFilesCategoryGridDataProvider($fileStage, $dataProviderInitParams = null) {
      $gridDataProvider =& $this->initGridDataProvider($fileStage, $dataProviderInitParams);
      $this->setDataProvider($gridDataProvider);
   }


   //
   // Extended method from CategoryGridDataProvider.
   //
   function setDataProvider(&$gridDataProvider) {
      if (is_a($gridDataProvider, 'SubmissionFilesGridDataProvider')) {
         parent::setDataProvider($gridDataProvider);
      } else {
         assert(false);
      }
   }


   //
   // Implement template methods from GridDataProvider
   //
   function getAuthorizationPolicy(&$request, $args, $roleAssignments) {
      // Get the submission files grid data provider authorization policy.
      $dataProvider =& $this->getDataProvider();
      $policy = $dataProvider->getAuthorizationPolicy($request, $args, $roleAssignments);

      return $policy;
   }

   function getRequestArgs() {
      $dataProvider =& $this->getDataProvider();
      return $dataProvider->getRequestArgs();
   }

   function loadData() {
      // Return only the user accessible workflow stages.
      return array_keys($this->getAuthorizedContextObject(ASSOC_TYPE_ACCESSIBLE_WORKFLOW_STAGES));
   }


   //
   // Implement template methods from CategoryGridDataProvider
   //
   function &getCategoryData($categoryDataElement, $filter = null, $reviewRound = null) {
      $submissionFileDao =& DAORegistry::getDAO('SubmissionFileDAO'); /* @var $submissionFileDao SubmissionFileDAO */
      $dataProvider =& $this->getDataProvider();
      $monograph =& $dataProvider->getMonograph();
      $stageId = $categoryDataElement;
      $fileStage = $this->_getFileStageByStageId($stageId);
      $stageMonographFiles = 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');
            $reviewRound =& $reviewRoundDao->getLastReviewRoundByMonographId($monograph->getId(), $stageId);
         }
         $stageMonographFiles =& $submissionFileDao->getLatestNewRevisionsByReviewRound($reviewRound, $fileStage);
      } else {
         // Filter the passed workflow stage files.
         if (!$this->_monographFiles) {
            $this->_monographFiles =& $submissionFileDao->getLatestRevisions($monograph->getId());
         }
         $monographFiles =& $this->_monographFiles;
         $stageMonographFiles = array();
         foreach ($monographFiles as $key => $monographFile) {
            if ($monographFile->getFileStage() == $fileStage) {
               $stageMonographFiles[$key] =& $monographFile;
            }
            unset($monographFile);
         }
      }

      return $dataProvider->prepareSubmissionFileData($stageMonographFiles);
   }


   //
   // 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('controllers.grid.files.SubmissionFilesGridDataProvider');
      $gridDataProvider = new SubmissionFilesGridDataProvider($fileStage);

      return $gridDataProvider;
   }


   //
   // Private helper methods.
   //
   function _getFileStageByStageId($stageId) {
      switch($stageId) {
         case WORKFLOW_STAGE_ID_SUBMISSION:
            return MONOGRAPH_FILE_SUBMISSION;
            break;
         case WORKFLOW_STAGE_ID_INTERNAL_REVIEW:
         case WORKFLOW_STAGE_ID_EXTERNAL_REVIEW:
            return MONOGRAPH_FILE_REVIEW_FILE;
            break;
         case WORKFLOW_STAGE_ID_EDITING:
            return MONOGRAPH_FILE_FINAL;
            break;
         case WORKFLOW_STAGE_ID_PRODUCTION:
            return MONOGRAPH_FILE_PRODUCTION_READY;
            break;
         default:
            break;
      }
   }
}

?>