Reserves
extends AbstractPlugin
in package
Action helper to perform reserves-related actions
Tags
Table of Contents
- $searchService : Service
- Search service
- $useIndex : bool
- Do we need to use the Solr index for reserves (true) or the ILS driver (false)?
- __construct() : mixed
- Constructor
- findReserves() : array<string|int, mixed>
- Get reserve info from the catalog or Solr reserves index.
- useIndex() : bool
- Do we need to use the Solr index for reserves (true) or the ILS driver (false)?
Properties
$searchService
Search service
protected
Service
$searchService
$useIndex
Do we need to use the Solr index for reserves (true) or the ILS driver (false)?
protected
bool
$useIndex
Methods
__construct()
Constructor
public
__construct([bool $useIndex = false ][, Service $searchService = null ]) : mixed
Parameters
- $useIndex : bool = false
-
Do we need to use the Solr index for reserves (true) or the ILS driver (false)?
- $searchService : Service = null
-
Search service (only required when $useIndex is true).
Return values
mixed —findReserves()
Get reserve info from the catalog or Solr reserves index.
public
findReserves([string $course = null ][, string $inst = null ][, string $dept = null ]) : array<string|int, mixed>
Parameters
- $course : string = null
-
Course ID to use as limit (optional)
- $inst : string = null
-
Instructor ID to use as limit (optional)
- $dept : string = null
-
Department ID to use as limit (optional)
Return values
array<string|int, mixed> —useIndex()
Do we need to use the Solr index for reserves (true) or the ILS driver (false)?
public
useIndex() : bool