Differences

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

--- development:architecture:record_driver_method_master_list [2016/03/18 14:39] – [Extended] demiankatz
+++ development:architecture:record_driver_method_master_list [2019/11/05 14:26] – steinm
@@ Line 20: / Line 20: @@
 | ::: | $user_id (int)  | ::: | ::: |
 | getRawData  |  //none//  | mixed  | Get the raw data contained in the driver (primarily for use in staff view and  autocomplete; avoid using whenever possible).  |
-| getRelated  | $factory (\VuFind\Related\PluginManager)  | array  | Return an array of related record suggestion objects (implementing the  \VuFind\Related\Interface) based on the current record.   \\ \\ $factory - Related module plugin factory \\ \\ $types - Array of relationship types to load; each entry should be a partial class name (i.e. 'Similar' or 'Editions') optionally followed by a colon-separated list of parameters to pass to the constructor. If the parameter is set to null instead of an array, default settings will be loaded from config.ini.   |
+| getRelated  | $factory (\VuFind\Related\PluginManager)  | array  | Return an array of related record suggestion objects (implementing the  \VuFind\Related\Interface) based on the current record.   \\ \\ $factory - Related module plugin factory \\ \\ $types - Array of relationship types to load; each entry should be a partial class name (i.e. 'Similar' or 'Editions') optionally followed by a colon-separated list of parameters to pass to the constructor. If the parameter is set to null instead of an array, default settings will be loaded from config.ini.  :!: Removed in VuFind 5.0 (logic moved to VuFind\View\Helper\Root\Related) |
 | ::: | $types (array) | ::: | ::: |
 | getResourceSource  |  //none//  | string  | Get the source value used to identify resources of this type in the database -- prior to VuFind 3.0, this sometimes differed from the value returned by getSourceIdentifier. :!: Deprecated as of VuFind 3.0 -- use getSourceIdentifier() instead. |
@@ Line 52: / Line 52: @@
 | getAccessRestrictions  |  //none//  | array  | Get access restriction notes for the record.  |
 | getAllRecordLinks  |  //none//  | null/array  | Get all record links related to the current record. Each link is returned as  array.  NB: to use this method you must override it.  Format:  <code>  array(  array(  'title' => label_for_title  'value' => link_name  'link' => link_URI  ),  ...  )  <code>  |
-| getAllSubjectHeadings  |  //none//  | array  | Get all subject headings associated with this record. Each heading is  returned as an array of chunks, increasing from least specific to most  specific.  |
+| getAllSubjectHeadings  |  $extended (bool)  | array  | Get all subject headings associated with this record. When $extended is false (the default, and the only option prior to release 4.0), each heading is  returned as an array of chunks, increasing from least specific to most  specific. When true, each heading is returned as an associative array with heading, source and type keys. |
 | getAwards  |  //none//  | array  | Get award notes for the record.  |
 | getBibliographicLevel  |  //none//  | string  | Get the bibliographic level of the current record.  |
@@ Line 154: / Line 154: @@
 | 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.  |
-| 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.  |
 | getTitleSection  |  //none//  | string  | Get the text of the partsection portion of the title.  |