#11557 Use single format for keywords in publication object

ajnyga · ajnyga · commit 6e87bfe7ece7 · 2025-08-31T17:40:46.000+03:00
diff --git a/api/v1/reviews/PKPReviewController.php b/api/v1/reviews/PKPReviewController.php
@@ -181,7 +181,7 @@ public function getHistory(Request $illuminateRequest): JsonResponse
         }
 
         $publicationAbstract = $publication->getData('abstract');
-        $publicationKeywords = $publication->getData('keywords');
+        $publicationKeywords = array_map(fn($items) => array_column($items, 'name'), (array) $publication->getData('keywords'));
 
         $declineEmail = null;
         if ($reviewAssignment->getDeclined()) {
diff --git a/classes/components/forms/publication/PKPMetadataForm.php b/classes/components/forms/publication/PKPMetadataForm.php
@@ -167,8 +167,7 @@ protected function getVocabEntryData(string $symbolic): array
             $symbolic,
             Application::ASSOC_TYPE_PUBLICATION,
             $this->publication->getId(),
-            [],
-            Repo::controlledVocab()::AS_ENTRY_DATA
+            []
         );
     }
 }
diff --git a/classes/controlledVocab/ControlledVocab.php b/classes/controlledVocab/ControlledVocab.php
@@ -34,7 +34,6 @@ class ControlledVocab extends Model
     public const CONTROLLED_VOCAB_SUBMISSION_AGENCY = 'submissionAgency';
     public const CONTROLLED_VOCAB_SUBMISSION_DISCIPLINE = 'submissionDiscipline';
     public const CONTROLLED_VOCAB_SUBMISSION_KEYWORD = 'submissionKeyword';
-    public const CONTROLLED_VOCAB_SUBMISSION_LANGUAGE = 'submissionLanguage';
     public const CONTROLLED_VOCAB_SUBMISSION_SUBJECT = 'submissionSubject';
 
     /**
@@ -91,7 +90,6 @@ public static function getDefinedVocabSymbolic(): array
             static::CONTROLLED_VOCAB_SUBMISSION_AGENCY,
             static::CONTROLLED_VOCAB_SUBMISSION_DISCIPLINE,
             static::CONTROLLED_VOCAB_SUBMISSION_KEYWORD,
-            static::CONTROLLED_VOCAB_SUBMISSION_LANGUAGE,
             static::CONTROLLED_VOCAB_SUBMISSION_SUBJECT,
         ];
     }
diff --git a/classes/controlledVocab/Repository.php b/classes/controlledVocab/Repository.php
@@ -22,8 +22,6 @@
 
 class Repository
 {
-    const AS_ENTRY_DATA = true;
-
     /**
      * Fetch a Controlled Vocab by symbolic info, building it if needed.
      */
@@ -51,9 +49,8 @@ public function getBySymbolic(
         int $assocType,
         ?int $assocId,
         ?array $locales = [],
-        bool $asEntryData = !Repository::AS_ENTRY_DATA
-    ): array
-    {
+        bool $asStringOnly = false
+    ): array {
         $result = [];
 
         ControlledVocabEntry::query()
@@ -63,12 +60,14 @@ public function getBySymbolic(
             )
             ->when(!empty($locales), fn ($query) => $query->withLocales($locales))
             ->get()
-            ->each(function ($entry) use (&$result, $asEntryData) {
+            ->each(function ($entry) use (&$result, $asStringOnly) {
                 foreach ($entry->name as $locale => $value) {
-                    $result[$locale][] = $asEntryData ? $entry->getEntryData($locale) : $value;
+                    $result[$locale][] = $asStringOnly
+                        ? $value
+                        : $entry->getEntryData($locale);
                 }
             });
-        
+
         return $result;
     }
 
@@ -141,35 +140,4 @@ public function resequence(int $controlledVocabId): void
             });
     }
 
-    /**
-     * Hydrate controlled vocab entries as entry data for a publication which will
-     * include other meta information(e.g. source & identifier) in vocabs
-     */
-    public function hydrateVocabsAsEntryData(PKPPublication $publication): PKPPublication
-    {
-        $mappings = [
-            'keywords' => ControlledVocab::CONTROLLED_VOCAB_SUBMISSION_KEYWORD,
-            'subjects' => ControlledVocab::CONTROLLED_VOCAB_SUBMISSION_SUBJECT,
-            'disciplines' => ControlledVocab::CONTROLLED_VOCAB_SUBMISSION_DISCIPLINE,
-            'supportingAgencies' => ControlledVocab::CONTROLLED_VOCAB_SUBMISSION_AGENCY,
-        ];
-
-        foreach ($mappings as $dataKey => $symbolic) {
-            if (empty($publication->getData($dataKey))) {
-                continue;
-            }
-            $publication->setData(
-                $dataKey,
-                $this->getBySymbolic(
-                    $symbolic,
-                    Application::ASSOC_TYPE_PUBLICATION,
-                    $publication->getId(),
-                    [],
-                    static::AS_ENTRY_DATA
-                )
-            );
-        }
-
-        return $publication;
-    }
 }
