museum-digital/csvxml
35
0
Fork 0
Code Issues 2 Pull Requests Releases Activity

Add note/description fields for actors and places in events (was_used_who_description, was_used_where_description)

Browse Source 
Close #43
This commit is contained in:
Joshua Ramon Enslin
2025-03-14 11:41:28 +01:00
parent dcb06a4b60
commit dba2ba182e
7 changed files with 28 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

57
src/CsvxmlAvailableFields.php
View File

@ -29,31 +29,6 @@ final class CsvxmlAvailableFields {
}
/**
* Function for getting a simple array definition of an available field.
*
* @param string $nameTL Translation of the field name. Optional.
* @param string $explica Explanation of the field (from musdb). Optional.
* @param array<string> $dependsOn Dependent fields. Optional.
* @param array<string> $allowedValues Allowed values. Optional.
* @param string $remark Explanation of the field (for importer). Optional.
* @param boolean $required Determines whether the field is required.
* Optional, defaults to false.
*
* @return FieldEntry
*/
private function _getSimpleAvailableFieldEntry(string $nameTL = "", string $explica = "", array $dependsOn = [], array $allowedValues = [], string $remark = "", bool $required = false):FieldEntry {
return new FieldEntry(
$required,
$allowedValues,
$dependsOn,
$remark,
$nameTL,
$explica
);
}
/**
* Function for building a generic event type definition.
*
@ -67,16 +42,18 @@ final class CsvxmlAvailableFields {
private function _generateGenericFullEvent(MDTlLoader $tlLoader, string $typeName, string $type, int $number):array {
return [
$type . '_when' . $number => $this->_getSimpleAvailableFieldEntry($typeName . ': ' . $tlLoader->tl("event", "event", 'when'), "", []),
$type . '_when_sure' . $number => $this->_getSimpleAvailableFieldEntry($typeName . ': ' . $tlLoader->tl("event", "event", 'when') . " [" . $tlLoader->tl('csvxml-overview', 'csvxml_overview', 'certainty') . "]", "", [$type . '_when' . $number], allowedValues: ["y", "n"]),
$type . '_who' . $number => $this->_getSimpleAvailableFieldEntry($typeName . ': ' . $tlLoader->tl("event", "event", 'who'), "", []),
$type . '_who_sure' . $number => $this->_getSimpleAvailableFieldEntry($typeName . ': ' . $tlLoader->tl("event", "event", 'who') . " [" . $tlLoader->tl('csvxml-overview', 'csvxml_overview', 'certainty') . "]", "", [$type . '_who' . $number], allowedValues: ["y", "n"]),
$type . '_who_gnd' . $number => $this->_getSimpleAvailableFieldEntry($typeName . ': ' . $tlLoader->tl("event", "event", 'who') . ' (' . $tlLoader->tl("event", "event", 'gnd') . ')', "", [$type . '_who_sure' . $number, $type . '_who' . $number]),
$type . '_who_wikidata' . $number => $this->_getSimpleAvailableFieldEntry($typeName . ': ' . $tlLoader->tl("event", "event", 'who') . ' (Wikidata)', "", [$type . '_who_sure' . $number, $type . '_who' . $number]),
$type . '_where' . $number => $this->_getSimpleAvailableFieldEntry($typeName . ': ' . $tlLoader->tl("event", "event", 'where'), "", []),
$type . '_where_sure' . $number => $this->_getSimpleAvailableFieldEntry($typeName . ': ' . $tlLoader->tl("event", "event", 'where') . " [" . $tlLoader->tl('csvxml-overview', 'csvxml_overview', 'certainty') . "]", "", [$type . '_where' . $number], allowedValues: ["y", "n"]),
$type . '_where_wikidata' . $number => $this->_getSimpleAvailableFieldEntry($typeName . ': ' . $tlLoader->tl("event", "event", 'where') . ' (Wikidata)', "", [$type . '_where_sure' . $number, $type . '_where' . $number]),
$type . '_annotation' . $number => $this->_getSimpleAvailableFieldEntry($typeName . ': ' . $tlLoader->tl("event", "event", 'classic_annotation_intro'), ""),
$type . '_when' . $number => new FieldEntry(name_human_readable: $typeName . ': ' . $tlLoader->tl("event", "event", 'when')),
$type . '_when_sure' . $number => new FieldEntry(name_human_readable: $typeName . ': ' . $tlLoader->tl("event", "event", 'when') . " [" . $tlLoader->tl('csvxml-overview', 'csvxml_overview', 'certainty') . "]", dependsOn: [$type . '_when' . $number], allowedValues: ["y", "n"]),
$type . '_who' . $number => new FieldEntry(name_human_readable: $typeName . ': ' . $tlLoader->tl("event", "event", 'who')),
$type . '_who_sure' . $number => new FieldEntry(name_human_readable: $typeName . ': ' . $tlLoader->tl("event", "event", 'who') . " [" . $tlLoader->tl('csvxml-overview', 'csvxml_overview', 'certainty') . "]", dependsOn: [$type . '_who' . $number], allowedValues: ["y", "n"]),
$type . '_who_description' . $number => new FieldEntry(name_human_readable: $typeName . ': ' . $tlLoader->tl("event", "event", 'who') . " [" . $tlLoader->tl('actor', 'actor', 'short_description') . "]", dependsOn: [$type . '_who' . $number]),
$type . '_who_gnd' . $number => new FieldEntry(name_human_readable: $typeName . ': ' . $tlLoader->tl("event", "event", 'who') . ' (' . $tlLoader->tl("event", "event", 'gnd') . ')', dependsOn: [$type . '_who_sure' . $number, $type . '_who' . $number]),
$type . '_who_wikidata' . $number => new FieldEntry(name_human_readable: $typeName . ': ' . $tlLoader->tl("event", "event", 'who') . ' (Wikidata)', dependsOn: [$type . '_who_sure' . $number, $type . '_who' . $number]),
$type . '_where' . $number => new FieldEntry(name_human_readable: $typeName . ': ' . $tlLoader->tl("event", "event", 'where')),
$type . '_where_sure' . $number => new FieldEntry(name_human_readable: $typeName . ': ' . $tlLoader->tl("event", "event", 'where') . " [" . $tlLoader->tl('csvxml-overview', 'csvxml_overview', 'certainty') . "]", dependsOn: [$type . '_where' . $number], allowedValues: ["y", "n"]),
$type . '_where_description' . $number => new FieldEntry(name_human_readable: $typeName . ': ' . $tlLoader->tl("event", "event", 'where') . " [" . $tlLoader->tl('actor', 'actor', 'short_description') . "]", dependsOn: [$type . '_where' . $number]),
$type . '_where_wikidata' . $number => new FieldEntry(name_human_readable: $typeName . ': ' . $tlLoader->tl("event", "event", 'where') . ' (Wikidata)', dependsOn: [$type . '_where_sure' . $number, $type . '_where' . $number]),
$type . '_annotation' . $number => new FieldEntry(name_human_readable: $typeName . ': ' . $tlLoader->tl("event", "event", 'classic_annotation_intro')),
];
}
@ -1019,10 +996,18 @@ final class CsvxmlAvailableFields {
"related_actor{$i}" => new FieldEntry(
name_human_readable: $tlLoader->tl("event", "event", 'who'),
),
"related_actor_description{$i}" => new FieldEntry(
dependsOn: ["related_actor{$i}"],
name_human_readable: $tlLoader->tl("event", "event", 'who') . " [" . $tlLoader->tl('actor', 'actor', 'short_description') . "]",
),
"related_actor_gnd{$i}" => new FieldEntry(
dependsOn: ["related_actor{$i}", "related_actor_sure{$i}"],
dependsOn: ["related_actor{$i}"],
name_human_readable: $tlLoader->tl("event", "event", 'who') . " (" . $tlLoader->tl("event", "event", 'gnd') . ")",
),
"related_actor_wikidata{$i}" => new FieldEntry(
dependsOn: ["related_actor{$i}"],
name_human_readable: $tlLoader->tl("event", "event", 'who') . " (Wikidata)",
),
]
);