AccountMenu
extends AbstractHelper
in package
Account menu view helper
Tags
Table of Contents
- $config : array<string|int, mixed>
- __construct() : mixed
- Constructor
- checkCheckedout() : bool
- Check whether to show checkedout item
- checkFavorites() : bool
- Check whether to show favorites item
- checkFines() : bool
- Check whether to show fines item
- checkHistoricloans() : bool
- Check whether to show historicloans item
- checkHistory() : bool
- Check whether to show searchhistory item
- checkHolds() : bool
- Check whether to show holds item
- checkILLRequests() : bool
- Check whether to show ILLRequests item
- checkLibraryCards() : bool
- Check whether to show librarycards item
- checkLogout() : bool
- Check whether to show logout item
- checkOverdrive() : bool
- Check whether to show overdrive item
- checkStorageRetrievalRequests() : bool
- Check whether to show storageRetrievalRequests item
- finesIcon() : string
- Create icon name for fines item
- getItems() : array<string|int, mixed>
- Get available menu items
- render() : string
- Render account menu
- checkIlsCapability() : bool
- Check ILS connection capability
- checkIlsFunction() : bool
- Check ILS function capability
- getAuthHelper() : Auth
- Get authentication view helper
- getCapabilityParams() : array<string|int, mixed>
- Get params for checking ILS capability/function
- getDefaultItems() : array<string|int, mixed>
- Get default menu items
- getIlsConnection() : Connection
- Get ILS connection view helper
- getUser() : UserEntityInterface|null
- Get authenticated user
- isIlsOnline() : bool
- Check whether the ILS connection is available
Properties
$config
protected
array<string|int, mixed>
$config
Methods
__construct()
Constructor
public
__construct(array<string|int, mixed> $config) : mixed
Parameters
- $config : array<string|int, mixed>
-
AccountMenu configuration
Return values
mixed —checkCheckedout()
Check whether to show checkedout item
public
checkCheckedout() : bool
Return values
bool —checkFavorites()
Check whether to show favorites item
public
checkFavorites() : bool
Return values
bool —checkFines()
Check whether to show fines item
public
checkFines() : bool
Return values
bool —checkHistoricloans()
Check whether to show historicloans item
public
checkHistoricloans() : bool
Return values
bool —checkHistory()
Check whether to show searchhistory item
public
checkHistory() : bool
Return values
bool —checkHolds()
Check whether to show holds item
public
checkHolds() : bool
Return values
bool —checkILLRequests()
Check whether to show ILLRequests item
public
checkILLRequests() : bool
Return values
bool —checkLibraryCards()
Check whether to show librarycards item
public
checkLibraryCards() : bool
Return values
bool —checkLogout()
Check whether to show logout item
public
checkLogout() : bool
Return values
bool —checkOverdrive()
Check whether to show overdrive item
public
checkOverdrive() : bool
Return values
bool —checkStorageRetrievalRequests()
Check whether to show storageRetrievalRequests item
public
checkStorageRetrievalRequests() : bool
Return values
bool —finesIcon()
Create icon name for fines item
public
finesIcon() : string
Return values
string —getItems()
Get available menu items
public
getItems() : array<string|int, mixed>
Return values
array<string|int, mixed> —render()
Render account menu
public
render(string $activeItem[, string $idPrefix = '' ]) : string
Parameters
- $activeItem : string
-
The name of current active item
- $idPrefix : string = ''
-
Element ID prefix
Return values
string —checkIlsCapability()
Check ILS connection capability
protected
checkIlsCapability(string $capability) : bool
Parameters
- $capability : string
-
Name of then ILS method to check
Return values
bool —checkIlsFunction()
Check ILS function capability
protected
checkIlsFunction(string $function) : bool
Parameters
- $function : string
-
The name of the ILS function to check.
Return values
bool —getAuthHelper()
Get authentication view helper
protected
getAuthHelper() : Auth
Return values
Auth —getCapabilityParams()
Get params for checking ILS capability/function
protected
getCapabilityParams() : array<string|int, mixed>
Return values
array<string|int, mixed> —getDefaultItems()
Get default menu items
protected
getDefaultItems() : array<string|int, mixed>
Return values
array<string|int, mixed> —getIlsConnection()
Get ILS connection view helper
protected
getIlsConnection() : Connection
Return values
Connection —getUser()
Get authenticated user
protected
getUser() : UserEntityInterface|null
Return values
UserEntityInterface|null —Object if user is logged in, null otherwise.
isIlsOnline()
Check whether the ILS connection is available
protected
isIlsOnline() : bool