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 revision | Next revisionBoth sides next revision | ||
development:plugins:link_resolver_drivers [2020/09/22 14:32] – demiankatz | development:plugins:link_resolver_drivers [2023/11/27 18:47] – demiankatz | ||
---|---|---|---|
Line 1: | Line 1: | ||
====== Link Resolver Drivers ====== | ====== Link Resolver Drivers ====== | ||
- | This page contains details on writing a custom driver for an OpenURL Link Resolver not already supported by VuFind. | + | 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 " | + | Note that Link Resolver Drivers are only used when the " |
===== Key Plugin Details ===== | ===== Key Plugin Details ===== | ||
Line 13: | Line 13: | ||
**Service Locator Configuration Section in module.config.php: | **Service Locator Configuration Section in module.config.php: | ||
- | **Service Manager Name for Service Locator:** VuFind\ResolverDriverPluginManager (VuFind | + | **Service Manager Name for Service Locator:** VuFind\ResolverDriverPluginManager (VuFind® |
- | See the [[development: | + | See the [[development: |
===== Basic Structure ===== | ===== Basic Structure ===== | ||
Line 30: | Line 30: | ||
==== getResolverUrl ==== | ==== getResolverUrl ==== | ||
- | :!: Introduced in VuFind | + | :!: Introduced in VuFind® |
This method takes an OpenURL as a parameter and returns a URL for accessing that item in the link resolver' | This method takes an OpenURL as a parameter and returns a URL for accessing that item in the link resolver' | ||
Line 42: | Line 42: | ||
* coverage - coverage range applicable to 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) | * 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 ==== | ==== supportsMoreOptionsLink ==== | ||
- | :!: Introduced in VuFind | + | :!: Introduced in VuFind® |
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). | 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 ---- | ||
+ | properties.Page Owner : | ||
---- | ---- | ||
development/plugins/link_resolver_drivers.txt · Last modified: 2023/11/27 18:48 by demiankatz