Config
extends AbstractHelper
in package
Config view helper
Tags
Table of Contents
- $configLoader : PluginManager
- Configuration plugin manager
- $displayDateFormat : string|null
- Display date format
- $displayTimeFormat : string|null
- Display time format
- __construct() : mixed
- Config constructor.
- ajaxCoversEnabled() : bool
- Should covers be loaded via AJAX?
- alwaysDisplayIndexRecordInStaffView() : bool
- Check if index record should always be displayed (i.e. also when a format-specific template is available)
- dateFormat() : string
- Get date display format
- dateTimeFormat() : string
- Get date+time display format
- get() : Config
- Get the specified configuration.
- getHoldingsItemLimit() : int
- Should we limit the number of items displayed on the full record?
- getRecordSubjectLimit() : int
- Should we limit the number of subjects displayed on the full record?
- nonJavascriptSupportEnabled() : bool
- Is non-Javascript support enabled?
- offcanvasSide() : string|null
- Get offcanvas sidebar side
- timeFormat() : string
- Get time display format
Properties
$configLoader
Configuration plugin manager
protected
PluginManager
$configLoader
$displayDateFormat
Display date format
protected
string|null
$displayDateFormat
= null
$displayTimeFormat
Display time format
protected
string|null
$displayTimeFormat
= null
Methods
__construct()
Config constructor.
public
__construct(PluginManager $configLoader) : mixed
Parameters
- $configLoader : PluginManager
-
Configuration loader
Return values
mixed —ajaxCoversEnabled()
Should covers be loaded via AJAX?
public
ajaxCoversEnabled() : bool
Return values
bool —alwaysDisplayIndexRecordInStaffView()
Check if index record should always be displayed (i.e. also when a format-specific template is available)
public
alwaysDisplayIndexRecordInStaffView() : bool
Return values
bool —dateFormat()
Get date display format
public
dateFormat() : string
Return values
string —dateTimeFormat()
Get date+time display format
public
dateTimeFormat([string $separator = ' ' ]) : string
Parameters
- $separator : string = ' '
-
String between date and time
Return values
string —get()
Get the specified configuration.
public
get(string $config) : Config
Parameters
- $config : string
-
Name of configuration
Return values
Config —getHoldingsItemLimit()
Should we limit the number of items displayed on the full record?
public
getHoldingsItemLimit() : int
Return values
int —getRecordSubjectLimit()
Should we limit the number of subjects displayed on the full record?
public
getRecordSubjectLimit() : int
Return values
int —nonJavascriptSupportEnabled()
Is non-Javascript support enabled?
public
nonJavascriptSupportEnabled() : bool
Return values
bool —offcanvasSide()
Get offcanvas sidebar side
public
offcanvasSide() : string|null
Return values
string|null —'left', 'right' or null for no offcanvas
timeFormat()
Get time display format
public
timeFormat() : string