| Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision |
| development:architecture:record_driver_method_master_list [2015/12/21 16:47] – ↷ Links adapted because of a move operation demiankatz | development:architecture:record_driver_method_master_list [2016/03/18 14:37] – [Extended] demiankatz |
|---|
| | 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. | |
| | ::: | $types (array) | ::: | ::: | | | ::: | $types (array) | ::: | ::: | |
| | getResourceSource | //none// | string | Get the source value used to identify resources of this type in the database. | | | 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. | |
| | getSortTitle | //none// | string | Get a sortable title for the record (i.e. no leading articles). | | | getSortTitle | //none// | string | Get a sortable title for the record (i.e. no leading articles). | |
| | | getSourceIdentifier | //none// | string | Get the source value (search backend identifier) used to identify resources of this type in the database. | |
| | getSupportedCitationFormats | //none// | array | //Added in VuFind 2.3// - an unfiltered list of citation formats supported by this record; see getCitationFormats above for more details. | | | getSupportedCitationFormats | //none// | array | //Added in VuFind 2.3// - an unfiltered list of citation formats supported by this record; see getCitationFormats above for more details. | |
| | getTags | $list_id (int) | array | Get tags associated with this record. \\ \\ $list_id - ID of list to load tags from (null for all lists) \\ \\ $user_id - ID of user to load tags from (null for all users) \\ \\ $sort - Sort type ('count' or 'tag') | | | getTags | $list_id (int) | array | Get tags associated with this record. \\ \\ $list_id - ID of list to load tags from (null for all lists) \\ \\ $user_id - ID of user to load tags from (null for all users) \\ \\ $sort - Sort type ('count' or 'tag') | |
| | getContainerVolume | //none// | string | Get the volume of the item that contains this record (i.e. MARC 773v of a journal). | | | 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. | | | 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. // | |
| | getCourse | //none// | string | Get the course. | | | getCourse | //none// | string | Get the course. | |
| | getCourseId | //none// | string | Get the course ID. | | | getCourseId | //none// | string | Get the course ID. | |
| | 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) | | | 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) | | | 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. | | | 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. | | | getHighlightedTitle | //none// | string | Get a highlighted title string, if available. | |
| | getPreviousTitles | //none// | array | Get an array of previous titles for the record. | | | 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. | |
| | | 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. | | | 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(). | | | getPublicationDates | //none// | array | Get the publication dates of the record. See also getDateSpan(). | |
| | getPublicationFrequency | //none// | array | Get an array of publication frequency information. | | | getPublicationFrequency | //none// | array | Get an array of publication frequency information. | |
| | getPublishers | //none// | array | Get the publishers of the record. | | | 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). | | | 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. | | | getRDFXML | //none// | mixed XML RDF data (empty if unsupported or error). | Get an XML RDF representation of the data in this record. | |
| | getShortTitle | //none// | string | Get the short (pre-subtitle) title of the record. | | | getShortTitle | //none// | string | Get the short (pre-subtitle) title of the record. | |
| | getSnippetCaption | $field (string) | mixed Caption if found, false if none available. | Given a Solr field name, return an appropriate caption. \\ \\ $field - Solr field name | | | getSnippetCaption | $field (string) | mixed Caption if found, false if none available. | Given a Solr field name, return an appropriate caption. \\ \\ $field - Solr field name | |
| | getSource | //none// | string | Get the source (e.g. a particular database) of hte record. | | | getSource | //none// | string | Get the source (e.g. a particular database) of the record. | |
| | getSubfieldArray | $currentField (object) | array | Return an array of non-empty subfield values found in the provided MARC field. If $concat is true, the array will contain either zero or one entries (empty array if no subfields found, subfield values concatenated together in specified order if found). If concat is false, the array will contain a separate entry for each subfield value found. \\ \\ $currentField - Result from File_MARC::getFields. \\ \\ $subfields - The MARC subfield codes to read \\ \\ $concat - Should we concatenate subfields? | | | getSubfieldArray | $currentField (object) | array | Return an array of non-empty subfield values found in the provided MARC field. If $concat is true, the array will contain either zero or one entries (empty array if no subfields found, subfield values concatenated together in specified order if found). If concat is false, the array will contain a separate entry for each subfield value found. \\ \\ $currentField - Result from File_MARC::getFields. \\ \\ $subfields - The MARC subfield codes to read \\ \\ $concat - Should we concatenate subfields? | |
| | ::: | $subfields (array) | ::: | ::: | | | ::: | $subfields (array) | ::: | ::: | |
