| Both sides previous revisionPrevious revisionNext revision | Previous revisionLast revisionBoth sides next revision |
| development:architecture:record_driver_method_master_list [2015/12/11 19:01] – ↷ Page moved from vufind2:record_driver_method_master_list to development:architecture:record_driver_method_master_list demiankatz | development:architecture:record_driver_method_master_list [2023/03/24 18:38] – [Base] sturkel |
|---|
| | addTags | $user (\VuFind\Db\Row\User) | void | Add tags to the record. \\ \\ $user - The user posting the tag \\ \\ $tags - The user-provided tags | | | addTags | $user (\VuFind\Db\Row\User) | void | Add tags to the record. \\ \\ $user - The user posting the tag \\ \\ $tags - The user-provided tags | |
| | ::: | $tags (array) | ::: | ::: | | | ::: | $tags (array) | ::: | ::: | |
| | getBreadcrumb | //none// | string Breadcrumb text to represent this record. | Get text that can be displayed to represent this record in breadcrumbs. | | | getBreadcrumb | //none// | string Breadcrumb text to represent this record. | Get text that can be displayed to represent this record in breadcrumbs. | |
| | getCitationFormats | //none// | array Strings representing citation formats. | Get an array of strings representing citation formats supported by this record's data (empty if none). For possible legal values, see the Citation view helper. Starting with VuFind 2.3, this list can be filtered using config.ini settings; the unfiltered list should be defined by getSupportedCitationFormats(). | | | getCitationFormats | //none// | array Strings representing citation formats. | Get an array of strings representing citation formats supported by this record's data (empty if none). For possible legal values, see the Citation view helper. Starting with VuFind 2.3, this list can be filtered using config.ini settings; the unfiltered list should be defined by getSupportedCitationFormats(). | |
| | getComments | //none// | array | Get comments associated with this record. | | | getComments | //none// | array | Get comments associated with this record. | |
| | getContainingLists | $user_id (int) | array | Get a list of lists containing this record. \\ \\ $user_id - ID of user to load tags from (null for all users) | | | getContainingLists | $user_id (int) | array | Get a list of lists containing this record. \\ \\ $user_id - ID of user to load tags from (null for all users) | |
| | getExtraDetail | $key (string) | mixed | Retrieve a piece of supplemental information stored using setExtraDetail(). \\ \\ $key - Name of stored information | | | getExtraDetail | $key (string) | mixed | Retrieve a piece of supplemental information stored using setExtraDetail(). \\ \\ $key - Name of stored information | |
| | getListNotes | $list_id (int) | array | Get notes associated with this record in user lists. \\ \\ $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) | | | getListNotes | $list_id (int) | array | Get notes associated with this record in user lists. \\ \\ $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) | |
| | ::: | $user_id (int) | ::: | ::: | | | ::: | $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). | | | 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) | ::: | ::: | | | ::: | $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') | |
| | ::: | $user_id (int) | ::: | ::: | | | ::: | $user_id (int) | ::: | ::: | |
| | ::: | $sort (string) | ::: | ::: | | | ::: | $sort (string) | ::: | ::: | |
| | getUniqueID | //none// | string Unique identifier. | Return the unique identifier of this record for retrieving additional information (like tags and user comments) from the external MySQL database. | | | getUniqueID | //none// | string Unique identifier. | Return the unique identifier of this record for retrieving additional information (like tags and user comments) from the external MySQL database. | |
| | openURLActive (deprecated) | $area (string) | bool | Does the OpenURL configuration indicate that we should display OpenURLs in the specified context? \\ \\ $area - 'results', 'record' or 'holdings' \\ :!: removed in VuFind 2.5 | | | openURLActive (deprecated) | $area (string) | bool | Does the OpenURL configuration indicate that we should display OpenURLs in the specified context? \\ \\ $area - 'results', 'record' or 'holdings' \\ :!: removed in VuFind 2.5 | |
| | replaceURLsWithOpenURL (deprecated) | //none// | bool | Should we display regular URLs when an OpenURL is present? \\ :!: removed in VuFind 2.5 | | | replaceURLsWithOpenURL (deprecated) | //none// | bool | Should we display regular URLs when an OpenURL is present? \\ :!: removed in VuFind 2.5 | |
| | saveToFavorites | $params (array) | void | Save this record to the user's favorites. \\ \\ $params - Array with some or all of these keys: <ul> <li>mytags - Tag array to associate with record (optional)<li> <li>notes - Notes to associate with record (optional)<li> <li>list - ID of list to save record into (omit to create new list)<li> <ul> \\ \\ $user - The user saving the record | | | saveToFavorites | $params (array) | void | Save this record to the user's favorites. \\ \\ $params - Array with some or all of these keys: <ul> <li>mytags - Tag array to associate with record (optional)<li> <li>notes - Notes to associate with record (optional)<li> <li>list - ID of list to save record into (omit to create new list)<li> <ul> \\ \\ $user - The user saving the record | |
| | ::: | $user (\VuFind\Db\Row\User) | ::: | ::: | | | ::: | $user (\VuFind\Db\Row\User) | ::: | ::: | |
| | setExtraDetail | $key (string) | void | Store a piece of supplemental information in the record driver. \\ \\ $key - Name of stored information \\ \\ $val - Information to store | | | setExtraDetail | $key (string) | void | Store a piece of supplemental information in the record driver. \\ \\ $key - Name of stored information \\ \\ $val - Information to store | |
| | ::: | $val (mixed) | ::: | ::: | | | ::: | $val (mixed) | ::: | ::: | |
| | setRawData | $data (mixed) | void | Set the raw data to be used by the driver. This must be called after construction but prior to using other methods. The nature of the raw data doesn't matter as long as other driver methods are able to interpret it. Most record drivers in VuFind use an associative array based on the Solr schema. | | | setRawData | $data (mixed) | void | Set the raw data to be used by the driver. This must be called after construction but prior to using other methods. The nature of the raw data doesn't matter as long as other driver methods are able to interpret it. Most record drivers in VuFind use an associative array based on the Solr schema. | |
| | supportsAjaxStatus | //none// | bool | Returns true if the record supports real-time AJAX status lookups. | | | supportsAjaxStatus | //none// | bool | Returns true if the record supports real-time AJAX status lookups. | |
| | supportsCoinsOpenUrl | //none// | bool | Returns true if OpenURLs may be used for generating [[http://ocoins.info/|COinS]] from the current record. See also supportsOpenUrl below. //Added in VuFind 2.5.// | | | supportsCoinsOpenUrl | //none// | bool | Returns true if OpenURLs may be used for generating [[http://ocoins.info/|COinS]] from the current record. See also supportsOpenUrl below. //Added in VuFind 2.5.// | |
| | supportsOpenUrl | //none// | bool | Returns true if OpenURLs may be used for linking from the current record. Setting this to false does not suppress the display of COinS (see supportsCoinsOpenUrl). //Added in VuFind 2.5.// | | | supportsOpenUrl | //none// | bool | Returns true if OpenURLs may be used for linking from the current record. Setting this to false does not suppress the display of COinS (see supportsCoinsOpenUrl). //Added in VuFind 2.5.// | |
| | tryMethod | $method (string) | mixed | Try to call the requested method and return null if it is unavailable; this is useful for checking for the existence of get methods for particular types of data without causing fatal errors. \\ \\ $method - Name of method to call. \\ \\ $params - Array of parameters to pass to method. | | | tryMethod | $method (string) | mixed | Try to call the requested method and return null if it is unavailable; this is useful for checking for the existence of get methods for particular types of data without causing fatal errors. \\ \\ $method - Name of method to call. \\ \\ $params - Array of parameters to pass to method. | |
| | ::: | $params (array) | ::: | ::: | | | ::: | $params (array) | ::: | ::: | |
| | getAccessRestrictions | //none// | array | Get access restriction notes for the record. | | | 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> | | | 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. | | | getAwards | //none// | array | Get award notes for the record. | |
| | getBibliographicLevel | //none// | string | Get the bibliographic level of the current record. | | | getBibliographicLevel | //none// | string | Get the bibliographic level of the current record. | |
| | 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. // | |
| | | 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. | | | 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. | |
| | getHumanReadablePublicationDates | //none// | array | Similar to getPublicationDates() but in some cases returns a human-readable, display-oriented string instead of a value that has been normalized to allow computer processing. Added in VuFind 2.3. | | | getHumanReadablePublicationDates | //none// | array | Similar to getPublicationDates() but in some cases returns a human-readable, display-oriented string instead of a value that has been normalized to allow computer processing. Added in VuFind 2.3. | |
| | getImageBasedOpenUrl | //none// | string | When defined, overrides getOpenUrl() for links generated using dynamically-generated OpenURL-based images (see the dynamic_graphic setting in [[..:config.ini]]). // Introduced in VuFind 2.5.// | | | getImageBasedOpenUrl | //none// | string | When defined, overrides getOpenUrl() for links generated using dynamically-generated OpenURL-based images (see the dynamic_graphic setting in [[configuration:files:config.ini]]). // Introduced in VuFind 2.5.// | |
| | getInstitutions | //none// | array | Get an array of institutions holding this record. | | | getInstitutions | //none// | array | Get an array of institutions holding this record. | |
| | getInstructor | //none// | string | Get the instructor. | | | getInstructor | //none// | string | Get the instructor. | |
| | getPlayingTimes | //none// | array | Get an array of playing times for the record (if applicable). | | | 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. | | | 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. | | | 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. | |
| | getRelationshipNotes | //none// | array | Get an array of strings describing relationships to other items. | | | 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()). | | | 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. | | | 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. | | | 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. | |
| | 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) | ::: | ::: | |
| | 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 eliminating spaces in the file name, 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. | |
| | setHierarchyDriverManager | $pm (\VuFind\Hierarchy\Driver\PluginManager) | \VuFind\RecordDriver\AbstractBase | Inject a hierarchy driver plugin manager (required for successful operation of getHierarchyDriver); implements a fluent interface. | | | setHierarchyDriverManager | $pm (\VuFind\Hierarchy\Driver\PluginManager) | \VuFind\RecordDriver\AbstractBase | Inject a hierarchy driver plugin manager (required for successful operation of getHierarchyDriver); implements a fluent interface. | |
| ---- struct data ---- | ---- struct data ---- |
| | properties.Page Owner : |
| ---- | ---- |
| |
