About Features Downloads Getting Started Documentation Events Support GitHub

Site Tools


development:plugins:ils_drivers

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
development:plugins:ils_drivers [2020/06/03 15:40]
demiankatz [getHolding]
development:plugins:ils_drivers [2020/06/04 15:54] (current)
demiankatz [getHolding]
Line 258: Line 258:
     * is_holdable – whether or not ANY user can place a hold or recall on the item – allows system administrators to determine hold behaviour (optional; defaults to true if unset). Use this setting to indicate hold availability based on the item itself; use the addLink setting for hold availability based on the combination of the item and the current logged-in user.     * is_holdable – whether or not ANY user can place a hold or recall on the item – allows system administrators to determine hold behaviour (optional; defaults to true if unset). Use this setting to indicate hold availability based on the item itself; use the addLink setting for hold availability based on the combination of the item and the current logged-in user.
     * holdtype – the type of hold to be placed – of use for systems with multiple hold types such as "​hold"​ or "​recall"​. Prior to VuFind 4.0, a value of "​block"​ will inform the user that they cannot place a hold on the item due to account blocks (optional); starting in 4.0, the "​block"​ value was replaced with the separate getRequestBlocks method.     * holdtype – the type of hold to be placed – of use for systems with multiple hold types such as "​hold"​ or "​recall"​. Prior to VuFind 4.0, a value of "​block"​ will inform the user that they cannot place a hold on the item due to account blocks (optional); starting in 4.0, the "​block"​ value was replaced with the separate getRequestBlocks method.
-    * addLink – whether not the CURRENT user can place a hold or recall on the item – for use with drivers which can determine hold logic based on patron data; normally a boolean, but until VuFind 4.0 may be set to the special value of "​block"​ to indicate a user permission problem (optional; starting in 4.0, use the getRequestBlocks method instead). ​ Starting with VuFind 1.3, you can also use the special value of "​check"​ which will trigger an AJAX call against the checkRequestIsValid() method to allow complex link rules to be evaluated without holding up the main page load.+    * addLink – whether not the CURRENT user can place a hold or recall on the item – for use with drivers which can determine hold logic based on patron data -- i.e. only used when holds_mode is set to "​driver"​ in config.ini; normally a boolean, but until VuFind 4.0 may be set to the special value of "​block"​ to indicate a user permission problem (optional; starting in 4.0, use the getRequestBlocks method instead). ​ Starting with VuFind 1.3, you can also use the special value of "​check"​ which will trigger an AJAX call against the checkRequestIsValid() method to allow complex link rules to be evaluated without holding up the main page load.
     * item_id - the item (as opposed to bibliographic) identifier (optional)     * item_id - the item (as opposed to bibliographic) identifier (optional)
     * holdOverride - Starting with VuFind 1.3, you can use this value to override the usual config.ini Catalog:​holds_mode setting on an item-by-item basis; useful for local customizations but not recommended for generic shared driver code.  Also note that this feature only works when the Catalog:​allow_holds_override setting is turned on in config.ini.     * holdOverride - Starting with VuFind 1.3, you can use this value to override the usual config.ini Catalog:​holds_mode setting on an item-by-item basis; useful for local customizations but not recommended for generic shared driver code.  Also note that this feature only works when the Catalog:​allow_holds_override setting is turned on in config.ini.
development/plugins/ils_drivers.txt · Last modified: 2020/06/04 15:54 by demiankatz