About Features Downloads Getting Started Documentation Events Support GitHub

Love VuFind®? Consider becoming a financial supporter. Your support helps build a better VuFind®!

VuFind Documentation

Site Tools

You are here: start » development » architecture » record_data_formatter
Trace:
Warning: This page has not been updated in over over a year and may be outdated or deprecated.
development:architecture:record_data_formatter

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revisionBoth sides next revision
development:architecture:record_data_formatter [2018/05/09 13:32] – [Specification Array] demiankatzdevelopment:architecture:record_data_formatter [2018/05/09 13:33] – [Specification Array] demiankatz
Line 28: Line 28:
 | helperMethod | optional | The Record view helper method to use for output rendering, when renderType = RecordHelper. | | helperMethod | optional | The Record view helper method to use for output rendering, when renderType = RecordHelper. |
 | pos | optional | An integer used for sorting the fields to determine the final display order. | | pos | optional | An integer used for sorting the fields to determine the final display order. |
-| renderType | optional (default = Simple) | The method used to render output from the input provided by dataMethod. Legal values: Multi (sort data using a callback function specified by the 'multiFunction' key and potentially render each output group using different rules), RecordDriverTemplate (render a template associated with the record driver, as specified by the 'template' key); RecordHelper (call a method of the Record view helper, as specified by the 'method' key); Simple (display the raw data, possibly manipulated based on other settings in the specification) |+| renderType | optional (default = Simple) | The method used to render output from the input provided by dataMethod. Legal values: **Multi** (sort data using a callback function specified by the 'multiFunction' key and potentially render each output group using different rules), **RecordDriverTemplate** (render a template associated with the record driver, as specified by the 'template' key); **RecordHelpe**r (call a method of the Record view helper, as specified by the 'method' key); **Simple** (display the raw data, possibly manipulated based on other settings in the specification) |
 | labelFunction | optional | May be set to a callback function which will receive the raw field data as input and produce a custom output label (overriding the key of the spec array) as output. Starting with VuFind 5.0, the callback function also receives the record driver object as a second parameter. | | labelFunction | optional | May be set to a callback function which will receive the raw field data as input and produce a custom output label (overriding the key of the spec array) as output. Starting with VuFind 5.0, the callback function also receives the record driver object as a second parameter. |
 | prefix | optional | HTML to prepend to the output generated by the view helper. Applies only when RenderType = Simple. | | prefix | optional | HTML to prepend to the output generated by the view helper. Applies only when RenderType = Simple. |
development/architecture/record_data_formatter.txt · Last modified: 2023/12/11 16:11 by dltj