Differences

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

--- development:architecture:record_driver_method_master_list [2016/01/06 14:20] – demiankatz
+++ development:architecture:record_driver_method_master_list [2017/01/06 18:21] – [Extended] demiankatz
@@ 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 69: / Line 69: @@
 | getContainerVolume  |  //none//  | string  | Get the volume of the item that contains this record (i.e. MARC 773v of a  journal).  |
 | getContainingCollections |  //none//  | array  | Get an associative array (id => title) of collections containing this record.  |
-| getCorporateAuthor  |  //none//  | string  | Get the main corporate author (if any) for the record.  |
+| 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 97: / Line 99: @@
 | getHierarchyTrees |  $hierarchyID (string)  | associative array of hierachy trees on success (id => title), false if no hierarchies found | Get a list of hierarchy trees containing this record (optional parameter may be used to filter to a specific tree) |
 | getHierarchyType |  //none//  | string or boolean | Get the type of hierarchy used by this record (false for no hierarchy supported) |
-| getHighlightedAuthor  |  //none//  | string  | Get a highlighted author string, if available.  |
+| getHighlightedAuthor  |  //none//  | string  | Get a highlighted author string, if available. :!: Removed in VuFind 3.0 in favor of getRawAuthorHighlights() |
 | getHighlightedSnippet  |  //none//  | mixed False if no snippet found, otherwise associative array  | Pick one line from the highlighted text (if any) to use as a snippet.  |
 | getHighlightedTitle  |  //none//  | string  | Get a highlighted title string, if available.  |
@@ Line 120: / 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.  |
 | getPublicationDates  |  //none//  | array  | Get the publication dates of the record. See also getDateSpan().  |
@@ Line 126: / Line 131: @@
 | getPublicationFrequency  |  //none//  | array  | Get an array of publication frequency information.  |
 | getPublishers  |  //none//  | array  | Get the publishers of the record.  |
+| getRawAuthorHighlights  |  //none//  | Get raw highlighting information for the primary author field. // Introduced in VuFind 3.0; see also getPrimaryAuthorsWithHighlighting // |
 | getRawLCCN |  //none//  | string or bool | get non-normalized LCCN for this record (or false if none).  |
 | getRDFXML  |  //none//  | mixed XML RDF data (empty if unsupported or error).  | Get an XML RDF representation of the data in this record.  |
@@ Line 133: / 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.  |