Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revision | Next revisionBoth sides next revision |
development:architecture:record_driver_method_master_list [2018/06/25 19:44] – [Base] demiankatz | development:architecture:record_driver_method_master_list [2019/11/05 14:26] – steinm |
---|
| getTOC | //none// | array | Get an array of lines from the table of contents. | | | getTOC | //none// | array | Get an array of lines from the table of contents. | |
| getTargetAudienceNotes | //none// | array | Get an array of note about the record's target audience. | | | getTargetAudienceNotes | //none// | array | Get an array of note about the record's target audience. | |
| getThumbnail | $size (array) | string/array/bool | Returns one of three things: a full URL to a thumbnail preview of the record if an image is available in an external system; an array of parameters to send to VuFind's internal cover generator if no fixed URL exists; or false if no thumbnail can be generated. \\ You can enable icons by including the parameter 'contenttype' (e.g. the record's format) in the returned array of parameters. VuFind will try to retrieve a cover based on the parameters but will fallback to icons if no cover can be found - if only parameters 'size' and 'contenttype' are returned display of icons is enforced (make sure that the icons are exactly named after the contenttypes, including case sensitivity, and reside in the theme's images/{$size}/ folder). For an example implementation refer to the Summon.php RecordDriver. \\ \\ $size - Size of thumbnail (small, medium or large -- small is default). | | | getThumbnail | $size (array) | string/array/bool | Returns one of three things: a full URL to a thumbnail preview of the record if an image is available in an external system; an array of parameters to send to VuFind's internal cover generator if no fixed URL exists; or false if no thumbnail can be generated. \\ You can enable icons by including the parameter 'contenttype' (e.g. the record's format) in the returned array of parameters. VuFind will try to retrieve a cover based on the parameters but will fallback to icons if no cover can be found - if only parameters 'size' and 'contenttype' are returned display of icons is enforced (make sure that the icons are exactly named after the contenttypes, including case sensitivity, and reside in the theme's images/{$size}/ folder, but do not add the extension of the icon file to the contenttype). For an example implementation refer to the Summon.php RecordDriver. \\ \\ $size - Size of thumbnail (small, medium or large -- small is default). | |
| getTitle | //none// | string | Get the full title of the record. | | | getTitle | //none// | string | Get the full title of the record. | |
| getTitleSection | //none// | string | Get the text of the partsection portion of the title. | | | getTitleSection | //none// | string | Get the text of the partsection portion of the title. | |