diff --git a/classes/publication/DAO.php b/classes/publication/DAO.php
@@ -360,6 +360,8 @@ protected function deleteAuthors(int $publicationId)
      */
     protected function setControlledVocab(Publication $publication)
     {
+        # f11557
+        # These now return an object with all the data
         $publication->setData(
             'keywords',
             Repo::controlledVocab()->getBySymbolic(
diff --git a/classes/publication/Repository.php b/classes/publication/Repository.php
@@ -418,7 +418,6 @@ public function edit(Publication $publication, array $params): Publication
             }
         }
 
-        $publication = Repo::controlledVocab()->hydrateVocabsAsEntryData($publication);
         $newPublication = Repo::publication()->newDataObject(array_merge($publication->_data, $params));
         $newPublication->stampModified();
 
diff --git a/classes/publication/maps/Schema.php b/classes/publication/maps/Schema.php
@@ -104,7 +104,6 @@ public function summarizeMany(Enumerable $collection, bool $anonymize = false):
      */
     protected function mapByProperties(array $props, Publication $publication, bool $anonymize): array
     {
-        $publication = Repo::controlledVocab()->hydrateVocabsAsEntryData($publication);
         $this->anonymize = $anonymize;
 
         $output = [];
diff --git a/plugins/importexport/native/filter/NativeXmlPKPPublicationFilter.php b/plugins/importexport/native/filter/NativeXmlPKPPublicationFilter.php
@@ -144,7 +144,19 @@ public function handleChildElement($n, $publication)
 
             for ($nc = $n->firstChild; $nc !== null; $nc = $nc->nextSibling) {
                 if ($nc instanceof \DOMElement) {
-                    $controlledVocabulary[] = $nc->textContent;
+                    $item = ['name' => $nc->getElementsByTagName('name')->item(0)->textContent];
+
+                    $identifierNode = $nc->getElementsByTagName('identifier')->item(0);
+                    if ($identifierNode) {
+                        $item['identifier'] = $identifierNode->textContent;
+                    }
+
+                    $sourceNode = $nc->getElementsByTagName('source')->item(0);
+                    if ($sourceNode) {
+                        $item['source'] = $sourceNode->textContent;
+                    }
+
+                    $controlledVocabulary[] = $item;
                 }
             }
 
diff --git a/plugins/importexport/native/filter/PKPPublicationNativeXmlFilter.php b/plugins/importexport/native/filter/PKPPublicationNativeXmlFilter.php
@@ -213,6 +213,8 @@ public function addMetadata($doc, $entityNode, $entity)
 
         // add controlled vocabularies
         // get the supported locale keys
+        # f11557
+        # TODO native XML
         $controlledVocabulariesMapping = $this->_getControlledVocabulariesMappings();
         foreach ($controlledVocabulariesMapping as $controlledVocabulariesNodeName => $mappings) {
             $symbolic = $mappings[0];
@@ -239,12 +241,22 @@ public function addControlledVocabulary($doc, $entityNode, $controlledVocabulari
     {
         $deployment = $this->getDeployment();
         $locales = array_keys($controlledVocabulary);
+
         foreach ($locales as $locale) {
             if (!empty($controlledVocabulary[$locale])) {
                 $controlledVocabulariesNode = $doc->createElementNS($deployment->getNamespace(), $controlledVocabulariesNodeName);
                 $controlledVocabulariesNode->setAttribute('locale', $locale);
-                foreach ($controlledVocabulary[$locale] as $controlledVocabularyItem) {
-                    $controlledVocabulariesNode->appendChild($node = $doc->createElementNS($deployment->getNamespace(), $controlledVocabularyNodeName, htmlspecialchars($controlledVocabularyItem, ENT_COMPAT, 'UTF-8')));
+
+                foreach ($controlledVocabulary[$locale] as $item) {
+                    $node = $doc->createElementNS($deployment->getNamespace(), $controlledVocabularyNodeName);
+                    $node->appendChild($doc->createElementNS($deployment->getNamespace(), 'name', htmlspecialchars($item['name'], ENT_COMPAT, 'UTF-8')));
+                    if (!empty($item['identifier'])) {
+                        $node->appendChild($doc->createElementNS($deployment->getNamespace(), 'identifier', htmlspecialchars($item['identifier'], ENT_COMPAT, 'UTF-8')));
+                    }
+                    if (!empty($item['source'])) {
+                        $node->appendChild($doc->createElementNS($deployment->getNamespace(), 'source', htmlspecialchars($item['source'], ENT_COMPAT, 'UTF-8')));
+                    }
+                    $controlledVocabulariesNode->appendChild($node);
                 }
 
                 $entityNode->appendChild($controlledVocabulariesNode);
diff --git a/plugins/importexport/native/pkp-native.xsd b/plugins/importexport/native/pkp-native.xsd
@@ -356,20 +356,27 @@
 	<element name="pkppublication" type="pkp:pkppublication" />
 
 	<!-- Controlled vocabularies -->
+	<complexType name="ControlledVocabEntryType">
+		<sequence>
+			<element name="name" type="string"/>
+			<element name="identifier" type="string" minOccurs="0"/>
+			<element name="source" type="string" minOccurs="0"/>
+		</sequence>
+	</complexType>
 	<element name="keywords">
 		<complexType>
 			<sequence>
-				<element name="keyword" type="string" minOccurs="1" maxOccurs="unbounded" />
+				<element name="keyword" type="pkp:ControlledVocabEntryType" minOccurs="1" maxOccurs="unbounded"/>
 			</sequence>
-			<attribute name="locale" type="string" />
+			<attribute name="locale" type="string"/>
 		</complexType>
 	</element>
 	<element name="agencies">
 		<complexType>
 			<sequence>
-				<element name="agency" type="string" minOccurs="1" maxOccurs="unbounded" />
+				<element name="keyword" type="pkp:ControlledVocabEntryType" minOccurs="1" maxOccurs="unbounded"/>
 			</sequence>
-			<attribute name="locale" type="string" />
+			<attribute name="locale" type="string"/>
 		</complexType>
 	</element>
 	<element name="languages">
@@ -383,17 +390,17 @@
 	<element name="disciplines">
 		<complexType>
 			<sequence>
-				<element name="discipline" type="string" minOccurs="1" maxOccurs="unbounded" />
+				<element name="keyword" type="pkp:ControlledVocabEntryType" minOccurs="1" maxOccurs="unbounded"/>
 			</sequence>
-			<attribute name="locale" type="string" />
+			<attribute name="locale" type="string"/>
 		</complexType>
 	</element>
 	<element name="subjects">
 		<complexType>
 			<sequence>
-				<element name="subject" type="string" minOccurs="1" maxOccurs="unbounded" />
+				<element name="keyword" type="pkp:ControlledVocabEntryType" minOccurs="1" maxOccurs="unbounded"/>
 			</sequence>
-			<attribute name="locale" type="string" />
+			<attribute name="locale" type="string"/>
 		</complexType>
 	</element>
 	<element name="citations">

Original file line number	Diff line number	Diff line change
`@@ -181,7 +181,7 @@ public function getHistory(Request $illuminateRequest): JsonResponse`
`181`	`181`	`}`
`182`	`182`
`183`	`183`	`$publicationAbstract = $publication->getData('abstract');`
`184`		`- $publicationKeywords = $publication->getData('keywords');`
	`184`	`+ $publicationKeywords = array_map(fn($items) => array_column($items, 'name'), (array) $publication->getData('keywords'));`
`185`	`185`
`186`	`186`	`$declineEmail = null;`
`187`	`187`	`if ($reviewAssignment->getDeclined()) {`
Original file line number	Diff line number	Diff line change
`@@ -167,8 +167,7 @@ protected function getVocabEntryData(string $symbolic): array`
`167`	`167`	`$symbolic,`
`168`	`168`	`Application::ASSOC_TYPE_PUBLICATION,`
`169`	`169`	`$this->publication->getId(),`
`170`		`- [],`
`171`		`- Repo::controlledVocab()::AS_ENTRY_DATA`
	`170`	`+ []`
`172`	`171`	`);`
`173`	`172`	`}`
`174`	`173`	`}`
Original file line number	Diff line number	Diff line change
`@@ -360,6 +360,8 @@ protected function deleteAuthors(int $publicationId)`
`360`	`360`	`*/`
`361`	`361`	`protected function setControlledVocab(Publication $publication)`
`362`	`362`	`{`
	`363`	`+ # f11557`
	`364`	`+ # These now return an object with all the data`
`363`	`365`	`$publication->setData(`
`364`	`366`	`'keywords',`
`365`	`367`	`Repo::controlledVocab()->getBySymbolic(`
Original file line number	Diff line number	Diff line change
`@@ -418,7 +418,6 @@ public function edit(Publication $publication, array $params): Publication`
`418`	`418`	`}`
`419`	`419`	`}`
`420`	`420`
`421`		`- $publication = Repo::controlledVocab()->hydrateVocabsAsEntryData($publication);`
`422`	`421`	`$newPublication = Repo::publication()->newDataObject(array_merge($publication->_data, $params));`
`423`	`422`	`$newPublication->stampModified();`
`424`	`423`
Original file line number	Diff line number	Diff line change
`@@ -104,7 +104,6 @@ public function summarizeMany(Enumerable $collection, bool $anonymize = false):`
`104`	`104`	`*/`
`105`	`105`	`protected function mapByProperties(array $props, Publication $publication, bool $anonymize): array`
`106`	`106`	`{`
`107`		`- $publication = Repo::controlledVocab()->hydrateVocabsAsEntryData($publication);`
`108`	`107`	`$this->anonymize = $anonymize;`
`109`	`108`
`110`	`109`	`$output = [];`