| Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision |
| development:architecture:record_driver_method_master_list [2016/03/18 14:39] – [Extended] demiankatz | development:architecture:record_driver_method_master_list [2018/06/25 19:44] – [Base] demiankatz |
|---|
| | ::: | $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 -- prior to VuFind 3.0, this sometimes differed from the value returned by getSourceIdentifier. :!: Deprecated as of VuFind 3.0 -- use getSourceIdentifier() instead. | | | 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. | |
| | 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. | |
