VuFind API Documentation

NewItems extends AbstractPlugin
in package

Action helper to perform new items-related actions

Tags
category

VuFind

author

Demian Katz demian.katz@villanova.edu

license

http://opensource.org/licenses/gpl-2.0.php GNU General Public License

link

Main Page

Table of Contents

$config  : Config
Configuration
__construct()  : mixed
Constructor
getBibIDsFromCatalog()  : array<string|int, mixed>
Figure out which bib IDs to load from the ILS.
getDefaultSort()  : string|null
Get default setting (null to use regular default).
getFundList()  : array<string|int, mixed>
Get fund list
getHiddenFilters()  : array<string|int, mixed>
Get the hidden filter settings.
getMaxAge()  : int
Get the maximum range setting (or return 0 for no limit).
getMethod()  : string
Get method setting
getRanges()  : array<string|int, mixed>
Get range settings
getResultPages()  : int
Get the result pages setting.
getSolrFilter()  : string
Get a Solr filter to limit to the specified number of days.
includeFacets()  : bool
Should we include facets in the new items search page?

Properties

$config

Configuration

protected Config $config

Methods

__construct()

Constructor

public __construct(Config $config) : mixed
Parameters
$config : Config

Configuration

Return values
mixed —

getBibIDsFromCatalog()

Figure out which bib IDs to load from the ILS.

public getBibIDsFromCatalog(Connection $catalog, Params $params, string $range, string $dept, FlashMessenger $flash) : array<string|int, mixed>
Parameters
$catalog : Connection

ILS connection

$params : Params

Solr parameters

$range : string

Range setting

$dept : string

Department setting

$flash : FlashMessenger

Flash messenger

Return values
array<string|int, mixed> —

getDefaultSort()

Get default setting (null to use regular default).

public getDefaultSort() : string|null
Return values
string|null —

getFundList()

Get fund list

public getFundList() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getHiddenFilters()

Get the hidden filter settings.

public getHiddenFilters() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getMaxAge()

Get the maximum range setting (or return 0 for no limit).

public getMaxAge() : int
Return values
int —

getMethod()

Get method setting

public getMethod() : string
Return values
string —

getRanges()

Get range settings

public getRanges() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getResultPages()

Get the result pages setting.

public getResultPages() : int
Return values
int —

getSolrFilter()

Get a Solr filter to limit to the specified number of days.

public getSolrFilter(int $range) : string
Parameters
$range : int

Days to search

Return values
string —

includeFacets()

Should we include facets in the new items search page?

public includeFacets() : bool
Return values
bool —

Search results