Taming the VuFind RecordDataFormatter

config-module.config.php

<?php

return [
  'vufind' =>
  [
    'plugin_managers' =>
    [
      'recorddataformatter_specs' => [
        'aliases' => [
            VuFind\RecordDataFormatter\Specs\DefaultRecord::class => \IndexDataShared\RecordDataFormatter\Specs\DefaultRecord::class,
        ],
        'factories' => [
            IndexDataShared\RecordDataFormatter\Specs\DefaultRecord::class =>  \VuFind\RecordDataFormatter\Specs\DefaultRecordFactory::class,
        ],
      ],
    ],
  ],
];

config-vufind-RecordDataFormatter-DefaultRecord.ini

; This file can be used to set global default options for fields, to add new fields and to configure fields
; in the RecordDataFormatter.

; This section is used to set global default option.
[Global]
; Enable or disable all fields by default (default is true)
;enabled = false
; Change the default renderMethod (default is "Simple")
;renderType = "CombineAlt"
; Change the default separator for array values (default is <br />)
;separator = "; "
; One can also add any other option. See https://vufind.org/wiki/development:architecture:record_data_formatter
; for all available options.

; This section can be used to define which methods in the Specs plugin are called to establish default settings.
; You can add new settings for new contexts or uncomment and change the examples below to override defaults.
[Defaults_Function_Mapping]
;collection-info = getDefaultCollectionInfoSpecs
;collection-record = getDefaultCollectionRecordSpecs
;core = getDefaultCoreSpecs
;description = getDefaultDescriptionSpecs

; Taming the RecordDataFormatter: This section is used to define which fields should be in each section
; ("core" versus "description") and in what order they should appear. Since there are no longer 
; any fields defined in code, no assumptions need to be made...everything is reflected here.
[Defaults]
core[] = "Published in"
core[] = "New Title"
core[] = "Previous Title"
core[] = "Authors"
core[] = "Format_CORE"
core[] = "Language"
core[] = "Published_CORE"
core[] = "Edition"
core[] = "Series"
core[] = "Subjects"
core[] = "Citations"
core[] = "child_records"
core[] = "Online Access"
core[] = "Related Items"
core[] = "Tags"

description[] = "Summary"
description[] = "Abstract"
description[] = "Review"
description[] = "Content Advice"
description[] = "Published_DESCRIPTION"
description[] = "Item Description"
description[] = "Physical Description"
description[] = "Publication Frequency"
description[] = "Former Publication Frequency"
description[] = "Playing Time"
description[] = "Format_DESCRIPTION"
description[] = "Audience"
description[] = "Awards"
description[] = "Production Credits"
description[] = "Bibliography"
description[] = "ISBN"
description[] = "ISSN"
description[] = "DOI"
description[] = "Related Items"
description[] = "Access"
description[] = "Finding Aid"
description[] = "Publication_Place"
description[] = "Source"
description[] = "Author Notes"

