Warning: This page has not been updated in over over a year and may be outdated or deprecated.
development:plugins:ils_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:ils_drivers [2021/06/08 16:53] – [getStatus] demiankatz | development:plugins:ils_drivers [2021/08/27 10:36] – [getConfig] emaijala | ||
---|---|---|---|
Line 32: | Line 32: | ||
This method cancels a list of holds for a specific patron. (optional) | This method cancels a list of holds for a specific patron. (optional) | ||
- | * Input: cancelDetails An associative array with two keys: patron (array returned by the driver' | + | * Input: cancelDetails An associative array with two keys: patron (array returned by the driver' |
* Output: Associative array containing: | * Output: Associative array containing: | ||
* count – The number of items successfully cancelled | * count – The number of items successfully cancelled | ||
Line 119: | Line 119: | ||
==== getCancelHoldDetails ==== | ==== getCancelHoldDetails ==== | ||
- | This method returns a string to use as the input form value for cancelling each hold item. (optional, but required if you implement cancelHolds). // Not supported prior to VuFind 1.2 // | + | This method returns a string to use as the input form value for cancelling each hold item. If determining this identifier does not require complex calculations, |
* Input: | * Input: | ||
Line 173: | Line 173: | ||
* consortium (optional) - Boolean true or false (default): Does this driver provide consortial capabilities (e.g., XCNCIP2 driver)? If set to true, then the driver method getConsortialHoldings() will be called in order to to provide multiple Holding statuses in a consortial environment; | * consortium (optional) - Boolean true or false (default): Does this driver provide consortial capabilities (e.g., XCNCIP2 driver)? If set to true, then the driver method getConsortialHoldings() will be called in order to to provide multiple Holding statuses in a consortial environment; | ||
* itemLimit (optional, deprecated) - This setting was used here in VuFind 6.0.x; it was moved to Holdings (see above) with release 6.1, but is still supported here for backward compatibility. | * itemLimit (optional, deprecated) - This setting was used here in VuFind 6.0.x; it was moved to Holdings (see above) with release 6.1, but is still supported here for backward compatibility. | ||
- | * updateFields (optional) - (From VuFind 8.0) A colon-separated list of form fields to include in the update holds form; may include " | + | |
+ | * helpText[*] - (From VuFind 8.0) A default help text displayed on the hold request form if not overridden. Displayed as is; HTML tags can be used, and everything needs to be properly escaped. | ||
+ | * helpText[lng] - A language-specific help text displayed on the hold request form. Displayed as is; HTML tags can be used, and everything needs to be properly escaped. | ||
+ | * updateHelpText[*] - (From VuFind 8.0) A default help text displayed on the hold update form. Displayed as is; HTML tags can be used, and everything needs to be properly escaped. | ||
+ | * updateHelpText[lng] - (From VuFind 8.0) A language-specific help text displayed on the hold update form. Displayed as is; HTML tags can be used, and everything needs to be properly escaped. | ||
+ | | ||
* Array keys used for input of " | * Array keys used for input of " | ||
Line 183: | Line 188: | ||
* defaultRequiredDate - A colon-separated list used to set the default "not required after" date for requests in the format days: | * defaultRequiredDate - A colon-separated list used to set the default "not required after" date for requests in the format days: | ||
* This only applies if extraFields includes " | * This only applies if extraFields includes " | ||
- | * helpText - A generic help text displayed on the request form. | + | * helpText - A generic help text displayed on the request form. Displayed as is; HTML tags can be used, and everything needs to be properly escaped. |
- | * helpText[lng] - A language-specific help text displayed on the request form. | + | * helpText[*] - (From VuFind 8.0) A default help text displayed on the request form if not overridden. Displayed as is; HTML tags can be used, and everything needs to be properly escaped. |
+ | * helpText[lng] - A language-specific help text displayed on the request form. Displayed as is; HTML tags can be used, and everything needs to be properly escaped. | ||
* Array keys used for input of " | * Array keys used for input of " | ||
Line 191: | Line 197: | ||
* defaultRequiredDate - A colon-separated list used to set the default "not required after" date for requests in the format days: | * defaultRequiredDate - A colon-separated list used to set the default "not required after" date for requests in the format days: | ||
* This only applies if extraFields includes " | * This only applies if extraFields includes " | ||
- | * helpText - A generic help text displayed on the request form. | + | * helpText - A generic help text displayed on the request form. Displayed as is; HTML tags can be used, and everything needs to be properly escaped. |
- | * helpText[lng] - A language-specific help text displayed on the request form. | + | * helpText[*] - (From VuFind 8.0) A default help text displayed on the request form if not overridden. Displayed as is; HTML tags can be used, and everything needs to be properly escaped. |
+ | * helpText[lng] - A language-specific help text displayed on the request form. Displayed as is; HTML tags can be used, and everything needs to be properly escaped. | ||
* Array keys used for input of " | * Array keys used for input of " | ||
Line 233: | Line 240: | ||
==== getHoldDefaultRequiredDate ==== | ==== getHoldDefaultRequiredDate ==== | ||
Get Default "Hold Required By" Date (optional). // Not supported until VuFind 2.3. // | Get Default "Hold Required By" Date (optional). // Not supported until VuFind 2.3. // | ||
+ | |||
+ | :!: This method is only called if the defaultRequiredDate setting in the ILS driver' | ||
+ | < | ||
+ | [Holds] | ||
+ | defaultRequiredDate = ' | ||
+ | </ | ||
* Input: Patron array returned by patronLogin method (optional), hold information array similar to placeHold' | * Input: Patron array returned by patronLogin method (optional), hold information array similar to placeHold' | ||
Line 513: | Line 526: | ||
This method returns a list of locations where a user may collect a hold. (optional) // Not supported prior to VuFind 1.2 // | This method returns a list of locations where a user may collect a hold. (optional) // Not supported prior to VuFind 1.2 // | ||
- | * Input: | + | Input: |
- | | + | |
- | | + | ^ Parameter |
- | | + | | patron |
+ | | holdDetails | ||
+ | |||
+ | Output: | ||
+ | |||
+ | ^ Key ^ Type ^ Required | ||
+ | | locationID | ||
+ | | locationDisplay | ||
==== getPurchaseHistory ==== | ==== getPurchaseHistory ==== |
development/plugins/ils_drivers.txt · Last modified: 2024/06/25 13:35 by demiankatz