AccountCapabilities
in package
Class to determine which account capabilities are available, based on configuration and other factors.
Tags
Table of Contents
- $authCallback : callable
- Function to fetch auth manager
- $config : Config
- __construct() : mixed
- Constructor
- getCommentSetting() : string
- Get comment setting.
- getEmailActionSetting() : string
- Get email action setting ('enabled', 'require_login' or 'disabled').
- 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.
- isEmailActionAvailable() : bool
- Check if emailing of records and searches is available.
- 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
$authCallback
Function to fetch auth manager
protected
callable
$authCallback
$config
protected
Config
$config
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 —getEmailActionSetting()
Get email action setting ('enabled', 'require_login' or 'disabled').
public
getEmailActionSetting() : 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 —isEmailActionAvailable()
Check if emailing of records and searches is available.
public
isEmailActionAvailable() : bool
Return values
bool —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 —getAuth()
Get authentication manager
protected
getAuth() : Manager
Return values
Manager —isAccountAvailable()
Is a user account capable of saving data currently available?
protected
isAccountAvailable() : bool