Differences

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

--- development:architecture:record_driver_method_master_list [2016/03/18 14:37] – [Extended] demiankatz
+++ development:architecture:record_driver_method_master_list [2018/06/25 19:44] – [Base] demiankatz
@@ 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 71: / Line 71: @@
 | getCorporateAuthor  |  //none//  | string  | Get the main corporate author (if any) for the record. :!: Removed in VuFind 3.0. |
 | getCorporateAuthors  |  //none//  | array  | Get the corporate authors (if any) for the record. // Introduced in VuFind 3.0. // |
+| getCorporateAuthorRoles  |  //none//  | array  | Get the roles of corporate authors (if any) for the record. // Introduced in VuFind 3.0. // |
 | getCourse  |  //none//  | string  | Get the course.  |
 | getCourseId  |  //none//  | string  | Get the course ID.  |
@@ Line 121: / Line 122: @@
 | getPlayingTimes  |  //none//  | array  | Get an array of playing times for the record (if applicable).  |
 | getPreviousTitles  |  //none//  | array  | Get an array of previous titles for the record.  |
-| getPrimaryAuthor  |  //none//  | string  | Get the main author of the record.  |
+| getPrimaryAuthor  |  //none//  | string  | Get the main author of the record. :!: Use of this method is discouraged in VuFind 3.0 and later; use getPrimaryAuthors instead when possible. |
+| getPrimaryAuthors  |  //none//  | string  | Get the main authors of the record. // Introduced in VuFind 3.0 // |
+| getPrimaryAuthorsRoles  |  //none//  | string  | Get the roles of the main authors of the record. // Introduced in VuFind 3.0 // |
 | getPrimaryAuthorsWithHighlighting  |  //none//  | array  | Get primary author information, but with highlighting applied when applicable. // Introduced in VuFind 3.0 //  |
 | getProductionCredits  |  //none//  | array  | Get credits of people involved in production of the item.  |
@@ Line 136: / Line 139: @@
 | getRelationshipNotes  |  //none//  | array  | Get an array of strings describing relationships to other items.  |
 | getSecondaryAuthors  |  //none//  | array  | Get an array of all secondary authors (complementing getPrimaryAuthor()).  |
+| getSecondaryAuthorsRoles  |  //none//  | string  | Get the roles of the secondary authors of the record. // Introduced in VuFind 3.0 // |
 | getSeeAlso  |  //none//  | array  | Get the see also references for the record.  |
 | getSeries  |  //none//  | array  | Get an array of all series names containing the record. Array entries may  be either the name string, or an associative array with 'name' and 'number'  keys.  |