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 [2023/03/07 13:09] – demiankatzdevelopment:plugins:ils_drivers [2023/09/19 16:07] – [getHolding] demiankatz
Line 262: Line 262:
 ^ Key              ^ Type               ^ Required         ^ Minimum Version  ^ Description ^ ^ Key              ^ Type               ^ Required         ^ Minimum Version  ^ Description ^
 | id               | string             | yes              |                  | the RecordID that was passed in | | id               | string             | yes              |                  | the RecordID that was passed in |
-| availability     | boolean            | yes              |                  | is the item available (i.e. on the shelf and/or available for checkout)? |+| availability     | boolean/int        | yes              | * / 9.1          | is the item available (i.e. on the shelf and/or available for checkout)? See below for further information. |
 | status           | string             | yes              |                  | description of the availability status of the item | | status           | string             | yes              |                  | description of the availability status of the item |
 | location         | string             | yes              |                  | description of the physical location of the item. Note: prior to VuFind® 1.3, some drivers HTML entity encoded this string; that is incorrect behavior in VuFind® 1.3 or later -- this should be plain text, not HTML. | | location         | string             | yes              |                  | description of the physical location of the item. Note: prior to VuFind® 1.3, some drivers HTML entity encoded this string; that is incorrect behavior in VuFind® 1.3 or later -- this should be plain text, not HTML. |
Line 277: Line 277:
 | barcode          | string             | yes              |                  | the barcode number for this item (important: even if you do not have access to real barcode numbers, you may want to include dummy values, since a missing barcode will prevent some other item information from displaying in the VuFind® interface). | | barcode          | string             | yes              |                  | the barcode number for this item (important: even if you do not have access to real barcode numbers, you may want to include dummy values, since a missing barcode will prevent some other item information from displaying in the VuFind® interface). |
 | notes            | string[]           | no               | :!: deprecated in 3.0| an array of notes associated with holdings | | notes            | string[]           | no               | :!: deprecated in 3.0| an array of notes associated with holdings |
 +| holdings_id      | string             | no               |                  | the ID of the holdings record containing the current item |
 | holdings_notes   | string[]           | no               | 3.0              | an array of notes associated with holdings record containing the current item | | holdings_notes   | string[]           | no               | 3.0              | an array of notes associated with holdings record containing the current item |
 | item_notes       | string[]           | no               | 3.0              | an array of notes associated with the current item | | item_notes       | string[]           | no               | 3.0              | an array of notes associated with the current item |
