pkp/pkp-lib#10923 add funding metadata to ONIX exports

Author: kaitlinnewson

plugins/importexport/onix30/filter/MonographONIX30XmlFilter.php

@@ -28,10 +28,14 @@
 use DOMElement;
 use DOMException;
 use Exception;
+use Illuminate\Database\Query\JoinClause;
+use Illuminate\Support\Collection;
+use Illuminate\Support\Facades\DB;
 use PKP\db\DAORegistry;
 use PKP\filter\FilterGroup;
 use PKP\i18n\LocaleConversion;
 use PKP\plugins\importexport\native\filter\NativeExportFilter;
+use PKP\plugins\PluginRegistry;
 use PKP\userGroup\UserGroup;
 
 class MonographONIX30XmlFilter extends NativeExportFilter
@@ -563,9 +567,6 @@ public function createProductNode(DOMDocument $doc, Submission $submission, Publ
 
         $publisherNode->appendChild($this->buildTextNode($doc, 'PublishingRole', '01')); // Publisher
         $publisherNode->appendChild($this->buildTextNode($doc, 'PublisherName', $context->getData('publisher')));
-        if ($context->getData('location') != '') {
-            $publishingDetailNode->appendChild($this->buildTextNode($doc, 'CityOfPublication', $context->getData('location')));
-        }
 
         $websiteNode = $doc->createElementNS($deployment->getNamespace(), 'Website');
         $publisherNode->appendChild($websiteNode);
@@ -586,6 +587,37 @@ public function createProductNode(DOMDocument $doc, Submission $submission, Publ
 
         $websiteNode->appendChild($this->buildTextNode($doc, 'WebsiteLink', $request->url($context->getPath(), 'catalog', 'book', [$submissionBestId])));
 
+        /* --- Funders and awards --- */
+
+        $fundingData = $this->getFundingData($context->getId(), $submissionBestId);
+        if (!$fundingData->isEmpty()) {
+            foreach ($fundingData as $funder) {
+                $publisherNode = $doc->createElementNS($deployment->getNamespace(), 'Publisher');
+                $publisherNode->appendChild($this->buildTextNode($doc, 'PublishingRole', '16')); // 16 -> Funding body
+                $publisherIdentifierNode = $doc->createElementNS($deployment->getNamespace(), 'PublisherIdentifier');
+                $publisherIdentifierNode->appendChild($this->buildTextNode($doc, 'PublisherIDType', '32')); // 32 -> FundRef DOI
+                $publisherIdentifierNode->appendChild($this->buildTextNode($doc, 'IDValue', $funder[0]->funder_identification));
+                $publisherNode->appendChild($publisherIdentifierNode);
+                $publisherNode->appendChild($this->buildTextNode($doc, 'PublisherName', $funder[0]->funder_name));
+                foreach ($funder as $awards) {
+                    $fundingNode = $doc->createElementNS($deployment->getNamespace(), 'Funding');
+                    $fundingIdentifierNode = $doc->createElementNS($deployment->getNamespace(), 'FundingIdentifier');
+                    $fundingIdentifierNode->appendChild($this->buildTextNode($doc, 'FundingIDType', '01')); // 01 -> proprietary
+                    $fundingIdentifierNode->appendChild($this->buildTextNode($doc, 'IDTypeName', 'Award/Grant Number'));
+                    $fundingIdentifierNode->appendChild($this->buildTextNode($doc, 'IDValue', $awards->funder_award_number));
+                    $fundingNode->appendChild($fundingIdentifierNode);
+                    $publisherNode->appendChild($fundingNode);
+                }
+                $publishingDetailNode->appendChild($publisherNode);
+            }
+        }
+
+        /* --- Publishing Location --- */
+
+        if ($context->getData('location') != '') {
+            $publishingDetailNode->appendChild($this->buildTextNode($doc, 'CityOfPublication', $context->getData('location')));
+        }
+
         /* --- Publishing Dates --- */
 
         $publicationDates = $publicationFormat->getPublicationDates();
@@ -956,4 +988,29 @@ public function buildTextNode(DOMDocument $doc, string $nodeName, string $textCo
         $node->appendChild($doc->createTextNode($textContent));
         return $node;
     }
+
+    /**
+     * Helper function to retrieve funding data when available.
+     */
+    public function getFundingData(int $contextId, int $submissionId): Collection|false
+    {
+        if (!PluginRegistry::getPlugin('generic', 'FundingPlugin')) {
+            return false;
+        }
+
+        $fundingData = DB::table('funders AS f')
+            ->select('f.funder_id', 'f.funder_identification', 'fs.setting_value as funder_name', 'fa.funder_award_id', 'fa.funder_award_number')
+            ->where('submission_id', $submissionId)
+            ->where('context_id', $contextId)
+            ->leftJoin(
+                'funder_settings AS fs',
+                fn (JoinClause $j) => $j->on('f.funder_id', '=', 'fs.funder_id')
+                    ->where('fs.setting_name', '=', 'funderName')
+            )
+            ->leftjoin('funder_awards AS fa', 'f.funder_id', '=', 'fa.funder_id')
+            ->get()
+            ->groupBy('funder_id');
+
+        return $fundingData ?? false;
+    }
 }