Warning: This page has not been updated in over over a year and may be outdated or deprecated.
development:plugins:link_resolver_drivers
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
development:plugins:link_resolver_drivers [2016/02/09 18:37] – [parseLinks] demiankatz | development:plugins:link_resolver_drivers [2017/02/08 14:36] – demiankatz | ||
---|---|---|---|
Line 21: | Line 21: | ||
===== Basic Structure ===== | ===== Basic Structure ===== | ||
- | * The PHP driver class must be registered in the service locator with the value used as the the resolver setting in the [OpenURL] section of web/conf/config.ini. | + | * The PHP driver class must be registered in the service locator with the value used as the the resolver setting in the [OpenURL] section of [[configuration: |
+ | * The driver class must implement the VuFind\Resolver\Driver\DriverInterface. For convenience, | ||
===== Key Methods ===== | ===== Key Methods ===== | ||
Line 28: | Line 29: | ||
This method takes an OpenURL as a parameter and retrieves details from the link resolver. | This method takes an OpenURL as a parameter and retrieves details from the link resolver. | ||
+ | |||
+ | ==== getResolverUrl ==== | ||
+ | |||
+ | :!: Introduced in VuFind 4.0 | ||
+ | |||
+ | This method takes an OpenURL as a parameter and returns a URL for accessing that item in the link resolver' | ||
==== parseLinks ==== | ==== parseLinks ==== | ||
Line 38: | Line 45: | ||
* service_type - used to categorize links (getHolding = local print holding, getWebService = special service related to item, getDOI = DOI link, getFullTxt = electronic holding) | * service_type - used to categorize links (getHolding = local print holding, getWebService = special service related to item, getDOI = DOI link, getFullTxt = electronic holding) | ||
* access - used to style links according to their access-status (if supported by the link resolver driver - available status: open, limited, denied, unknown), style classes are named access-{status} in template ajax/ | * access - used to style links according to their access-status (if supported by the link resolver driver - available status: open, limited, denied, unknown), style classes are named access-{status} in template ajax/ | ||
+ | |||
+ | ==== supportsMoreOptionsLink ==== | ||
+ | |||
+ | :!: Introduced in VuFind 4.0 | ||
+ | |||
+ | This method returns true when the direct link provided by getResolverUrl offers a human-friendly interface; it should return false if the link resolver offers a data-only interface (for example, in the case of EZB). | ||
---- struct data ---- | ---- struct data ---- | ||
---- | ---- | ||
development/plugins/link_resolver_drivers.txt · Last modified: 2023/11/27 18:48 by demiankatz