Warning: This page has not been updated in over over a year and may be outdated or deprecated.
legacy:vufind_1.x_developer_manual:building_a_link_resolver_driver
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revision | |||
legacy:vufind_1.x_developer_manual:building_a_link_resolver_driver [2015/12/09 20:53] – ↷ Page moved from building_a_link_resolver_driver to legacy:vufind_1.x_developer_manual:building_a_link_resolver_driver demiankatz | 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 outdated |
- | + | ||
- | This page contains details on writing a custom driver | + | |
- | + | ||
- | Note that Link Resolver Drivers are only used when the "embed" | + | |
- | + | ||
- | ===== 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/ | + | |
- | * The name of the class defined in the PHP file should be the resolver setting, capitalized and prefixed with " | + | |
- | * The class must implement the ResolverInterface (found in web/ | + | |
- | + | ||
- | ===== 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) | + | |
---- struct data ---- | ---- struct data ---- | ||
+ | properties.Page Owner : | ||
---- | ---- | ||
legacy/vufind_1.x_developer_manual/building_a_link_resolver_driver.txt · Last modified: 2018/12/19 14:14 by demiankatz