About Features Downloads Getting Started Documentation Events Support GitHub

Site Tools


legacy:vufind_1.x_developer_manual:building_a_link_resolver_driver

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
legacy:vufind_1.x_developer_manual:building_a_link_resolver_driver [2015/12/09 20:53]
demiankatz ↷ Page moved from building_a_link_resolver_driver to legacy:vufind_1.x_developer_manual:building_a_link_resolver_driver
legacy:vufind_1.x_developer_manual:building_a_link_resolver_driver [2018/12/19 14:14] (current)
demiankatz
Line 1: Line 1:
 ====== Link Resolver Driver ====== ====== Link Resolver Driver ======
  
-// IMPORTANT: ​This page refers ​to features that were added in VuFind 1.1.  If you are using an earlier version, you will have to [[legacy:​installation:​migration_notes#​upgrading_1.0.x_to_1.1|upgrade]]. ​ For details on VuFind 2.x drivers, see the current ​[[development:​plugins:​link_resolver_drivers|Link Resolver Drivers]] page// +// This outdated ​page has been deleted ​to prevent confusion; for current documentation, see [[development:​plugins:​link_resolver_drivers|this page]]. To view old content ​for historical interest, see the "Old Revisions" ​list below. //
- +
-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 web/​conf/​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 ===== +
- +
-==== fetchLinks ==== +
- +
-This method takes an OpenURL as a parameter and retrieves details from the link resolver. +
- +
-==== parseLinks ==== +
- +
-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) +
legacy/vufind_1.x_developer_manual/building_a_link_resolver_driver.txt · Last modified: 2018/12/19 14:14 by demiankatz