SubmissionFilesGridDataProvider.inc.php

<?php
import('lib.pkp.controllers.grid.files.FilesGridDataProvider');
 
class SubmissionFilesGridDataProvider extends FilesGridDataProvider {
 
   var $_stageId;
 
   var $_fileStage;
 
 
   function __construct($fileStage, $viewableOnly = false) {
      assert(is_numeric($fileStage) && $fileStage > 0);
      $this->_fileStage = (int)$fileStage;
      parent::__construct();
 
      $this->setViewableOnly($viewableOnly);
   }
 
 
   //
   // Getters and setters.
   //
   function setStageId($stageId) {
      $this->_stageId = $stageId;
   }
 
   function getStageId() {
      return $this->_stageId;
   }
 
 
   //
   // Implement template methods from GridDataProvider
   //
   function getRequestArgs() {
      $submission = $this->getSubmission();
      return array(
         'submissionId' => $submission->getId(),
         'stageId' => $this->getStageId(),
         'fileStage' => $this->getFileStage(),
      );
   }
 
   function getFileStage() {
      return $this->_fileStage;
   }
 
   function loadData($filter = array()) {
      // Retrieve all submission files for the given file stage.
      $submission = $this->getSubmission();
      $submissionFileDao = DAORegistry::getDAO('SubmissionFileDAO'); /* @var $submissionFileDao SubmissionFileDAO */
      $submissionFiles = $submissionFileDao->getLatestRevisions($submission->getId(), $this->getFileStage(), null);
      return $this->prepareSubmissionFileData($submissionFiles, $this->_viewableOnly, $filter);
   }
 
   //
   // Implement template methods from GridDataProvider
   //
   function getAuthorizationPolicy($request, $args, $roleAssignments) {
      $this->setUploaderRoles($roleAssignments);
 
      import('lib.pkp.classes.security.authorization.WorkflowStageAccessPolicy');
      return new WorkflowStageAccessPolicy($request, $args, $roleAssignments, 'submissionId', $this->getStageId());
   }
 
   //
   // Overridden public methods from FilesGridDataProvider
   //
   function getAddFileAction($request) {
      import('lib.pkp.controllers.api.file.linkAction.AddFileLinkAction');
      $submission = $this->getSubmission();
      return new AddFileLinkAction(
         $request, $submission->getId(),
         $this->getStageId(), $this->getUploaderRoles(), $this->getFileStage()
      );
   }
 
 
   //
   // Protected functions
   //
   protected function applyFilter($revisions, $filter) {
      if (!empty($filter['search'])) switch ($filter['column']) {
         case 'name':
            foreach ($revisions as $key => $submissionFile) {
               if (!stristr($submissionFile->getName(AppLocale::getLocale()), $filter['search'])) {
                  unset($revisions[$key]);
               }
            }
            break;
      }
      return $revisions;
   }
 
   function prepareSubmissionFileData($revisions, $viewableOnly = false, $filter = array()) {
      $revisions = $this->applyFilter($revisions, $filter);
 
      // Rearrange the files as required by submission file grids.
      $submissionFileData = array();
      foreach ($revisions as $revision) {
         if ($viewableOnly && !$revision->getViewable()) continue;
 
         $submissionFileData[$revision->getFileId()] = array(
            'submissionFile' => $revision
         );
         unset($revision);
      }
      return $submissionFileData;
   }
}