; To change options on a specific field one has to add a section [Field_<field's name>].
; E.g. to enable ISBNs and to override the separator option use:
;
;[Field_ISBN]
;enabled = true
;separator = ' ; '
;
; And to configure the fields added in the example of the [Defaults] section:
;
;[Field_Extra]
;dataMethod = "getExtra"
;pos = 1000
;
;[Field_MySpecialField]
;dataMethod = "getMySpecialField"
;pos = 1500
;renderType = "RecordDriverTemplate"
;template = "data-mySpecialField.phtml"
;
;[Field_TextualHoldings]
;dataMethod = "getTextualHoldings"
;pos = 2000

; If you want to apply some options to a specific context only you can use the overrideContext option.
; Add overrideContext[<context>] = <context options section> where <context> is either "collection-info",
; "collection-record", "core" or "description" and add the options in a new section [<context options section>].
; E.g. to enable "Published" in the core view only:
;[Field_Published]
;enabled = false
;overrideContext['core'] = Core_Published
;
;[Core_Published]
;enabled = true

; If you want to apply some options to specific lines only in multiline fields you can use the extraLineOptions option.
; Add extraLineOptions[] = <extra line options section> and add the options in a new section
; [<extra line options section>]. To specify on which lines the options should be applied they have to be identified
; by key and value of the output of the multiFunction. lineIdentifierKey (default is 'label') and lineIdentifierValue
; are added to the [<extra line options section>] section.
; E.g. to only enable primary authors:
;[Field_Authors]
;multiEnabled = false
;extraLineOptions[] = "PrimaryAuthors"
;
;[PrimaryAuthors]
;lineIdentifierKey = "label"
;lineIdentifierValue = "Main Author"
;multiEnabled = true

;;
;; Here we set the configuration for the library-defined fields


;;
;; Core context fields defined in VuFind's code
[Field_Published in]
dataMethod = "getContainerTitle"
renderType = "RecordDriverTemplate"
template = "data-containerTitle.phtml"

[Field_New Title]
dataMethod = "getNewerTitles"
recordLink = "title"

[Field_Previous Title]
dataMethod = "getPreviousTitles"
recordLink = "title"

[Field_Authors]
dataMethod = "getDeduplicatedAuthors"
renderType = "Multi"
multiEnabled = true
; There is code in IndexDataShared\RecordDataFormatter\Specs\DefaultRecord::getDefaults() that sets 'multiFunction'

[Field_Format_CORE]
dataMethod = "getFormats"
renderType = "RecordHelper"
helperMethod = "getFormatList"

[Field_Language]
dataMethod = "getLanguages"
; There is code in IndexDataShared\RecordDataFormatter\Specs\DefaultRecord::getDefaults() that sets
; options from $this->getLanguageLineSettings()

[Field_Published_CORE]
dataMethod = "getPublicationDetails"
renderType = "RecordDriverTemplate"
template = "data-publicationDetails.phtml"

[Field_Edition]
dataMethod = "getEdition"
itemPrefix = "<span property=\"bookEdition\">"
itemSuffix = "</span>"

[Field_Series]
dataMethod = "getSeries"
renderType = "RecordDriverTemplate"
template = "data-series.phtml"

[Field_Subjects]
dataMethod = "getAllSubjectHeadings"
renderType = "RecordDriverTemplate"
template = "data-allSubjectHeadings.phtml"

[Field_Citations]
dataMethod = "getCitations"
renderType = "RecordDriverTemplate"
template = "data-citations.phtml"

[Field_child_records]
dataMethod = "getChildRecordCount"
renderType = "RecordDriverTemplate"
template = "data-childRecords.phtml"
allowZero = false

[Field_Online Access]
dataMethod = true
renderType = "RecordDriverTemplate"
template = "data-onlineAccess.phtml"

[Field_Related Items]
dataMethod = "getAllRecordLinks"
renderType = "RecordDriverTemplate"
template = "data-allRecordLinks.phtml"

[Field_Tags]
dataMethod = true
renderType = "RecordDriverTemplate"
template = "data-tags.phtml"

;;
;; Description context fields defined in VuFind code
[Field_Summary]
dataMethod = true
renderType = "RecordDriverTemplate"
template = "data-summary.phtml"

[Field_Abstract]
dataMethod = "getAbstractNotes"

[Field_Review]
dataMethod = "getReviewNotes"

[Field_Content Advice]
dataMethod = "getContentAdviceNotes"

[Field_Published_DESCRIPTION]
dataMethod = "getDateSpan"

[Field_Item Description]
dataMethod = "getGeneralNotes"

[Field_Physical Description]
dataMethod = "getPhysicalDescriptions"

[Field_Publication Frequency]
dataMethod = "getPublicationFrequency"

[Field_Playing Time]
dataMethod = "getPlayingTimes"

[Field_Format_DESCRIPTION]
dataMethod = "getSystemDetails"

[Field_Audience]
dataMethod = "getTargetAudienceNotes"

[Field_Awards]
dataMethod = "getAwards"

[Field_Production Credits]
dataMethod = "getProductionCredits"

[Field_Bibliography]
dataMethod = "getBibliographyNotes"

[Field_ISBN]
dataMethod = "getISBNs"
itemPrefix = "<span property=\"isbn\">"
itemSuffix = "</span>"

[Field_ISSN]
dataMethod = "getISSNs"
itemPrefix = "<span property=\"issn\">"
itemSuffix = "</span>"

[Field_DOI]
dataMethod = "getCleanDOI"
itemPrefix = "<span property=\"identifier\">"
itemSuffix = "</span>"

[Field_Related Items]
dataMethod = "getRelationshipNotes"

[Field_Access]
dataMethod = "getAccessRestrictions"

[Field_Finding Aid]
dataMethod = "getFindingAids"

[Field_Publication_Place]
dataMethod = "getHierarchicalPlaceNames"

[Field_Source]
dataMethod = "getSource"

[Field_Author Notes]
dataMethod = true
renderType = "RecordDriverTemplate"
template = "data-authorNotes.phtml"

languages-en.ini

; These entries cover for the fact that "Published" and "Format" appear in both core and description sections
; of the RecordDataFormatter/DefaultRecord.ini file
Published_CORE = Published
Published_DESCRIPTION = Published
Format_CORE = Format
Format_DESCRIPTION = Format

RecordDataFormatter-Specs-DefaultRecord.php

<?php

namespace IndexDataShared\RecordDataFormatter\Specs;

class DefaultRecord extends \VuFind\RecordDataFormatter\Specs\DefaultRecord {

    /**
     * Get a callback function for processing label-data pairs for multi-line fields.
     * 
     * This method returns a closure that can be used as a "multiFunction" in field specifications. The 
     * callback takes raw data and options, processes each item to extract the label and values, and 
     * returns an array of formatted entries with positional information.
     * 
     * @return callable A callback function that takes ($data, $options) and returns a formatted array.
     */
    public function getLabelDataMapFunction(): callable
    {
        return function ($data, $options) {
            $final = [];
            foreach ($data as $i => $item) {
                $final[] = [
                    'label' => $item['label'],
                    'values' => $item['values'],
                    'options' => [
                        'pos' => $options['pos'] + $i,
                    ],
                ];
            }
            return $final;
        };
    }

    /**
     * OVERRIDDEN IndexDataShared - Get default configuration.
     * 
     * This method post-processes the default field specification array (as loaded
     * from configuration) and attaches a custom multiFunction callback to
     * the "Authors" line. This enables custom author formatting logic without
     * modifying the INI configuration or the parent spec generation logic.
     *
     * @param string $key The spec key (e.g. "core" or "description").
     * @return array The modified field specification array.
     *
     * @return array
     */
    public function getDefaults(string $key): array
    {
        $defaults = parent::getDefaults($key);
        $pos = 100;
        $hasLabelDataMap = method_exists($this, 'getLabelDataMapFunction');

        foreach ($defaults as $label => &$line) {
            $line['pos'] = $pos;
            $pos += 100;

            // Handle specific labels and assign multiFunction callbacks or other settings
            switch ($label) {
                case 'Authors':
                    if (method_exists($this, 'getAuthorFunction')) {
                        $line['multiFunction'] = $this->getAuthorFunction();
                    }
                    break;
                case 'Language':
                    if (method_exists($this, 'getLanguageLineSettings')) {
                        $line += $this->getLanguageLineSettings();
                    }
                    break;
                case 'Format_CORE':
                    if (method_exists($this, 'getFormatList')) {
                        $line['helperMethod'] = $this->getFormatList();
                    }
                    break;
            }

            // Fallback for Multi renderType not otherwise specified
            if (($line['renderType'] ?? null) === 'Multi' && !array_key_exists('multiFunction', $line) && $hasLabelDataMap) {
                $line['multiFunction'] = $this->getLabelDataMapFunction();
            }

            if (isset($line['dataMethod'])) {
                if (strtolower($line['dataMethod']) === 'true' || $line['dataMethod'] == "1") {
                    $line['dataMethod'] = true;
                }
            }
        }
        unset($line); // Break the reference to the last element
        return $defaults;
    }


    /**
     * OVERRIDDEN IndexDataShared - Get default specifications for displaying data in core metadata.
     *
     * Use an empty default so all data field specifications are in the 
     * `config/vufind/RecordDataFormatter/DefaultRecord.ini` file.
     * 
     * @return array
     */
    protected function getDefaultCoreSpecs(): array
    {
        return [];
    }


    /**
     * OVERRIDDEN Index Data Shared- Get default specifications for displaying data in the description tab.
     *
     * Use an empty default so all data field specifications are in the 
     * `config/vufind/RecordDataFormatter/DefaultRecord.ini` file.
     * 
     * @return array
     */
    protected function getDefaultDescriptionSpecs(): array
    {
        return [];
    }
}