[FINNA-3708] Convert SolrQdc and SolrMarc to use finna-xml. (#3428)

The getFilteredXMLElement method required changes to be made also in SolrAipa and other classes, but the changes were kept minimal (to be changed in follow-ups).

Author: EreMaijala

composer.local.json

@@ -21,7 +21,7 @@
         "league/mime-type-detection": "1.9.0",
         "natlibfi/besimple-soap": "3.0.1",
         "natlibfi/finna-code-sets": "0.5.2",
-        "natlibfi/finna-xml": "1.2.0",
+        "natlibfi/finna-xml": "1.6.0",
         "natlibfi/php-html-parser": "4.0.1",
         "phpoffice/phpspreadsheet": "^2.0",
         "picqer/php-barcode-generator": "2.0.1",

composer.lock

@@ -33,8 +33,10 @@
 use Finna\RecordDriver\Feature\ContainerFormatTrait;
 use Finna\RecordDriver\Feature\EncapsulatedRecordInterface;
 use Finna\RecordDriver\Feature\EncapsulatedRecordTrait;
+use FinnaXml\XmlDoc;
 use NatLibFi\FinnaCodeSets\FinnaCodeSets;
 
+use function in_array;
 use function is_callable;
 
 /**
@@ -60,6 +62,23 @@ class AipaLrmi extends SolrLrmi implements
      */
     protected FinnaCodeSets $codeSets;
 
+    /**
+     * Fields filtered from the record by getFilteredXmlElement method.
+     *
+     * @var array
+     */
+    protected $filterFields = [
+        'abstract',
+        'description',
+        'assignmentIdeas',
+        'learningResource/studyObjectives',
+        'learningResource/educationalLevel/name',
+        'learningResource/educationalLevel/inDefinedTermSet/name',
+        'learningResource/educationalAlignment/educationalSubject/educationalFramework',
+        'learningResource/educationalAlignment/educationalSubject/targetName',
+        'learningResource/teaches/name',
+    ];
+
     /**
      * Attach Finna Code Sets library instance.
      *
@@ -267,7 +286,7 @@ public function getType(): string
      */
     protected function getEncapsulatedRecordElementTagName(): string
     {
-        return 'material';
+        return "{{$this->lrmiNs}}material";
     }
 
     /**
@@ -283,53 +302,40 @@ protected function getEncapsulatedRecordFormat($item): string
     }
 
     /**
-     * Return full record as a filtered SimpleXMLElement for public APIs.
+     * Return full record as a filtered XmlDoc for public APIs.
      *
-     * @return \SimpleXMLElement
+     * @return XmlDoc
      */
-    public function getFilteredXMLElement(): \SimpleXMLElement
+    public function getFilteredXmlElement(): XmlDoc
     {
-        $record = parent::getFilteredXMLElement();
-        $this->doFilterFields($record, ['abstract', 'description', 'assignmentIdeas']);
-        foreach ($record->learningResource as $learningResource) {
-            $this->doFilterFields($learningResource, ['studyObjectives']);
-            foreach ($learningResource->educationalLevel as $educationalLevel) {
-                $this->doFilterFields($educationalLevel, ['name']);
-                foreach ($educationalLevel->inDefinedTermSet as $inDefinedTermSet) {
-                    $this->doFilterFields($inDefinedTermSet, ['name']);
-                }
-            }
-            foreach ($learningResource->educationalAlignment as $educationalAlignment) {
-                foreach ($educationalAlignment->educationalSubject as $educationalSubject) {
-                    $this->doFilterFields(
-                        $educationalSubject,
-                        ['educationalFramework', 'targetName']
-                    );
-                }
-            }
-            foreach ($learningResource->teaches as $teaches) {
-                $this->doFilterFields($teaches, ['name']);
+        $record = parent::getFilteredXmlElement();
+        $record->filter(
+            function (array $node, string $path) use ($record): bool {
+                $path = implode(
+                    '/',
+                    array_map(
+                        [$record, 'localName'],
+                        explode('/', $path)
+                    )
+                );
+                return in_array($path, $this->filterFields);
             }
-        }
+        );
+
         return $this->filterEncapsulatedRecords($record);
     }
 
     /**
      * Helper method for filtering fields.
      *
-     * @param \SimpleXMLElement $baseElement  Base element
-     * @param array             $filterFields Fields to filter
+     * @param XmlDoc $xmlDoc       Document
+     * @param array  $filterFields Fields to filter (paths with local names of nodes)
      *
      * @return void
      */
     protected function doFilterFields(
-        \SimpleXMLElement $baseElement,
+        XmlDoc $xmlDoc,
         array $filterFields
     ): void {
-        foreach ($filterFields as $filterField) {
-            while ($baseElement->{$filterField}) {
-                unset($baseElement->{$filterField}[0]);
-            }
-        }
     }
 }

module/Finna/src/Finna/RecordDriver/AipaLrmi.php

@@ -34,6 +34,7 @@
 use Finna\RecordDriver\Feature\EncapsulatedRecordInterface;
 use Finna\RecordDriver\Feature\EncapsulatedRecordTrait;
 use Finna\RecordDriver\Feature\FinnaXmlReaderTrait;
+use FinnaXml\XmlDoc;
 use VuFind\RecordDriver\AbstractBase;
 use VuFindSearch\Response\RecordInterface;
 
@@ -147,17 +148,16 @@ public function getNotes(): string
     /**
      * Return full record as a filtered SimpleXMLElement for public APIs.
      *
-     * @return \SimpleXMLElement
+     * @return XmlDoc
      */
-    public function getFilteredXMLElement(): \SimpleXMLElement
+    public function getFilteredXMLElement(): XmlDoc
     {
-        $record = clone $this->getXmlRecord();
-        $filterFields = ['comment'];
-        foreach ($filterFields as $filterField) {
-            while ($record->{$filterField}) {
-                unset($record->{$filterField}[0]);
+        $record = clone $this->getXmlDoc();
+        $record->filter(
+            function (array $node) use ($record): bool {
+                return 'comment' === $record->localName($node);
             }
-        }
+        );
         // Only the URL of the single encapsulated record is in the XML record, so
         // there is no need to call filterEncapsulatedRecords().
         return $record;

module/Finna/src/Finna/RecordDriver/CuratedRecord.php

@@ -82,7 +82,7 @@ public function getAdditionalType(): string
      */
     protected function getEncapsulatedRecordElementTagName(): string
     {
-        return 'curatedRecord';
+        return "{{$this->aipaNs}}curatedRecord";
     }
 
     /**