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 revision		Previous revision
Next revisionBoth sides next revision
development:plugins:ils_drivers [2019/10/16 12:22] – [getConfig] demiankatzdevelopment:plugins:ils_drivers [2020/03/11 15:32] – [getHolding] demiankatz
Line 232: Line 232:
  
 :!: Starting with VuFind 6.0, this method supports pagination to prevent retrieval of impractically large result sets. To support pagination, the getConfig("Holds") call must return an itemLimit value. :!: Starting with VuFind 6.0, this method supports pagination to prevent retrieval of impractically large result sets. To support pagination, the getConfig("Holds") call must return an itemLimit value.
 +
 +:!: In VuFind 6.1, the reliance on the getConfig("Holds") call for retrieving itemLimit values was revised to use the more appropriate getConfig("Holdings") call instead.
  
   * Input: RecordID, output of patronLogin (so that patron-specific data may be added to the return array), additional options (beginning in release 6.0; these may include 'page', 'itemLimit' and 'offset' parameters used for result pagination).   * Input: RecordID, output of patronLogin (so that patron-specific data may be added to the return array), additional options (beginning in release 6.0; these may include 'page', 'itemLimit' and 'offset' parameters used for result pagination).
Line 452: Line 454:
     * duedate - The item's due date (a string).     * duedate - The item's due date (a string).
     * dueTime - The item's due time (a string, optional).     * dueTime - The item's due time (a string, optional).
-    * dueStatus - A special status -- may be 'due' (for items due very soon) or 'overdue' (for overdue items). (optional).+    * dueStatus - A special status -- may be 'due' (for items due very soon) or 'overdue' (for overdue items). If this is false, empty string, or unset, VuFind will assume that items have no special status. (optional).
     * id - The bibliographic ID of the checked out item.     * id - The bibliographic ID of the checked out item.
     * source - The search backend from which the record may be retrieved (optional - defaults to Solr). // Introduced in VuFind 2.4. //     * source - The search backend from which the record may be retrieved (optional - defaults to Solr). // Introduced in VuFind 2.4. //
Line 500: Line 502:
 This method returns information on recently received issues of a serial. This method returns information on recently received issues of a serial.
  
-  * Input: Bibliogrpahic record ID+  * Input: Bibliographic record ID
   * Output: Array of associative arrays, each with a single key:   * Output: Array of associative arrays, each with a single key:
     * issue - String describing the issue     * issue - String describing the issue
Line 582: Line 584:
  
 Starting with version 4.0, VuFind uses the id field as the primary link between the ILS user and the VuFind user. The cat_username field or the field configured above is used if the user cannot be found with id. The idea is to have a more persistent link between the account (since cat_username is typically a library card, and a card may need to be changed, it's not really permanent) while allowing the existing accounts that don't yet have the id in them to be found. Starting with version 4.0, VuFind uses the id field as the primary link between the ILS user and the VuFind user. The cat_username field or the field configured above is used if the user cannot be found with id. The idea is to have a more persistent link between the account (since cat_username is typically a library card, and a card may need to be changed, it's not really permanent) while allowing the existing accounts that don't yet have the id in them to be found.
 +
 +Depending on the driver and its configuration, the username may be a library card number, an email address or another patron identifier. For instance with Alma there are a couple of different login methods, and only the regular password authentication uses the password parameter.
  
   * Input: Username, Password   * Input: Username, Password
development/plugins/ils_drivers.txt · Last modified: 2024/04/12 13:05 by demiankatz