About Features Downloads Getting Started Documentation Events Support GitHub

Site Tools


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 revision Previous revision
development:architecture:record_data_formatter [2020/02/27 14:08]
demiankatz [Specification Array]
development:architecture:record_data_formatter [2020/02/27 14:09] (current)
demiankatz [Specification Array]
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**:​ Rendering options (may include renderType, pos, and any other relevant parameters; they will be applied only to the current grouping of data; any options not set here will be inherited from the spec array). | | 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**:​ Rendering options (may include renderType, pos, and any other relevant parameters; they will be applied only to the current grouping of data; any options not set here will be inherited from the spec array). |
 | 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). |
-| itemPrefix | optional | :!: Introduced in VuFind 7.0. 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. |+| 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. | | 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'​s getLink method) to associate with each value in the raw field data. Applies only when RenderType = Simple. | | recordLink | optional | The type of link (from the Record view helper'​s getLink method) to associate with each value in the raw field data. Applies only when RenderType = Simple. |
 | separator | optional (default = <​nowiki><​br /></​nowiki>​) | Separator to use between multiple data values. Applies only when RenderType = Simple. | | separator | optional (default = <​nowiki><​br /></​nowiki>​) | Separator to use between multiple data values. Applies only when RenderType = Simple. |
-| itemSuffix | optional | :!: Introduced in VuFind 7.0. 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. |+| 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. | | 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 |
development/architecture/record_data_formatter.txt · Last modified: 2020/02/27 14:09 by demiankatz