Line 292: Line 293:
 | use_unknown_message | bool            | no               |                  | when set to true, will cause display of a message indicating that the status of the item is unknown. | | use_unknown_message | bool            | no               |                  | when set to true, will cause display of a message indicating that the status of the item is unknown. |
 | services          | string[]          | no               | 3.0              | this value can be used to indicate availability services (loan, presence). For now, 'services' is only used by code calling getStatus(), not getHolding(), but setting it here as well will not hurt anything and may be useful for future enhancements. See the [[#getstatus|getStatus()]] documentation for more details. | | services          | string[]          | no               | 3.0              | this value can be used to indicate availability services (loan, presence). For now, 'services' is only used by code calling getStatus(), not getHolding(), but setting it here as well will not hurt anything and may be useful for future enhancements. See the [[#getstatus|getStatus()]] documentation for more details. |
 +
 +The ''availability'' field may contain a boolean value:
 +  * true  - Item is available, and 'Available' is displayed as status
 +  * false - Item is unavailable, and the ''status'' field is used for display
 +
 +Starting with VuFind 9.1, also the following constants from ''\VuFind\ILS\Logic\ItemStatus'' class can be used, and the ''status'' field is always used for display:
 +  * STATUS_UNAVAILABLE - Item is unavailable
 +  * STATUS_AVAILABLE   - Item is available
 +  * STATUS_UNCERTAIN   - Item availability is uncertain (the item could be available e.g. only to a specific patron group)  
  
 ==== getHoldings -- DEPRECATED ==== ==== getHoldings -- DEPRECATED ====
Line 461: Line 471:
     * sort - An associative array where each key is a sort key and its value is a translation key     * sort - An associative array where each key is a sort key and its value is a translation key
     * default_sort - Default sort key      * default_sort - Default sort key 
 +  * getConfig may return also the following keys with boolean true as the value if the service supports purging of all or selected entries from the history:
 +    * purge_all - Supports purging of all entries
 +    * purge_selected - Supports purging of selected entries
   * Input: Patron array returned by patronLogin method and an array of optional parameters (keys = 'limit', 'page', 'sort').   * Input: Patron array returned by patronLogin method and an array of optional parameters (keys = 'limit', 'page', 'sort').
   * Output: Returns an array of associative arrays containing some or all of these keys:   * Output: Returns an array of associative arrays containing some or all of these keys:
Line 474: Line 487:
     * borrowingLocation - checkout location     * borrowingLocation - checkout location
     * message - message about the transaction     * message - message about the transaction
 +    * row_id - ID of the transaction history row (required if purgeTransactionHistory is enabled)
  
 ==== getMyTransactions ==== ==== getMyTransactions ====
Line 584: Line 598:
 ^ Key              ^ Type               ^ Required         ^ Minimum Version  ^ Description ^ ^ Key              ^ Type               ^ Required         ^ Minimum Version  ^ Description ^
 | id               | string             | yes              |                  | The bibliographic record ID (same as input) | | id               | string             | yes              |                  | The bibliographic record ID (same as input) |
-| availability     | boolean            | yes              |                  | is the item available (i.e. on the shelf and/or available for checkout)? |+| availability     | boolean/int        | yes              | * / 9.1          | Is the item available (i.e. on the shelf and/or available for checkout)? See the description in getHolding for further information. |
 | status           | string             | yes              |                  | description of the availability status of the item | | status           | string             | yes              |                  | description of the availability status of the item |
 | location         | string             | yes              |                  | description of the physical location of the item. Note: prior to VuFind® 1.3, some drivers HTML entity encoded this string; that is incorrect behavior in VuFind® 1.3 or later -- this should be plain text, not HTML. | | location         | string             | yes              |                  | description of the physical location of the item. Note: prior to VuFind® 1.3, some drivers HTML entity encoded this string; that is incorrect behavior in VuFind® 1.3 or later -- this should be plain text, not HTML. |
Line 611: Line 625:
  
   * Output: An array of bibliographic record IDs.   * Output: An array of bibliographic record IDs.
 +
 +==== getUrlsForRecord ====
 +This optional method (introduced in VuFind® 9.1) returns one or more ILS-specific links associated with the provided bibliographic record ID.
 +
 +  * Input: Bibliographic record ID
 +  * Output: Link data (in the same format returned by the record driver's getURLs method)
  
 ==== hasHoldings ==== ==== hasHoldings ====
Line 688: Line 708:
     * success – Boolean true or false     * success – Boolean true or false
     * sysMessage – A system supplied failure message (optional)     * sysMessage – A system supplied failure message (optional)
 +
 +==== purgeTransactionHistory ====
 +
 +// Not supported prior to VuFind® 9.1 //
 +
 +This method deletes selected entries or all entries from the transaction (checkout) history. 
 +
 +Availability of purge options in the UI is controlled by getConfig for getMyTransactionHistory returning ''purge_all = true'' and/or ''purge_selected = true''.
 +
 +Input: 
 +
 +^ Parameter        ^ Type               ^ Always Provided  ^ Minimum Version  ^ Description ^
 +| patron           | array              | Yes              |                  | Patron information from patronLogin |
 +| ids              | array or null      | No               |                  | Array of row_id's from getMyTransactionHistory or null to purge all entries from the transaction history  |
 +
 +Output: An associative array containing the following fields:
 +
 +^ Key              ^ Type               ^ Required         ^ Minimum Version  ^ Description ^
 +| success          | boolean            | Yes              |                  | Whether the purge request was successful |
 +| status           | string             | If success=false |                  | Status string containing information on why the purge request failed |
 +| sysMessage       | string             | No               |                  | System message that can be displayed to the user to further explain the reason for a failure |
  
 ==== renewMyItems ==== ==== renewMyItems ====
development/plugins/ils_drivers.txt · Last modified: 2024/06/25 13:35 by demiankatz