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.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
development:architecture:record_data_formatter [2018/05/09 13:36] – [Specification Array] demiankatz | development:architecture:record_data_formatter [2020/09/22 14:19] – demiankatz | ||
---|---|---|---|
Line 32: | Line 32: | ||
| multiFunction | optional | The callback required when renderType = Multi. Accepts three parameters: 1.) raw input data, 2.) the options array from the spec, 3.) the record driver object. Outputs an array of associative arrays with the following keys: **label**: Label to display; **values**: Values to render; **options**: | | multiFunction | optional | The callback required when renderType = Multi. Accepts three parameters: 1.) raw input data, 2.) the options array from the spec, 3.) the record driver object. Outputs an array of associative arrays with the following keys: **label**: Label to display; **values**: Values to render; **options**: | ||
| multiRenderType | optional | The default type of rendering to apply to each of the sets of values returned by the multiFunction (optional, defaults to Simple, may be overridden by options specified by your multiFunction). | | | multiRenderType | optional | The default type of rendering to apply to each of the sets of values returned by the multiFunction (optional, defaults to Simple, may be overridden by options specified by your multiFunction). | | ||
- | | prefix | optional | HTML to prepend to the output generated by the view helper. Applies only when RenderType = Simple. | | + | | itemPrefix | optional | HTML to prepend to each value formatted by the view helper. Use prefix instead if you want to prepend a single value to the whole set of data assembled by the view helper. Applies only when RenderType = Simple. :!: // Introduced in VuFind 7.0. // | |
+ | | prefix | optional | HTML to prepend to the output generated by the view helper. This is applied once before the full set of values; use itemPrefix if you want to prepend something to each individual value. Applies only when RenderType = Simple. | | ||
| recordLink | optional | The type of link (from the Record view helper' | | recordLink | optional | The type of link (from the Record view helper' | ||
| separator | optional (default = < | | separator | optional (default = < | ||
- | | suffix | optional | HTML to append to the output generated by the view helper. Applies only when RenderType = Simple. | | + | | itemSuffix | optional | HTML to append to each value formatted by the view helper. Use suffix instead if you want to append a single value to the whole set of data assembled by the view helper. Applies only when RenderType = Simple. :!: // Introduced in VuFind 7.0. // | |
+ | | suffix | optional | HTML to append to the output generated by the view helper. This is applied once after the full set of values; use itemSuffix if you want to append something to each individual value. Applies only when RenderType = Simple. | | ||
| template | optional | The name of the template to render, when renderType = RecordDriverTemplate | | | template | optional | The name of the template to render, when renderType = RecordDriverTemplate | | ||
| translate | optional (default = false) | Should we run raw field data through the translator? Applies only when RenderType = Simple. | | | translate | optional (default = false) | Should we run raw field data through the translator? Applies only when RenderType = Simple. | | ||
Line 43: | Line 45: | ||
===== The Specification Builder ===== | ===== The Specification Builder ===== | ||
- | A [[https:// | + | A [[https:// |
Useful public methods: | Useful public methods: | ||
* setLine($key, | * setLine($key, | ||
+ | * setMultiLine($key, | ||
* setTemplateLine($key, | * setTemplateLine($key, | ||
* reorderKeys($orderedKeys, | * reorderKeys($orderedKeys, | ||
Line 56: | Line 59: | ||
==== Option 1: Override the Factory ==== | ==== Option 1: Override the Factory ==== | ||
- | If you want to make global changes to a specification, | + | If you want to make global changes to a specification, |
==== Option 2: Override the Template ==== | ==== Option 2: Override the Template ==== |
development/architecture/record_data_formatter.txt · Last modified: 2023/12/11 16:11 by dltj