first commit

lib/pkp/controllers/grid/files/dependent/DependentFilesGridDataProvider.php

@@ -0,0 +1,106 @@
+<?php
+
+/**
+ * @file controllers/grid/files/dependent/DependentFilesGridDataProvider.php
+ *
+ * Copyright (c) 2014-2021 Simon Fraser University
+ * Copyright (c) 2000-2021 John Willinsky
+ * Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
+ *
+ * @class DependentFilesGridDataProvider
+ *
+ * @ingroup controllers_grid_files_dependent
+ *
+ * @brief Provide access to dependent file data for grids.
+ */
+
+namespace PKP\controllers\grid\files\dependent;
+
+use APP\core\Application;
+use APP\facades\Repo;
+use PKP\controllers\api\file\linkAction\AddFileLinkAction;
+use PKP\controllers\grid\files\SubmissionFilesGridDataProvider;
+use PKP\submissionFile\SubmissionFile;
+
+class DependentFilesGridDataProvider extends SubmissionFilesGridDataProvider
+{
+    /**
+     * The submission file id for the parent file.
+     *
+     * @var int
+     */
+    public $_assocId;
+
+    /**
+     * Constructor
+     *
+     * @param int $assocId Association ID
+     */
+    public function __construct($assocId)
+    {
+        assert(is_numeric($assocId));
+        $this->_assocId = (int) $assocId;
+        parent::__construct(SubmissionFile::SUBMISSION_FILE_DEPENDENT);
+    }
+
+    /**
+     * @copydoc GridDataProvider::loadData()
+     */
+    public function loadData($filter = [])
+    {
+        // Retrieve all dependent files for the given file stage and original submission file id (i.e. the main galley/production file)
+        $submissionFiles = Repo::submissionFile()
+            ->getCollector()
+            ->filterByAssoc(
+                Application::ASSOC_TYPE_SUBMISSION_FILE,
+                [$this->getAssocId()]
+            )->filterBySubmissionIds([$this->getSubmission()->getId()])
+            ->filterByFileStages([$this->getFileStage()])
+            ->includeDependentFiles()
+            ->getMany()
+            ->toArray();
+        return $this->prepareSubmissionFileData($submissionFiles, $this->_viewableOnly, $filter);
+    }
+
+    /**
+     * Overridden from SubmissionFilesGridDataProvider - we need to also include the assocType and assocId
+     *
+     * @copydoc FilesGridDataProvider::getAddFileAction()
+     */
+    public function getAddFileAction($request)
+    {
+        $submission = $this->getSubmission();
+        return new AddFileLinkAction(
+            $request,
+            $submission->getId(),
+            $this->getStageId(),
+            $this->getUploaderRoles(),
+            $this->getFileStage(),
+            Application::ASSOC_TYPE_SUBMISSION_FILE,
+            $this->getAssocId(),
+            null,
+            null,
+            $this->isDependent()
+        );
+    }
+
+    /**
+     * returns the id of the parent submission file for these dependent files.
+     *
+     * @return int
+     */
+    public function getAssocId()
+    {
+        return $this->_assocId;
+    }
+
+    /**
+     * Convenience function to make the argument to the AddFileLinkAction more obvious.
+     *
+     * @return true
+     */
+    public function isDependent()
+    {
+        return true;
+    }
+}