pkp/pkp-lib#11025 Include issue info on submission API data

Author: taslangraham

classes/submission/maps/Schema.php

@@ -18,8 +18,11 @@
 use APP\decision\types\Accept;
 use APP\decision\types\SkipExternalReview;
 use APP\facades\Repo;
+use APP\issue\Issue;
+use APP\publication\Publication;
 use APP\submission\Submission;
 use Illuminate\Support\Collection;
+use Illuminate\Support\Enumerable;
 use PKP\db\DAORegistry;
 use PKP\decision\DecisionType;
 use PKP\decision\types\BackFromCopyediting;
@@ -41,6 +44,9 @@
 
 class Schema extends \PKP\submission\maps\Schema
 {
+    /** Issues associated with submissions. Keyed by submission ID. */
+    public Enumerable $submissionsIssues;
+
     /**
      * @copydoc \PKP\submission\maps\Schema::mapByProperties()
      */
@@ -70,6 +76,10 @@ protected function mapByProperties(array $props, Submission $submission, bool|Co
             $locales[] = $primaryLocale;
         }
 
+        if (in_array('issueToBePublished', $props)) {
+            $output['issueToBePublished'] = $this->getPropertyIssueToBePublished($submission->getData('publications'));
+        }
+
         $output = $this->schemaService->addMissingMultilingualValues($this->schemaService::SCHEMA_SUBMISSION, $output, $locales);
 
         ksort($output);
@@ -81,10 +91,10 @@ protected function appSpecificProps(): array
     {
         return [
             'scheduledIn',
+            'issueToBePublished'
         ];
     }
 
-
     /**
      * Gets the Editorial decisions available to editors for a given stage of a submission
      *
@@ -165,4 +175,66 @@ protected function getAvailableEditorialDecisions(int $stageId, Submission $subm
 
         return $decisionTypes;
     }
+
+    /**
+     * Get issues associated with submissions. Results are keyed by submission ID.
+     *
+     * @return Enumerable<int, Issue[]>
+     */
+    protected function getSubmissionsIssues(Enumerable $submissions): Enumerable
+    {
+        $submissionIds = $submissions->map(fn (Submission $submission) => $submission->getId())->all();
+        $publications = Repo::publication()->getCollector()->filterBySubmissionIds($submissionIds)->getMany();
+        $issueIds = $publications->map(fn (Publication $publication) => $publication->getData('issueId'))
+            ->unique()
+            ->all();
+
+        $issues = Repo::issue()->getCollector()
+            ->filterByContextIds([$this->context->getId()])
+            ->filterByIssueIds($issueIds)
+            ->getMany();
+
+        $issueIdsGroupedBySubmission = $publications->groupBy(fn (Publication $publication) => $publication->getData('submissionId'))
+            ->map(fn ($entry) => $entry->map(fn (Publication $publication) => $publication->getData('issueId')));
+
+        return $submissions->mapWithKeys(function ($submission) use (&$issues, $publications, $issueIdsGroupedBySubmission) {
+            $submissionIssueIds = $issueIdsGroupedBySubmission->get($submission->getId())->all();
+            return [$submission->getId() => $issues->filter(fn ($issue) => in_array($issue->getId(), $submissionIssueIds))];
+        });
+    }
+
+    /**
+     * Get details about the issue a submission will be published in.
+     */
+    protected function getPropertyIssueToBePublished(Enumerable $publications): ?array
+    {
+        /** @var Publication $latestScheduledPublication */
+        $latestScheduledPublication = $publications
+            ->filter(fn ($publication) => $publication->getData('status') === Submission::STATUS_SCHEDULED)
+            ->sortByDesc(fn (Publication $publication) => $publication->getData('version'))
+            ->first();
+
+        if ($latestScheduledPublication) {
+            $submissionId = $latestScheduledPublication->getData('submissionId');
+            $issueId = $latestScheduledPublication->getData('issueId');
+            $issue = $this->submissionsIssues->get($submissionId, collect())->get($issueId);
+
+            return $issue ? [
+                'id' => $issueId,
+                'label' => $issue->getIssueIdentification()
+            ] : null;
+        }
+
+        return null;
+    }
+
+    /**
+     * Populate class properties specific to OJS.
+     */
+    protected function addAppSpecificData(Enumerable $submissions): void
+    {
+        if (empty($this->submissionsIssues)) {
+            $this->submissionsIssues = $this->getSubmissionsIssues($submissions);
+        }
+    }
 }

schemas/submission.json

@@ -97,6 +97,18 @@
 					}
 				}
 			}
+		},
+		"issueToBePublished": {
+			"type": "object",
+			"properties": {
+				"id": {
+					"type": "integer"
+				},
+				"label": {
+					"type": "string"
+				}
+			},
+			"apiSummary": true
 		}
 	}
 }