About Features Downloads Getting Started Documentation Events Support GitHub

Love VuFind®? Consider becoming a financial supporter. Your support helps build a better VuFind®!

Site Tools


Warning: This page has not been updated in over over a year and may be outdated or deprecated.
development:plugins:link_resolver_drivers

This is an old revision of the document!


Link Resolver Driver

This page refers to VuFind 2.0 functionality; for the 1.x equivalent, see Building a Link Resolver Driver.

This page contains details on writing a custom driver for an OpenURL Link Resolver not already supported by VuFind.

Note that Link Resolver Drivers are only used when the “embed” setting is turned on in the [OpenURL] section of config.ini. This setting allows link resolver results to be directly embedded in the VuFind search page rather than opening in a separate window.

Basic Structure

  • Link Resolver Drivers are found in the web/sys/Resolver folder of the VuFind installation.
  • The PHP file containing the driver must be named for the value used as the resolver setting in the [OpenURL] section of web/conf/config.ini. (i.e. “sfx.php”).
  • The name of the class defined in the PHP file should be the resolver setting, capitalized and prefixed with “Resolver_”. (i.e. “Resolver_360link” or “Resolver_Sfx”).
  • The class must implement the ResolverInterface (found in web/sys/Resolver/Interface.php).

Key Methods

This method takes an OpenURL as a parameter and retrieves details from the link resolver.

This method takes the output of fetchLinks and parses it into an associative array with the following keys:

  • href - the link to access the resource
  • title - a text description of the resource
  • coverage - coverage range applicable to the resource
  • service_type - used to categorize links (getHolding = local print holding, getWebService = special service related to item, getDOI = DOI link, getFullTxt = electronic holding)
development/plugins/link_resolver_drivers.1347306532.txt.gz · Last modified: 2014/06/13 13:13 (external edit)