VuFind API Documentation

AccountCapabilities
in package

Class to determine which account capabilities are available, based on configuration and other factors.

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 Site

Table of Contents

$authCallback  : callable
Function to fetch auth manager
$config  : Config
__construct()  : mixed
Constructor
getCommentSetting()  : string
Get comment setting.
getListSetting()  : string
Get list setting.
getListTagSetting()  : string
Get list tag setting.
getSavedSearchSetting()  : string
Get saved search setting.
getSmsSetting()  : string
Get SMS setting ('enabled' or 'disabled').
getTagSetting()  : string
Get tag setting.
isRatingRemovalAllowed()  : bool
Check if record ratings can be removed
isScheduledSearchEnabled()  : bool
Is scheduled search enabled?
libraryCardsEnabled()  : bool
Are library cards enabled and supported?
getAuth()  : Manager
Get authentication manager
isAccountAvailable()  : bool
Is a user account capable of saving data currently available?

Properties

Methods

__construct()

Constructor

public __construct(Config $config, callable $getAuth) : mixed
Parameters
$config : Config

Top-level configuration

$getAuth : callable

Function to fetch auth manager

Return values
mixed

getCommentSetting()

Get comment setting.

public getCommentSetting() : string
Return values
string

getListSetting()

Get list setting.

public getListSetting() : string
Return values
string

getListTagSetting()

Get list tag setting.

public getListTagSetting() : string
Return values
string

getSavedSearchSetting()

Get saved search setting.

public getSavedSearchSetting() : string
Return values
string

getSmsSetting()

Get SMS setting ('enabled' or 'disabled').

public getSmsSetting() : string
Return values
string

getTagSetting()

Get tag setting.

public getTagSetting() : string
Return values
string

isRatingRemovalAllowed()

Check if record ratings can be removed

public isRatingRemovalAllowed() : bool
Return values
bool

isScheduledSearchEnabled()

Is scheduled search enabled?

public isScheduledSearchEnabled() : bool
Return values
bool

libraryCardsEnabled()

Are library cards enabled and supported?

public libraryCardsEnabled() : bool
Return values
bool

isAccountAvailable()

Is a user account capable of saving data currently available?

protected isAccountAvailable() : bool
Return values
bool

Search results