diff --git a/CHANGELOG.md b/CHANGELOG.md
index 272f07f0..1afafbd1 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -6,6 +6,17 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+## 4.0.0 - TBD
+
+This release changes the XML handling in record classes to use the VuFindXml library. The storage format for XML records has changed, and while this version can read records written into RecordManager's database using older versions, older versions will not be able to read records written by this version.
+
+Anything marked with [**BC**] is known to affect backward compatibility with previous versions.
+
+### Changed
+
+- [**BC**] LIDO: XML handling changed to VuFindXml.
+
+
## 3.0.0 - 2026-06-09
**N.B. This version bumps the minimum PHP version to 8.2**
diff --git a/composer.json b/composer.json
index 13642f47..d1696444 100644
--- a/composer.json
+++ b/composer.json
@@ -47,6 +47,7 @@
"symfony/console": "6.4.25",
"symfony/lock": "6.4.37",
"vufind-org/vufind-marc": "1.2.0",
+ "vufind-org/vufind-xml": "1.7.0",
"wikimedia/composer-merge-plugin": "2.1.0"
},
"require-dev": {
diff --git a/composer.lock b/composer.lock
index 278531cb..3a5d13c1 100644
--- a/composer.lock
+++ b/composer.lock
@@ -4,7 +4,7 @@
"Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
"This file is @generated automatically"
],
- "content-hash": "40188dc680d8ee8a2113a4915d6fb4b6",
+ "content-hash": "a0e62823bfec27aebd48611e3b8640d5",
"packages": [
{
"name": "brick/varexporter",
@@ -3471,6 +3471,62 @@
},
"time": "2025-04-21T11:10:52+00:00"
},
+ {
+ "name": "vufind-org/vufind-xml",
+ "version": "1.7.0",
+ "source": {
+ "type": "git",
+ "url": "https://github.com/vufind-org/vufind-xml.git",
+ "reference": "c59fa9e8cfbd18c1869388a8b288c777e5297364"
+ },
+ "dist": {
+ "type": "zip",
+ "url": "https://api.github.com/repos/vufind-org/vufind-xml/zipball/c59fa9e8cfbd18c1869388a8b288c777e5297364",
+ "reference": "c59fa9e8cfbd18c1869388a8b288c777e5297364",
+ "shasum": ""
+ },
+ "require": {
+ "php": ">=8.2"
+ },
+ "require-dev": {
+ "friendsofphp/php-cs-fixer": "3.89.2",
+ "guzzlehttp/guzzle": "7.10.0",
+ "phing/phing": "3.1.2",
+ "phpmd/phpmd": "2.15.0",
+ "phpstan/phpstan": "2.1.32",
+ "phpunit/php-code-coverage": "^11",
+ "phpunit/phpunit": "11.5.50",
+ "rector/rector": "2.2.8",
+ "squizlabs/php_codesniffer": "4.0.1"
+ },
+ "type": "library",
+ "autoload": {
+ "psr-4": {
+ "VuFindXml\\": "src/VuFindXml"
+ }
+ },
+ "notification-url": "https://packagist.org/downloads/",
+ "license": [
+ "GPL-2.0-only"
+ ],
+ "authors": [
+ {
+ "name": "Ere Maijala",
+ "email": "ere.maijala@helsinki.fi"
+ }
+ ],
+ "description": "Yet another XML parser, reader and writer for diverse records with and without namespaces.",
+ "keywords": [
+ "dom",
+ "parser",
+ "xml"
+ ],
+ "support": {
+ "issues": "https://github.com/vufind-org/vufind-xml/issues",
+ "source": "https://github.com/vufind-org/vufind-xml/tree/v1.7.0"
+ },
+ "time": "2026-05-08T13:26:26+00:00"
+ },
{
"name": "vufind-org/vufindcode",
"version": "v1.2",
diff --git a/src/RecordManager/Base/Record/Lido.php b/src/RecordManager/Base/Record/Lido.php
index ff184b94..4fe10eff 100644
--- a/src/RecordManager/Base/Record/Lido.php
+++ b/src/RecordManager/Base/Record/Lido.php
@@ -5,7 +5,7 @@
*
* PHP version 8
*
- * Copyright (C) The National Library of Finland 2011-2025.
+ * Copyright (C) The National Library of Finland 2011-2026.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2,
@@ -29,7 +29,6 @@
namespace RecordManager\Base\Record;
-use DOMDocument;
use RecordManager\Base\Database\DatabaseInterface as Database;
use function in_array;
@@ -48,10 +47,17 @@
*/
class Lido extends AbstractRecord
{
- use XmlRecordTrait {
+ use XmlDocRecordTrait {
setData as xmlRecordSetData;
}
+ /**
+ * LIDO XML namespace.
+ *
+ * @var string
+ */
+ protected string $lidoNs = 'http://www.lido-schema.org';
+
/**
* Main event names reflecting the terminology in the particular LIDO records.
*
@@ -170,18 +176,32 @@ class Lido extends AbstractRecord
public function setData($source, $oaiID, $data, $extraData)
{
$this->xmlRecordSetData($source, $oaiID, $data, $extraData);
+ $this->xmlDoc->setDefaultNamespace($this->lidoNs, 'lido');
// Make sure we have a lidoWrap element as the root element as is also allowed in OAI-PMH:
- if ($this->doc->getName() === 'lido') {
- $schema = (string)($this->doc['schemaLocation']
- ?? 'http://www.lido-schema.org http://www.lido-schema.org/schema/v1.1/lido-v1.1.xsd');
- unset($this->doc['schemaLocation']);
- $doc = new DOMDocument(encoding: 'UTF-8');
- $lidoWrap = $doc->createElement('lidoWrap');
- $lidoWrap->setAttribute('schemaLocation', $schema);
- $lidoWrap->append($doc->importNode(dom_import_simplexml($this->doc), true));
- $doc->appendChild($lidoWrap);
- $this->doc = simplexml_import_dom($doc);
+ $rootName = $this->xmlDoc->name($this->xmlDoc->root(), true);
+ if (in_array($rootName, ['lido', '{}lido'])) {
+ $nodeArray = $this->xmlDoc->export();
+ $newRoot = $nodeArray;
+ $newRoot['data']['name'] = "{{$this->lidoNs}}lidoWrap";
+ $newRoot['data']['sub'] = [
+ $nodeArray['data'],
+ ];
+ // Detect any existing schemaLocation or use default:
+ $schemaLocation = $newRoot['data']['attrs']["{{$this->nsXsi}}schemaLocation"]
+ ?? $newRoot['data']['attrs']['schemaLocation']
+ ?? 'http://www.lido-schema.org http://www.lido-schema.org/schema/v1.1/lido-v1.1.xsd';
+ // Remove schemaLocation from lido element:
+ unset($newRoot['data']['sub'][0]['attrs']['schemaLocation']);
+ unset($newRoot['data']['sub'][0]['attrs']["{{$this->nsXsi}}schemaLocation"]);
+ // Verify that the root element has correct schemaLocation:
+ unset($newRoot['data']['attrs']['schemaLocation']);
+ $newRoot['data']['attrs']["{{$this->nsXsi}}schemaLocation"] = $schemaLocation;
+ if (!in_array($this->nsXsi, $newRoot['namespaces'])) {
+ $newRoot['namespaces]']['xsi'] = $this->nsXmlns;
+ }
+ $newRoot['namespaces']['lido'] ??= $this->lidoNs;
+ $this->xmlDoc->import($newRoot);
}
}
@@ -192,7 +212,7 @@ public function setData($source, $oaiID, $data, $extraData)
*/
public function getID()
{
- return (string)$this->doc->lido->lidoRecID;
+ return $this->xmlDoc->firstValue(path: 'lido/lidoRecID') ?? '';
}
/**
@@ -225,22 +245,19 @@ public function getLocations()
$locations = [];
foreach ([$this->getMainEvents(), $this->getPlaceEvents()] as $event) {
foreach ($this->getEventNodes($event) as $eventNode) {
- foreach ($eventNode->eventPlace as $placeNode) {
+ foreach ($this->xmlDoc->all($eventNode, 'eventPlace') as $placeNode) {
// If there is already gml in the record,
// don't return anything for geocoding
- if (!empty($placeNode->gml)) {
+ if ($this->xmlDoc->first($placeNode, 'gml')) {
return [];
}
- $hasValue = !empty(
- $placeNode->place->namePlaceSet->appellationValue
- );
- if ($hasValue) {
- $mainPlace = (string)$placeNode->place->namePlaceSet
- ->appellationValue;
- $subLocation = $this->getSubLocation(
- $placeNode->place
- );
- if ($mainPlace && !$subLocation) {
+ $appellationValue
+ = $this->xmlDoc->firstValue($placeNode, 'place/namePlaceSet/appellationValue') ?? '';
+ if ('' !== $appellationValue) {
+ $mainPlace = $appellationValue;
+ $subPlaceNode = $this->xmlDoc->first($placeNode, 'place');
+ $subLocation = $subPlaceNode ? $this->getSubLocation($subPlaceNode) : '';
+ if (!$subLocation) {
$locations = [
...$locations,
...explode('/', $mainPlace),
@@ -248,13 +265,13 @@ public function getLocations()
} else {
$locations[] = "$mainPlace $subLocation";
}
- } elseif (!empty($placeNode->displayPlace)) {
+ } elseif ($displayPlace = $this->xmlDoc->firstValue($placeNode, 'displayPlace')) {
// Split multiple locations separated with a slash
$locations = [
...$locations,
...preg_split(
'/[\/;]/',
- (string)$placeNode->displayPlace
+ $displayPlace
) ?: [],
];
}
@@ -474,17 +491,12 @@ protected function getRecordFormat(): string
protected function getTopicIDs($exclude = ['iconclass']): array
{
$result = [];
- foreach ($this->getSubjectNodes($exclude) as $subject) {
- foreach ($subject->subjectConcept as $concept) {
- foreach ($concept->conceptID as $conceptID) {
- if ($id = trim((string)$conceptID)) {
- $type = mb_strtolower(
- (string)($conceptID['type'] ?? ''),
- 'UTF-8'
- );
- if (in_array($type, $this->subjectConceptIDTypes)) {
- $result[] = $id;
- }
+ foreach ($this->getSubjectNodes($exclude) as $subjectNode) {
+ foreach ($this->xmlDoc->all($subjectNode, 'subjectConcept/conceptID') as $conceptID) {
+ if ($id = $this->xmlDoc->value($conceptID)) {
+ $type = mb_strtolower($this->xmlDoc->attr($conceptID, 'type'), 'UTF-8');
+ if (in_array($type, $this->subjectConceptIDTypes)) {
+ $result[] = $id;
}
}
}
@@ -495,16 +507,16 @@ protected function getTopicIDs($exclude = ['iconclass']): array
/**
* Return record titles
*
- * @param ?string $language Only include titles in specific language (for downstream usage)
+ * @param ?string $languageFilter Only include titles in specific language (for downstream usage)
*
* @return array Associative array with keys 'preferred' (string) and
* 'alternate' (array)
*/
- protected function getTitles(?string $language = null)
+ protected function getTitles(?string $languageFilter = null)
{
$key = __METHOD__ . '/'
. implode(';', $this->descriptionTypesExcludedFromTitle)
- . ($language ?? '');
+ . ($languageFilter ?? '');
if (isset($this->resultCache[$key])) {
return $this->resultCache[$key];
}
@@ -513,42 +525,43 @@ protected function getTitles(?string $language = null)
$formatInTitle = $this->getDriverParam('allowTitleToMatchFormat', false);
$preferredTitles = [];
$alternateTitles = [];
- $defaultLanguage = $language ? $language : $this->getDefaultLanguage();
- foreach (
- $this->doc->lido->descriptiveMetadata->objectIdentificationWrap
- ->titleWrap->titleSet ?? [] as $set
- ) {
- $preferredParts = [];
- $alternateParts = [];
- foreach ($set->appellationValue as $appellationValue) {
- if (!($title = trim((string)$appellationValue))) {
- continue;
- }
- $titleLang =
- $this->metadataUtils->normalizeLanguageCode(
- $this->getInheritedXmlAttribute($appellationValue, 'lang')
+ // If language filter is specified, use it as the default language for further processing below the following
+ // loop:
+ $defaultLanguage = $languageFilter ? $languageFilter : $this->getDefaultLanguage();
+ foreach ($this->xmlDoc->all(path: 'lido/descriptiveMetadata') as $descriptiveMetadata) {
+ $metadataLanguage = $this->getLangAttr($descriptiveMetadata);
+ foreach ($this->xmlDoc->all($descriptiveMetadata, 'objectIdentificationWrap/titleWrap/titleSet') as $set) {
+ $preferredParts = [];
+ $alternateParts = [];
+ foreach ($this->xmlDoc->all($set, 'appellationValue') as $appellationValue) {
+ if ('' === ($title = $this->xmlDoc->value($appellationValue))) {
+ continue;
+ }
+ $titleLang = $this->metadataUtils->normalizeLanguageCode(
+ $this->getLangAttr($appellationValue) ?? $metadataLanguage ?? ''
);
- if ($language && $titleLang !== $language) {
- continue;
+ if ($languageFilter && $titleLang !== $languageFilter) {
+ continue;
+ }
+ $titleLang = $titleLang ?: $defaultLanguage;
+ $preference = mb_strtolower($this->xmlDoc->attr($appellationValue, 'pref') ?? 'preferred', 'UTF-8');
+ if (in_array($preference, $this->preferredTitleTypes)) {
+ $preferredParts[$titleLang][] = $title;
+ } else {
+ $alternateParts[$titleLang][] = $title;
+ }
}
- $titleLang = $titleLang ?: $defaultLanguage;
- $preference = mb_strtolower((string)($appellationValue->attributes()->pref ?? 'preferred'), 'UTF-8');
- if (in_array($preference, $this->preferredTitleTypes)) {
- $preferredParts[$titleLang][] = $title;
- } else {
- $alternateParts[$titleLang][] = $title;
+ foreach ($preferredParts as $lang => $parts) {
+ // Merge repeated parts in a single titleSet if configured:
+ if ($mergeValues && isset($alternateParts[$lang])) {
+ $parts = [...$parts, ...$alternateParts[$lang]];
+ unset($alternateParts[$lang]);
+ }
+ $preferredTitles[$lang][] = implode('; ', $parts);
}
- }
- foreach ($preferredParts as $lang => $parts) {
- // Merge repeated parts in a single titleSet if configured:
- if ($mergeValues && isset($alternateParts[$lang])) {
- $parts = [...$parts, ...$alternateParts[$lang]];
- unset($alternateParts[$lang]);
+ foreach ($alternateParts as $lang => $parts) {
+ $alternateTitles[$lang][] = implode('; ', $parts);
}
- $preferredTitles[$lang][] = implode('; ', $parts);
- }
- foreach ($alternateParts as $lang => $parts) {
- $alternateTitles[$lang][] = implode('; ', $parts);
}
}
@@ -599,19 +612,21 @@ protected function getTitles(?string $language = null)
$workType = $this->getObjectWorkType();
if (!$formatInTitle && strcasecmp($workType, $preferred) == 0) {
$descriptionWrapDescriptions = [];
- $nodes = $this->getObjectDescriptionSetNodes(
- $this->descriptionTypesExcludedFromTitle
- );
+ $nodes = $this->getObjectDescriptionSetNodes($this->descriptionTypesExcludedFromTitle);
foreach ($nodes as $set) {
- if ($value = trim((string)($set->descriptiveNoteValue ?? ''))) {
- if (
- $language === null
- || $language === $this->metadataUtils->normalizeLanguageCode(
- $set->descriptiveNoteValue->attributes()->lang ?? ''
- )
- ) {
- $descriptionWrapDescriptions[] = $value;
- }
+ if (!($descriptiveNoteValue = $this->xmlDoc->first($set, 'descriptiveNoteValue'))) {
+ continue;
+ }
+ if ('' === ($value = $this->xmlDoc->value($descriptiveNoteValue))) {
+ continue;
+ }
+ if (
+ $languageFilter === null
+ || $languageFilter === $this->metadataUtils->normalizeLanguageCode(
+ $this->getLangAttr($descriptiveNoteValue) ?? ''
+ )
+ ) {
+ $descriptionWrapDescriptions[] = $value;
}
}
if ($descriptionWrapDescriptions) {
@@ -622,38 +637,6 @@ protected function getTitles(?string $language = null)
return $this->resultCache[$key] = compact('preferred', 'alternate');
}
- /**
- * Get an attribute for the node from the node itself or its nearest ancestor
- *
- * @param \SimpleXMLElement $node Node
- * @param string $attribute Attribute to get
- * @param string $default Default value for the attribute
- * @param int $levels How many levels up to traverse
- *
- * @return string
- *
- * @psalm-suppress RedundantCondition
- */
- protected function getInheritedXmlAttribute(
- \SimpleXMLElement $node,
- string $attribute,
- string $default = '',
- int $levels = 255
- ): string {
- if (null !== ($value = $node[$attribute])) {
- return (string)$value;
- }
- $domNode = dom_import_simplexml($node);
- while (($domNode->parentNode instanceof \DOMElement) && --$levels >= 0) {
- $domNode = $domNode->parentNode;
- if ($domNode->hasAttribute($attribute)) {
- $value = $domNode->getAttribute($attribute);
- break;
- }
- }
- return null === $value ? $default : $value;
- }
-
/**
* Get alternate titles
*
@@ -668,21 +651,21 @@ protected function getAltTitles()
/**
* Get the last sublocation (partOfPlace) of a place
*
- * @param \SimpleXMLElement $place Place element
- * @param bool $isSub Is the current $place a sublocation
+ * @param array $place Place node
+ * @param bool $isSub Is the current $place a sublocation
*
* @return string
*/
- protected function getSubLocation($place, $isSub = false)
+ protected function getSubLocation(array $place, bool $isSub = false): string
{
- if (!empty($place->partOfPlace)) {
- $result = $this->getSubLocation($place->partOfPlace, true);
- if (!empty($result)) {
+ if ($partOfPlaceNode = $this->xmlDoc->first($place, 'partOfPlace')) {
+ if ('' !== ($result = $this->getSubLocation($partOfPlaceNode, true))) {
return $result;
}
}
- return $isSub && isset($place->namePlaceSet->appellationValue)
- ? (string)$place->namePlaceSet->appellationValue : '';
+ return $isSub
+ ? ($this->xmlDoc->firstValue($place, 'namePlaceSet/appellationValue') ?? '')
+ : '';
}
/**
@@ -704,19 +687,15 @@ protected function getInstitution(): string
*/
protected function getLegalBodyName()
{
- foreach (
- $this->doc->lido->descriptiveMetadata->objectIdentificationWrap
- ->repositoryWrap->repositorySet ?? [] as $set
- ) {
- if (!empty($set->repositoryName->legalBodyName->appellationValue)) {
- return (string)$set->repositoryName->legalBodyName
- ->appellationValue;
- }
- }
-
- foreach ($this->doc->lido->administrativeMetadata->recordWrap->recordSource ?? [] as $source) {
- if (!empty($source->legalBodyName->appellationValue)) {
- return (string)$source->legalBodyName->appellationValue;
+ $paths = [
+ 'lido/descriptiveMetadata/objectIdentificationWrap/repositoryWrap/repositorySet/repositoryName'
+ . '/legalBodyName/appellationValue',
+ 'lido/administrativeMetadata/recordWrap/recordSource/legalBodyName/appellationValue',
+ ];
+ foreach ($paths as $path) {
+ // Return first non-empty value:
+ foreach ($this->xmlDoc->allValues(path: $path) as $name) {
+ return $name;
}
}
@@ -732,15 +711,9 @@ protected function getLegalBodyName()
*/
protected function getDescription()
{
- $description = [];
- foreach (
- $this->doc->lido->descriptiveMetadata->objectIdentificationWrap
- ->objectDescriptionWrap->objectDescriptionSet ?? [] as $set
- ) {
- foreach ($set->descriptiveNoteValue as $descriptiveNoteValue) {
- $description[] = trim((string)$descriptiveNoteValue);
- }
- }
+ $path = 'lido/descriptiveMetadata/objectIdentificationWrap/objectDescriptionWrap/objectDescriptionSet'
+ . '/descriptiveNoteValue';
+ $description = $this->xmlDoc->allValues(path: $path);
if ($this->getTitle() == implode('; ', $description)) {
// We have the description already in the title, don't repeat
@@ -759,13 +732,10 @@ protected function getDescription()
*/
protected function getObjectWorkType()
{
- foreach (
- $this->doc->lido->descriptiveMetadata->objectClassificationWrap
- ->objectWorkTypeWrap->objectWorkType ?? [] as $type
- ) {
- if (!empty($type->term)) {
- return (string)$type->term;
- }
+ $path = 'lido/descriptiveMetadata/objectClassificationWrap/objectWorkTypeWrap/objectWorkType/term';
+ // Return the first non-empty value (different from first value):
+ foreach ($this->xmlDoc->allValues(path: $path) as $value) {
+ return $value;
}
return '';
}
@@ -777,56 +747,40 @@ protected function getObjectWorkType()
*/
protected function getUrls()
{
- $results = [];
- foreach ($this->getResourceSetNodes() as $set) {
- foreach ($set->resourceRepresentation as $node) {
- if (!empty($node->linkResource)) {
- $link = trim((string)$node->linkResource);
- if (!empty($link)) {
- $results[] = $link;
- }
- }
- }
- }
- return $results;
+ $path = 'lido/administrativeMetadata/resourceWrap/resourceSet/resourceRepresentation/linkResource';
+ return $this->xmlDoc->allValues(path: $path);
}
/**
* Return names of actors associated with specified event
*
* @param string|array|null $event Event type(s) allowed (null = all types)
- * @param string|array|null $role Roles allowed (null = all roles)
+ * @param string|array|null $rolesAllowed Roles allowed (null = all roles)
* @param bool $includeRoles Whether to include actor roles in the results
*
* @return array
*/
- protected function getActors($event = null, $role = null, $includeRoles = false)
+ protected function getActors($event = null, $rolesAllowed = null, $includeRoles = false)
{
$key = md5(__METHOD__ . ($event ? implode(',', (array)$event) : 'null') . '|'
- . ($role ? implode(',', (array)$role) : 'null') . '|' . ($includeRoles ? '1' : '0'));
+ . ($rolesAllowed ? implode(',', (array)$rolesAllowed) : 'null') . '|' . ($includeRoles ? '1' : '0'));
if (isset($this->resultCache[$key])) {
return $this->resultCache[$key];
}
$result = [];
foreach ($this->getEventNodes($event) as $eventNode) {
- foreach ($eventNode->eventActor as $actorNode) {
- foreach ($actorNode->actorInRole as $roleNode) {
- if (isset($roleNode->actor->nameActorSet->appellationValue)) {
- $actorRole = $this->metadataUtils->normalizeRelator(
- (string)$roleNode->roleActor->term
- );
- if (empty($role) || in_array($actorRole, (array)$role)) {
- $value = (string)$roleNode->actor->nameActorSet
- ->appellationValue[0];
- $value = trim($value);
- if ($value) {
- if ($includeRoles && $actorRole) {
- $value .= ", $actorRole";
- }
- $result[] = $value;
- }
+ foreach ($this->xmlDoc->all($eventNode, 'eventActor/actorInRole') as $roleNode) {
+ $appellationValue = $this->xmlDoc->firstValue($roleNode, 'actor/nameActorSet/appellationValue') ?? '';
+ if ('' !== $appellationValue) {
+ $actorRole = $this->metadataUtils->normalizeRelator(
+ $this->xmlDoc->firstValue($roleNode, 'roleActor/term')
+ );
+ if (empty($rolesAllowed) || in_array($actorRole, (array)$rolesAllowed)) {
+ if ($includeRoles && $actorRole) {
+ $appellationValue .= ", $actorRole";
}
+ $result[] = $appellationValue;
}
}
}
@@ -846,18 +800,13 @@ protected function getEventDisplayPlaces($event = null)
{
$results = [];
foreach ($this->getEventNodes($event) as $eventNode) {
- foreach ($eventNode->eventPlace as $placeNode) {
- if (!empty($placeNode->displayPlace)) {
- $str = trim(
- $this->metadataUtils->stripTrailingPunctuation(
- (string)$placeNode->displayPlace,
- '.'
- ),
- ', \n\r\t\v\0'
- );
- if ($str) {
- $results[] = $str;
- }
+ foreach ($this->xmlDoc->allValues($eventNode, 'eventPlace/displayPlace') as $displayPlace) {
+ $displayPlace = trim(
+ $this->metadataUtils->stripTrailingPunctuation($displayPlace, '.'),
+ ', \n\r\t\v\0'
+ );
+ if ('' !== $displayPlace) {
+ $results[] = $displayPlace;
}
}
}
@@ -874,11 +823,8 @@ protected function getEventDisplayPlaces($event = null)
protected function getEventDisplayDate($event = null)
{
foreach ($this->getEventNodes($event) as $eventNode) {
- if (!empty($eventNode->eventDate->displayDate)) {
- $str = trim((string)$eventNode->eventDate->displayDate);
- if ('' !== $str) {
- return $str;
- }
+ if ('' !== ($displayDate = $this->xmlDoc->firstValue($eventNode, 'eventDate/displayDate') ?? '')) {
+ return $displayDate;
}
}
return '';
@@ -894,8 +840,8 @@ protected function getEventDisplayDate($event = null)
protected function getRelatedWorkDisplayObject($relatedWorkRelType)
{
foreach ($this->getRelatedWorkSetNodes($relatedWorkRelType) as $set) {
- if (!empty($set->relatedWork->displayObject)) {
- return trim((string)$set->relatedWork->displayObject);
+ if ('' !== ($value = $this->xmlDoc->firstValue($set, 'relatedWork/displayObject') ?? '')) {
+ return $value;
}
}
return '';
@@ -910,9 +856,9 @@ protected function getRelatedWorkDisplayObject($relatedWorkRelType)
protected function getLanguage()
{
$results = [];
- foreach ($this->doc->descriptiveMetadata ?? [] as $node) {
- if (!empty($node['lang'])) {
- $results[] = (string)$node['lang'];
+ foreach ($this->xmlDoc->all(path: 'descriptiveMetadata') as $node) {
+ if ($lang = $this->getLangAttr($node)) {
+ $results[] = $lang;
}
}
return $results;
@@ -932,13 +878,10 @@ protected function getLanguage()
protected function getSubjectTerms($exclude = ['iconclass'])
{
$results = [];
- foreach ($this->getSubjectNodes($exclude) as $subject) {
- foreach ($subject->subjectConcept as $concept) {
- foreach ($concept->term as $term) {
- $str = trim((string)$term);
- if ($str !== '') {
- $results[] = $str;
- }
+ foreach ($this->getSubjectNodes($exclude) as $subjectNode) {
+ foreach ($this->xmlDoc->allValues($subjectNode, 'subjectConcept/term') as $term) {
+ if ('' !== $term) {
+ $results[] = $term;
}
}
}
@@ -953,18 +896,11 @@ protected function getSubjectTerms($exclude = ['iconclass'])
protected function getSubjectDisplayDates()
{
$results = [];
- foreach ($this->getSubjectNodes() as $subject) {
- foreach ($subject->subjectDate as $date) {
- if (!empty($date->displayDate)) {
- $str = trim(
- $this->metadataUtils->stripTrailingPunctuation(
- (string)$date->displayDate,
- '.'
- )
- );
- if ('' !== $str) {
- $results[] = $str;
- }
+ foreach ($this->getSubjectNodes() as $subjectNode) {
+ foreach ($this->xmlDoc->allValues($subjectNode, 'subjectDate/displayDate') as $date) {
+ $date = $this->metadataUtils->stripTrailingPunctuation($date, '.');
+ if ('' !== $date) {
+ $results[] = $date;
}
}
}
@@ -979,19 +915,14 @@ protected function getSubjectDisplayDates()
protected function getSubjectDisplayPlaces()
{
$results = [];
- foreach ($this->getSubjectNodes() as $subject) {
- foreach ($subject->subjectPlace as $place) {
- if (!empty($place->displayPlace)) {
- $str = trim(
- $this->metadataUtils->stripTrailingPunctuation(
- (string)$place->displayPlace,
- '.'
- ),
- ', \n\r\t\v\0'
- );
- if ('' !== $str) {
- $results[] = $str;
- }
+ foreach ($this->getSubjectNodes() as $subjectNode) {
+ foreach ($this->xmlDoc->allValues($subjectNode, 'subjectPlace/displayPlace') as $place) {
+ $place = trim(
+ $this->metadataUtils->stripTrailingPunctuation($place, '.'),
+ ', \n\r\t\v\0'
+ );
+ if ('' !== $place) {
+ $results[] = $place;
}
}
}
@@ -1006,22 +937,15 @@ protected function getSubjectDisplayPlaces()
protected function getSubjectPlaces()
{
$results = [];
- foreach ($this->getSubjectNodes() as $subject) {
- foreach ($subject->subjectPlace as $place) {
- if (!empty($place->place->namePlaceSet)) {
- foreach ($place->place->namePlaceSet as $set) {
- if ($set->appellationValue) {
- $str = trim(
- $this->metadataUtils->stripTrailingPunctuation(
- (string)$set->appellationValue,
- '.'
- )
- );
- if ('' !== $str) {
- $results[] = $str;
- }
- }
- }
+ foreach ($this->getSubjectNodes() as $subjectNode) {
+ foreach (
+ $this->xmlDoc->allValues($subjectNode, 'subjectPlace/place/namePlaceSet/appellationValue') as $value
+ ) {
+ $value = trim(
+ $this->metadataUtils->stripTrailingPunctuation($value, '.')
+ );
+ if ('' !== $value) {
+ $results[] = $value;
}
}
}
@@ -1043,17 +967,15 @@ protected function getEventMaterials($eventType)
$results = [];
$displayTerms = [];
foreach ($this->getEventNodes($eventType) as $event) {
- foreach ($event->eventMaterialsTech as $eventMaterialsTech) {
- foreach ($eventMaterialsTech->displayMaterialsTech as $displayMaterialsTech) {
- $displayTerms[] = trim((string)$displayMaterialsTech);
- }
- foreach ($eventMaterialsTech->materialsTech as $materialsTech) {
- foreach ($materialsTech->termMaterialsTech as $termMaterialsTech) {
- foreach ($termMaterialsTech->term as $term) {
- $results[] = (string)$term;
- }
- }
- }
+ foreach ($this->xmlDoc->all($event, 'eventMaterialsTech') as $eventMaterialsTech) {
+ $displayTerms = [
+ ...$displayTerms,
+ ...$this->xmlDoc->allValues($eventMaterialsTech, 'displayMaterialsTech'),
+ ];
+ $results = [
+ ...$results,
+ ...$this->xmlDoc->allValues($eventMaterialsTech, 'materialsTech/termMaterialsTech/term'),
+ ];
}
}
return $results ? $results : $displayTerms;
@@ -1064,26 +986,24 @@ protected function getEventMaterials($eventType)
*
* A recursive method for fetching all relevant fields
*
- * @param ?\SimpleXMLElement $xml XML fragment to process, or null to process whole document
+ * @param ?array $parentNode Parent node to process, or null to process the root node
*
* @return array
*/
- protected function getAllFields($xml = null)
+ protected function getAllFields(?array $parentNode = null)
{
- $xml ??= $this->doc;
$allFields = [];
- foreach ($xml->children() as $tag => $field) {
- if (in_array($tag, $this->excludeFromAllFields)) {
+ foreach ($this->xmlDoc->all($parentNode) as $node) {
+ if (in_array($this->xmlDoc->localName($node), $this->excludeFromAllFields)) {
continue;
}
- $s = trim((string)$field);
- if ($s) {
+ if ('' !== ($s = $this->xmlDoc->value($node))) {
$allFields[] = $s;
}
- $s = $this->getAllFields($field);
- if ($s) {
- $allFields = [...$allFields, ...$s];
- }
+ $allFields = [
+ ...$allFields,
+ ...$this->getAllFields($node),
+ ];
}
return $allFields;
}
@@ -1103,38 +1023,37 @@ protected function getDefaultLanguage()
*
* @param string|array $events Event type(s) allowed (null = all types)
*
- * @return \SimpleXMLElement[] Array of event nodes
+ * @return array Array of event nodes
*/
- protected function getEventNodes($events = null)
+ protected function getEventNodes($events = null): array
{
if (is_string($events)) {
$events = [$events => 0];
}
$eventList = [];
$index = 0;
- foreach ($this->doc->lido->descriptiveMetadata->eventWrap->eventSet ?? [] as $eventSetNode) {
- foreach ($eventSetNode->event as $eventNode) {
- if (null !== $events) {
- $eventTypes = [];
- if (!empty($eventNode->eventType->term)) {
- foreach ($eventNode->eventType->term as $term) {
- $eventTypes[] = mb_strtolower((string)$term, 'UTF-8');
- }
- }
- $priority = null;
- foreach ($eventTypes as $eventType) {
- if (isset($events[$eventType])) {
- $priority = $events[$eventType];
- break;
- }
+ $path = 'lido/descriptiveMetadata/eventWrap/eventSet/event';
+ foreach ($this->xmlDoc->all(path: $path) as $eventNode) {
+ if (null !== $events) {
+ $eventTypes = [];
+ foreach ($this->xmlDoc->allValues($eventNode, 'eventType/term') as $term) {
+ if ('' !== $term) {
+ $eventTypes[] = mb_strtolower($term, 'UTF-8');
}
- if (null !== $priority) {
- ++$index;
- $eventList["$priority/$index"] = $eventNode;
+ }
+ $priority = null;
+ foreach ($eventTypes as $eventType) {
+ if (isset($events[$eventType])) {
+ $priority = $events[$eventType];
+ break;
}
- } else {
- $eventList[] = $eventNode;
}
+ if (null !== $priority) {
+ ++$index;
+ $eventList["$priority/$index"] = $eventNode;
+ }
+ } else {
+ $eventList[] = $eventNode;
}
}
ksort($eventList);
@@ -1142,44 +1061,24 @@ protected function getEventNodes($events = null)
}
/**
- * Get all subject sets
- *
- * @return array Array of subjectSet nodes
- */
- protected function getSubjectSetNodes()
- {
- $setList = [];
- foreach (
- $this->doc->lido->descriptiveMetadata->objectRelationWrap
- ->subjectWrap->subjectSet ?? [] as $subjectSetNode
- ) {
- $setList[] = $subjectSetNode;
- }
- return $setList;
- }
-
- /**
- * Get all subjects
+ * Get all subject nodes
*
* @param string|string[] $exclude Which subject types to exclude
*
* @return array Array of subjectSet nodes
*/
- protected function getSubjectNodes($exclude = [])
+ protected function getSubjectNodes($exclude = []): array
{
$subjectList = [];
- foreach ($this->getSubjectSetNodes() as $subjectSetNode) {
- foreach ($subjectSetNode->subject as $subjectNode) {
- if (
- empty($exclude)
- || empty($subjectNode['type'])
- || !in_array(
- mb_strtolower($subjectNode['type'], 'UTF-8'),
- $exclude
- )
- ) {
- $subjectList[] = $subjectNode;
- }
+ $path = 'lido/descriptiveMetadata/objectRelationWrap/subjectWrap/subjectSet/subject';
+ foreach ($this->xmlDoc->all(path: $path) as $subjectNode) {
+ $type = $this->xmlDoc->attr($subjectNode, 'type');
+ if (
+ empty($exclude)
+ || empty($type)
+ || !in_array(mb_strtolower($type, 'UTF-8'), $exclude)
+ ) {
+ $subjectList[] = $subjectNode;
}
}
return $subjectList;
@@ -1195,17 +1094,13 @@ protected function getSubjectNodes($exclude = [])
protected function getObjectDescriptionSetNodes($exclude = [])
{
$setList = [];
- foreach (
- $this->doc->lido->descriptiveMetadata->objectIdentificationWrap
- ->objectDescriptionWrap->objectDescriptionSet ?? [] as $objectSetNode
- ) {
+ $path = 'lido/descriptiveMetadata/objectIdentificationWrap/objectDescriptionWrap/objectDescriptionSet';
+ foreach ($this->xmlDoc->all(path: $path) as $objectSetNode) {
+ $type = $this->xmlDoc->attr($objectSetNode, 'type') ?? '';
if (
- empty($exclude)
- || empty($objectSetNode['type'])
- || !in_array(
- mb_strtolower($objectSetNode['type'], 'UTF-8'),
- $exclude
- )
+ !$exclude
+ || '' === $type
+ || !in_array(mb_strtolower($type, 'UTF-8'), $exclude)
) {
$setList[] = $objectSetNode;
}
@@ -1220,23 +1115,16 @@ protected function getObjectDescriptionSetNodes($exclude = [])
*
* @return array Array of relatedWorkSet nodes
*/
- protected function getRelatedWorkSetNodes($relatedWorkRelType = [])
+ protected function getRelatedWorkSetNodes(array $relatedWorkRelType = []): array
{
$setList = [];
- foreach (
- $this->doc->lido->descriptiveMetadata->objectRelationWrap
- ->relatedWorksWrap->relatedWorkSet ?? [] as $relatedWorkSetNode
- ) {
- $relType = trim(
- mb_strtolower(
- $relatedWorkSetNode->relatedWorkRelType->term ?? '',
- 'UTF-8'
- )
+ $path = 'lido/descriptiveMetadata/objectRelationWrap/relatedWorksWrap/relatedWorkSet';
+ foreach ($this->xmlDoc->all(path: $path) as $relatedWorkSetNode) {
+ $relType = mb_strtolower(
+ $this->xmlDoc->firstValue($relatedWorkSetNode, 'relatedWorkRelType/term'),
+ 'UTF-8'
);
- if (
- empty($relatedWorkRelType)
- || in_array($relType, $relatedWorkRelType)
- ) {
+ if (!$relatedWorkRelType || in_array($relType, $relatedWorkRelType)) {
$setList[] = $relatedWorkSetNode;
}
}
@@ -1246,15 +1134,11 @@ protected function getRelatedWorkSetNodes($relatedWorkRelType = [])
/**
* Get resource sets
*
- * @return \SimpleXMLElement[] Array of resourceSet nodes
+ * @return array Array of resourceSet nodes
*/
- protected function getResourceSetNodes()
+ protected function getResourceSetNodes(): array
{
- $setList = [];
- foreach ($this->doc->lido->administrativeMetadata->resourceWrap->resourceSet ?? [] as $resourceSetNode) {
- $setList[] = $resourceSetNode;
- }
- return $setList;
+ return $this->xmlDoc->all(path: 'lido/administrativeMetadata/resourceWrap/resourceSet');
}
/**
@@ -1265,14 +1149,10 @@ protected function getResourceSetNodes()
protected function getControlNumbers()
{
$ids = [];
- foreach ($this->doc->lido->administrativeMetadata->recordWrap->recordInfoSet ?? [] as $set) {
- if (isset($set->recordInfoID)) {
- $info = $set->recordInfoID;
- $attributes = $info->attributes();
- if (isset($attributes->type)) {
- $type = (string)$attributes->type;
- $ids[] = "($type)" . (string)$info;
- }
+ $path = 'lido/administrativeMetadata/recordWrap/recordInfoSet/recordInfoID';
+ foreach ($this->xmlDoc->all(path: $path) as $recordInfoID) {
+ if (null !== ($type = $this->xmlDoc->attr($recordInfoID, 'type'))) {
+ $ids[] = "($type)" . $this->xmlDoc->value($recordInfoID);
}
}
return $ids;
@@ -1291,20 +1171,17 @@ protected function getIdentifiersByType(
array $exclude = []
): array {
$result = [];
- foreach ($this->doc->lido->descriptiveMetadata as $dmd) {
- foreach ($dmd->objectIdentificationWrap->repositoryWrap->repositorySet ?? [] as $set) {
- foreach ($set->workID as $workId) {
- $type = trim($workId['type'] ?? '');
- if ($include && !in_array($type, $include)) {
- continue;
- }
- if ($type && $exclude && !in_array($type, $include)) {
- continue;
- }
- if ($identifier = trim($workId)) {
- $result[] = $identifier;
- }
- }
+ $path = 'lido/descriptiveMetadata/objectIdentificationWrap/repositoryWrap/repositorySet/workID';
+ foreach ($this->xmlDoc->all(path: $path) as $workId) {
+ $type = $this->xmlDoc->attr($workId, 'type');
+ if ($include && !in_array($type, $include)) {
+ continue;
+ }
+ if ($type && $exclude && !in_array($type, $include)) {
+ continue;
+ }
+ if ('' !== ($identifier = $this->xmlDoc->value($workId))) {
+ $result[] = $identifier;
}
}
return $result;
@@ -1318,39 +1195,35 @@ protected function getIdentifiersByType(
protected function getRepositoryLocations(): array
{
$result = [];
- foreach (
- $this->doc->lido->descriptiveMetadata->objectIdentificationWrap->repositoryWrap->repositorySet
- ?? [] as $set
- ) {
- $type = mb_strtolower((string)($set->attributes()->type ?? ''), 'UTF-8');
- if ($this->repositoryLocationTypes && !in_array($type, $this->repositoryLocationTypes)) {
- continue;
+ $path = 'lido/descriptiveMetadata/objectIdentificationWrap/repositoryWrap/repositorySet';
+ foreach ($this->xmlDoc->all(path: $path) as $set) {
+ if ($this->repositoryLocationTypes) {
+ $type = mb_strtolower($this->xmlDoc->attr($set, 'type') ?? '', 'UTF-8');
+ if (!in_array($type, $this->repositoryLocationTypes)) {
+ continue;
+ }
}
- foreach ($set->repositoryLocation->namePlaceSet ?? [] as $nameSet) {
- foreach ($nameSet->appellationValue ?? [] as $place) {
- if (
- $place
- && !in_array((string)$place->attributes()->label, $this->excludedLocationAppellationValueLabels)
- ) {
- $result[] = trim((string)$place);
- }
+ foreach ($this->xmlDoc->all($set, 'repositoryLocation/namePlaceSet/appellationValue') as $place) {
+ if (
+ '' !== ($value = $this->xmlDoc->value($place))
+ && !in_array($this->xmlDoc->attr($place, 'label'), $this->excludedLocationAppellationValueLabels)
+ ) {
+ $result[] = $value;
}
}
- foreach ($set->repositoryLocation ?? [] as $location) {
- foreach ($location->partOfPlace ?? [] as $part) {
- while ($part->namePlaceSet) {
- if ($partName = $part->namePlaceSet->appellationValue ?? null) {
- if (
- !in_array(
- (string)$partName->attributes()->label,
- $this->excludedLocationAppellationValueLabels
- )
- ) {
- $result[] = trim((string)$partName);
- }
+ foreach ($this->xmlDoc->all($set, 'repositoryLocation/partOfPlace') as $part) {
+ while ($namePlaceSet = $this->xmlDoc->first($part, 'namePlaceSet')) {
+ if ($appellationValue = $this->xmlDoc->first($namePlaceSet, 'appellationValue')) {
+ if (
+ !in_array(
+ $this->xmlDoc->attr($appellationValue, 'label'),
+ $this->excludedLocationAppellationValueLabels
+ )
+ ) {
+ $result[] = $this->xmlDoc->value($appellationValue);
}
- $part = $part->partOfPlace;
}
+ $part = $this->xmlDoc->first($part, 'partOfPlace');
}
}
}
@@ -1460,21 +1333,9 @@ protected function getCollection(): string
*/
protected function getIdentifier()
{
- $nodeExists = !empty(
- $this->doc->lido->descriptiveMetadata->objectIdentificationWrap
- ->repositoryWrap->repositorySet
- );
- if (!$nodeExists) {
- return '';
- }
- foreach (
- $this->doc->lido->descriptiveMetadata->objectIdentificationWrap->repositoryWrap->repositorySet as $set
- ) {
- if (!empty($set->workID)) {
- return (string)$set->workID;
- }
- }
- return '';
+ $path = 'lido/descriptiveMetadata/objectIdentificationWrap/repositoryWrap/repositorySet/workID';
+ // Return first non-empty value:
+ return $this->xmlDoc->allValues(path: $path)[0] ?? '';
}
/**
@@ -1488,23 +1349,21 @@ protected function addHierarchyFields(array &$data): void
{
if ($this->getDriverParam('indexHierarchies', false)) {
foreach ($this->getRelatedWorkSetNodes(['is part of']) as $set) {
- if (!($relatedWork = $set->relatedWork)) {
+ if (!($relatedWork = $this->xmlDoc->first($set, 'relatedWork'))) {
continue;
}
- $relatedId = (string)($relatedWork->object->objectID ?? '');
- if (!$relatedId) {
- $this->logger
- ->logDebug('Lido', 'Related record ID missing', true);
+ $relatedId = $this->xmlDoc->firstValue($relatedWork, 'object/objectID') ?? '';
+ if ('' === $relatedId) {
+ $this->logger->logDebug('Lido', 'Related record ID missing', true);
continue;
}
- $relatedTitle = (string)($relatedWork->displayObject ?? '');
+ $relatedTitle = $this->xmlDoc->firstValue($relatedWork, 'displayObject') ?? '';
if (!$relatedTitle) {
- $this->logger
- ->logDebug('Lido', 'Related record title missing', true);
+ $this->logger->logDebug('Lido', 'Related record title missing', true);
continue;
}
- $type = (string)($relatedWork->object->objectType->term ?? '');
+ $type = $this->xmlDoc->firstValue($relatedWork, 'object/objectType/term');
if ('collection' === $type) {
$data['hierarchy_top_id'] = $relatedId;
$data['hierarchy_top_title'] = $relatedTitle;
diff --git a/src/RecordManager/Base/Record/XmlDocRecordTrait.php b/src/RecordManager/Base/Record/XmlDocRecordTrait.php
new file mode 100644
index 00000000..cd4473cd
--- /dev/null
+++ b/src/RecordManager/Base/Record/XmlDocRecordTrait.php
@@ -0,0 +1,169 @@
+metadataUtils
+ *
+ * PHP version 8
+ *
+ * Copyright (C) The National Library of Finland 2022.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ *
+ * @category DataManagement
+ * @package RecordManager
+ * @author Ere Maijala
+ * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License
+ * @link https://github.com/NatLibFi/RecordManager
+ */
+
+namespace RecordManager\Base\Record;
+
+use VuFindXml\XmlDoc;
+
+/**
+ * XML record trait
+ *
+ * @category DataManagement
+ * @package RecordManager
+ * @author Ere Maijala
+ * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License
+ * @link https://github.com/NatLibFi/RecordManager
+ */
+trait XmlDocRecordTrait
+{
+ /**
+ * The XML namespace.
+ *
+ * @var string
+ */
+ protected string $nsXml = 'http://www.w3.org/XML/1998/namespace';
+
+ /**
+ * The XMLNS namespace.
+ *
+ * @var string
+ */
+ protected string $nsXmlns = 'http://www.w3.org/2000/xmlns/';
+
+ /**
+ * XML schema instance namespace.
+ *
+ * @var string
+ */
+ protected string $nsXsi = 'http://www.w3.org/2001/XMLSchema-instance';
+
+ /**
+ * XML Document
+ *
+ * @var ?XmlDoc
+ */
+ protected ?XmlDoc $xmlDoc = null;
+
+ /**
+ * Default namespace
+ *
+ * @var ?string
+ */
+ protected ?string $defaultNamespace = null;
+
+ /**
+ * Default namespace prefix
+ *
+ * @var ?string
+ */
+ protected ?string $defaultNamespacePrefix = null;
+
+ /**
+ * Set record data
+ *
+ * @param string $source Source ID
+ * @param string $oaiID Record ID received from OAI-PMH (or empty string for
+ * file import)
+ * @param string $data Record metadata
+ * @param array $extraData Extra metadata
+ *
+ * @return void
+ */
+ public function setData($source, $oaiID, $data, $extraData)
+ {
+ parent::setData($source, $oaiID, $data, $extraData);
+
+ $this->xmlDoc = new XmlDoc();
+ if (str_starts_with($data, '{')) {
+ if (null === ($data = json_decode($data, true))) {
+ throw new \RuntimeException('Invalid data');
+ }
+ $this->xmlDoc->import($data);
+ } else {
+ $this->xmlDoc->parse($data);
+ }
+ if (null !== $this->defaultNamespace) {
+ $this->xmlDoc->setDefaultNamespace($this->defaultNamespace, $this->defaultNamespacePrefix);
+ }
+ }
+
+ /**
+ * Serialize the record for storing in the database
+ *
+ * @return string
+ */
+ public function serialize()
+ {
+ return json_encode($this->xmlDoc->export());
+ }
+
+ /**
+ * Serialize the record into XML for export
+ *
+ * @return string
+ */
+ public function toXML()
+ {
+ if (null === $this->xmlDoc) {
+ throw new \Exception('Document not set');
+ }
+ try {
+ // Ensure that the default namespace doesn't get applied to a record that's missing namespaces:
+ $this->xmlDoc->setDefaultNamespace(null);
+ $result = $this->xmlDoc->toXML();
+ if (null !== $this->defaultNamespace) {
+ $this->xmlDoc->setDefaultNamespace($this->defaultNamespace, $this->defaultNamespacePrefix);
+ }
+ return $result;
+ } catch (\Exception $e) {
+ throw new \Exception(
+ "Could not serialize record '{$this->source}."
+ . $this->getId() . "' to XML: " . (string)$e
+ );
+ }
+ }
+
+ /**
+ * Get lang attribute from xml namespace with fallback to default namespace.
+ *
+ * @param array $node XmlDoc node
+ *
+ * @return ?string
+ */
+ protected function getLangAttr(array $node): ?string
+ {
+ $xml = $this->xmlDoc ?? new XmlDoc();
+ return $xml->attr($node, "{{$this->nsXml}}lang") ?? $xml->attr($node, 'lang');
+ }
+}
diff --git a/tests/RecordManagerTest/Base/Record/LidoTest.php b/tests/RecordManagerTest/Base/Record/LidoTest.php
index e4197f73..7e760c4b 100644
--- a/tests/RecordManagerTest/Base/Record/LidoTest.php
+++ b/tests/RecordManagerTest/Base/Record/LidoTest.php
@@ -494,6 +494,39 @@ public function testLidoHierarchies()
$this->assertEquals('Testiarkisto', $fields['collection']);
}
+ /**
+ * Test namespace handling.
+ *
+ * @return void
+ */
+ public function testNamespaces(): void
+ {
+ $record = $this->createRecord(
+ Lido::class,
+ 'lido_ns.xml',
+ [],
+ 'Base',
+ [],
+ );
+ $reflection = new \ReflectionObject($record);
+ $getTitles = $reflection->getMethod('getTitles');
+
+ $this->assertEquals(
+ [
+ 'preferred' => 'The story of the image: Cat On Grass',
+ 'alternate' => [],
+ ],
+ $getTitles->invokeArgs($record, ['en'])
+ );
+ $this->assertEquals(
+ [
+ 'preferred' => 'Kissa nurmikolla -kuvan tarina',
+ 'alternate' => [],
+ ],
+ $getTitles->invokeArgs($record, ['fi'])
+ );
+ }
+
/**
* Data provider for testLidoRootElementHandling
*
@@ -501,27 +534,102 @@ public function testLidoHierarchies()
*/
public static function lidoRootElementProvider(): \Iterator
{
+ $xsiPart = 'xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:';
+ $nsLidoPart = 'xmlns:lido="http://www.lido-schema.org" ' . $xsiPart;
$schema10 = 'schemaLocation="http://www.lido-schema.org http://www.lido-schema.org/schema/v1.0/lido-v1.0.xsd"';
$schema11 = 'schemaLocation="http://www.lido-schema.org http://www.lido-schema.org/schema/v1.1/lido-v1.1.xsd"';
yield 'lido 1.0 with lidoWrap' => [
- "123",
- "123",
+ <<
+
+ 123
+
+
+
+ XML,
+ <<
+
+ 123
+
+
+
+
+ XML,
];
yield 'lido 1.1 with lidoWrap' => [
- "123",
- "123",
+ <<
+
+ 123
+
+
+ XML,
+ <<
+
+ 123
+
+
+ XML,
+ ];
+ yield 'lido 1.1 with lidoWrap including namespaces' => [
+ <<
+
+ 123
+
+
+ XML,
+ <<
+
+ 123
+
+
+ XML,
];
yield 'lido 1.0 without lidoWrap' => [
- "123",
- "123",
+ <<
+ 123
+
+ XML,
+ <<
+
+ 123
+
+
+ XML,
];
yield 'lido 1.1 without lidoWrap' => [
- "123",
- "123",
+ <<
+ 123
+
+ XML,
+ <<
+
+ 123
+
+
+ XML,
];
yield 'unspecified lido version without lidoWrap' => [
- '123',
- "123",
+ <<
+ 123
+
+ XML,
+ <<
+
+ 123
+
+
+ XML,
];
}
@@ -536,8 +644,8 @@ public static function lidoRootElementProvider(): \Iterator
#[\PHPUnit\Framework\Attributes\DataProvider('lidoRootElementProvider')]
public function testLidoRootElementHandling(string $input, string $expected): void
{
- $prolog = "\n";
+ $prolog = "\n";
$record = $this->createRecordFromString($prolog . $input, Lido::class);
- $this->assertEquals($prolog . $expected, trim($record->toXML()));
+ $this->assertXmlStringEqualsXmlString($prolog . $expected, $record->toXML());
}
}
diff --git a/tests/fixtures/Base/record/lido2.xml b/tests/fixtures/Base/record/lido2.xml
index 3ba389bb..3e404fae 100644
--- a/tests/fixtures/Base/record/lido2.xml
+++ b/tests/fixtures/Base/record/lido2.xml
@@ -16,9 +16,9 @@
Kitchen tool
Scissors
-
- Sakset
- Keittiövälineet
+
+ Sakset
+ Keittiövälineet
diff --git a/tests/fixtures/Base/record/lido_ns.xml b/tests/fixtures/Base/record/lido_ns.xml
new file mode 100644
index 00000000..dbc2bfb6
--- /dev/null
+++ b/tests/fixtures/Base/record/lido_ns.xml
@@ -0,0 +1,16 @@
+
+
+
+ testimuseo-K1554
+
+
+
+
+ Kissa nurmikolla -kuvan tarina
+ The story of the image: Cat On Grass
+
+
+
+
+
+