About Features Downloads Getting Started Documentation Events Support GitHub

Love VuFind®? Consider becoming a financial supporter. Your support helps build a better VuFind®!

VuFind Documentation

Site Tools

You are here: start » development » plugins » ils_drivers
Trace:
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.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revisionBoth sides next revision
development:plugins:ils_drivers [2021/06/17 18:09] – [getHoldDefaultRequiredDate] emaijaladevelopment:plugins:ils_drivers [2021/08/26 11:56] – Add and update help text settings, fix available fields in updateFields emaijala
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; this feature requires that the driver implement the [[#getConsortialHoldings|getConsortialHoldings()]] method.  If set to false (or omitted), the [[#getHolding|getHolding()]] method will be called.       * 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; this feature requires that the driver implement the [[#getConsortialHoldings|getConsortialHoldings()]] method.  If set to false (or omitted), the [[#getHolding|getHolding()]] method will be called.
       * 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 "frozen", "frozenUntil" and "pickUpLocation".  Note that all parameters activated here must be processed by the updateHolds method.+      * helpText - A generic help text displayed on the hold request form. Displayed as is; HTML tags can be used, but 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, but everything needs to be properly escaped. 
 +      * updateHelpText - (From VuFind 8.0) A generic help text displayed on the hold update form. Displayed as is; HTML tags can be used, but 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, but everything needs to be properly escaped. 
 +      * updateFields (optional) - (From VuFind 8.0) A colon-separated list of form fields to include in the update holds form; may include "frozen", "frozenThrough", "startDate", "requiredByDate" and "pickUpLocation".  Note that all parameters activated here must be processed by the updateHolds method.
    
     * Array keys used for input of "Renewals"     * Array keys used for input of "Renewals"
Line 183: Line 187:
       * defaultRequiredDate - A colon-separated list used to set the default "not required after" date for requests in the format days:months:years (e.g. 0:1:0 will set a "not required after" date of 1 month from the current date).       * defaultRequiredDate - A colon-separated list used to set the default "not required after" date for requests in the format days:months:years (e.g. 0:1:0 will set a "not required after" date of 1 month from the current date).
         * This only applies if extraFields includes "requiredByDate."         * This only applies if extraFields includes "requiredByDate."
-      * 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, but everything needs to be properly escaped. 
-      * helpText[lng] - A language-specific help text displayed on the request form.+      * helpText[lng] - A language-specific help text displayed on the request form. Displayed as is; HTML tags can be used, but everything needs to be properly escaped.
  
     * Array keys used for input of "ILLRequests" (from v2.3)     * Array keys used for input of "ILLRequests" (from v2.3)
Line 191: Line 195:
       * defaultRequiredDate - A colon-separated list used to set the default "not required after" date for requests in the format days:months:years (e.g. 0:1:0 will set a "not required after" date of 1 month from the current date).       * defaultRequiredDate - A colon-separated list used to set the default "not required after" date for requests in the format days:months:years (e.g. 0:1:0 will set a "not required after" date of 1 month from the current date).
         * This only applies if extraFields includes "requiredByDate."         * This only applies if extraFields includes "requiredByDate."
-      * 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, but everything needs to be properly escaped. 
-      * helpText[lng] - A language-specific help text displayed on the request form.+      * helpText[lng] - A language-specific help text displayed on the request form. Displayed as is; HTML tags can be used, but everything needs to be properly escaped.
  
     * Array keys used for input of "changePassword" (from v2.4)     * Array keys used for input of "changePassword" (from v2.4)
development/plugins/ils_drivers.txt · Last modified: 2024/04/12 13:05 by demiankatz