VuFind API Documentation

Helpers

Interfaces, Classes, Traits and Enums

RemoteAddressFactory
RemoteAddress utility factory.
SearchTabsHelper
"Search tabs" helper
ReCaptcha
Recaptcha service
AbstractLayoutClass
Helper class for managing high-level (body vs. sidebar) page layout.
AbstractSearch
Helper class for displaying search-related HTML chunks.
BulkAction
Bulk action view helper
CopyToClipboardButton
Class CopyClipboardButton
Flashmessages
Flash message view helper
Highlight
Highlight view helper
LayoutClass
Helper class for managing bootstrap theme's high-level (body vs. sidebar) page layout.
LayoutClassFactory
LayoutClass helper factory.
Search
Helper class for displaying search-related HTML chunks.
AbstractJsStrings
AbstractJsStrings helper for passing transformed text to Javascript
AccountCapabilities
AccountCapabilities view helper
AccountCapabilitiesFactory
AccountCapabilities helper factory.
AddEllipsis
"Add ellipsis" view helper
AddThis
AddThis view helper
AddThisFactory
AddThis helper factory.
AlphaBrowse
Authentication view helper
AlphaBrowseFactory
AlphaBrowse helper factory.
Auth
Authentication view helper
AuthFactory
Auth helper factory.
Browse
Browse controller view helper
BulkAction
Bulk action view helper
BulkActionFactory
BulkAction helper factory.
Captcha
Captcha view helper
CaptchaFactory
Captcha helper factory.
Cart
Cart view helper
CartFactory
Cart helper factory.
Citation
Citation view helper
CitationFactory
Citation helper factory.
Component
Component view helper
Config
Config view helper
ConfigFactory
Config helper factory.
Content
Content View Helper to resolve translated pages.
ContentBlock
ContentBlock view helper
ContentFactory
Content helper factory.
ContentLoader
Content loader view helper
ContentLoaderFactory
ContentLoader helper factory.
Context
Context manager (useful for using render() instead of partial() for better performance -- this allows us to set and roll back variables in the global scope instead of relying on the overhead of building a whole new scope).
CookieConsent
CookieConsent view helper
CookieConsentFactory
CookieConsent helper factory.
Csp
Content Security Policy view helper
CspFactory
CSP helper factory.
CspNonce
CSP nonce view helper
CspNonceFactory
CSP nonce helper factory.
CurrentPath
Current path view helper
DateTime
View helper for formatting dates and times
DateTimeFactory
DateTime helper factory.
DisplayLanguageOption
DisplayLanguageOption view helper
DisplayLanguageOptionFactory
DisplayLanguageOption helper factory.
Doi
DOI view helper
DoiFactory
DOI helper factory.
ExplainElement
Explain element view helper
Export
Export view helper
ExportFactory
Export helper factory.
Feedback
This is a helper that lets the layout know whether or not to include the feedback tab
FeedbackFactory
Feedback helper factory.
Flashmessages
Flash message view helper
FlashmessagesFactory
Flashmessages helper factory.
GeoCoords
GeoCoords view helper
GeoCoordsFactory
GeoCoords helper factory.
GoogleAnalytics
GoogleAnalytics view helper
GoogleAnalyticsFactory
GoogleAnalytics helper factory.
GoogleTagManager
GoogleTagManager view helper
GoogleTagManagerFactory
GoogleTagManager helper factory.
HeadTitleFactory
HeadTitle helper factory.
HelpText
"Load help text" view helper
HelpTextFactory
HelpText helper factory.
Highlight
Highlight view helper
HistoryLabel
"Search history label" view helper
HistoryLabelFactory
HistoryLabel helper factory.
Holdings
View helper to support ILS holdings display
HoldingsFactory
Holdings helper factory.
HtmlSafeJsonEncode
HTML-safe JSON encoding.
Icon
Icon view helper
IconFactory
Icon helper factory.
Ils
ILS (integrated library system) view helper
IlsFactory
Ils helper factory.
JsIcons
JsIcons helper for passing icon HTML to Javascript
JsIconsFactory
JsIcons helper factory.
JsTranslations
JsTranslations helper for passing translation text to Javascript
JsTranslationsFactory
JsTranslations helper factory.
KeepAlive
KeepAlive view helper
KeepAliveFactory
KeepAlive helper factory.
Linkify
Linkify a string so that the links become clickable HTML
LinkifyFactory
Linkify helper factory
LocalizedNumber
Class NumberFormat allows localization based formatting of numbers in view
MakeLink
Make link view helper
MakeTag
Make tag view helper
Markdown
Helper for transforming markdown to html
MarkdownFactory
Markdown helper factory
Matomo
Matomo web analytics view helper for Matomo versions >= 4
MatomoFactory
Matomo helper factory.
OpenUrl
OpenUrl view helper
OpenUrlFactory
OpenUrl helper factory.
OperatorToFieldPrefix
OperatorToFieldPrefix view helper
Overdrive
Overdrive view helper
OverdriveFactory
Overdrive helper factory.
Permission
Permission helper
PermissionFactory
Permission helper factory.
Piwik
Piwik Web Analytics view helper
PiwikFactory
Piwik helper factory.
PrintArrayHtml
View helper to print an array formatted for HTML display.
Printms
Prints a human readable format from a number of milliseconds
ProxyUrl
Proxy URL view helper
ProxyUrlFactory
ProxyUrl helper factory.
Recommend
Recommendation module view helper
Record
Record driver view helper
SpecBuilder
Specification builder for record driver data formatting view helper
RecordDataFormatter
Record driver data formatting view helper
RecordDataFormatterFactory
Factory for record driver data formatting view helper
RecordFactory
Record helper factory.
RecordLinker
Record linker view helper
RecordLinkerFactory
RecordLinker helper factory.
Relais
Relais view helper
RelaisFactory
Relais helper factory.
Related
Related records view helper
RelatedFactory
Related helper factory.
RenderArray
View helper to render a portion of an array.
ResultFeed
"Results as feed" view helper
ResultFeedFactory
ResultFeed helper factory.
SafeMoneyFormat
Safe money format view helper
SafeMoneyFormatFactory
SafeMoneyFormat helper factory.
SearchBox
Search box view helper
SearchBoxFactory
SearchBox helper factory.
SearchMemory
View helper for remembering recent user searches/parameters.
SearchMemoryFactory
SearchMemory helper factory.
SearchOptions
"Retrieve search options" view helper
SearchOptionsFactory
SearchOptions helper factory.
SearchParams
"Retrieve search params" view helper
SearchParamsFactory
SearchParams helper factory.
SearchSettings
Search settings view helper
SearchSettingsFactory
SearchSettings helper factory.
SearchTabs
"Search tabs" view helper
SearchTabsFactory
SearchTabs helper factory.
ServerUrlFactory
ServerUrl helper factory.
Session
Session view helper
SessionFactory
Session helper factory.
ShortenUrl
View helper for formatting dates and times
ShortenUrlFactory
ShortenUrl helper factory.
SorterFactory
Class SorterFactory
SortFacetList
Sort facet list view helper
SortFacetListFactory
Class SortFacetListFactory
SyndeticsPlus
SyndeticsPlus view helper
SyndeticsPlusFactory
SyndeticsPlus helper factory.
SystemEmail
System contact email helper.
SystemEmailFactory
SystemEmail helper factory.
ThemeConfig
Theme config view helper
ThemeConfigFactory
Icon helper factory.
TransEsc
Translate + escape view helper
TransEscAttr
Translate + escape view helper for HTML attributes
TransEscWithPrefix
Translate with prefix + escape view helper
Translate
Translate view helper
TranslationEmpty
Helper to check if a translation is empty
Truncate
Truncate view helper
Url
Url view helper (extending core Laminas helper with additional functionality)
UrlFactory
Url helper factory.
UserList
List view helper
UserListFactory
UserList helper factory.
UserTags
Tag view helper
UserTagsFactory
UserTags helper factory.
CSS
CSS minifier extensions
PathConverter
CSS path converter extension
FootScript
Footer script view helper (same as HeadScript but outputs to the bottom of <body>)
HeadLink
Head link view helper (extended for VuFind's theme system)
HeadScript
Head script view helper (extended for VuFind's theme system)
ImageLink
Image link view helper (extended for VuFind's theme system)
InlineScript
Inline script view helper (extended for VuFind's theme system)
ParentTemplate
Helper to get path to a parent template (for including)
ParentTemplateFactory
ParentTemplate helper factory.
SetupThemeResources
View helper for loading theme-related resources.
Slot
Slot view helper
TemplatePath
Helper to get path to a template from another theme (for including)
TemplatePathFactory
TemplatePath helper factory.
AccountMenu
Account menu view helper
AccountMenuFactory
Account menu view helper factory
VerbosityTrait
Trait to add configurable verbosity settings to loggers
ClassBasedTemplateRendererTrait
Trait for view helpers that render a template based on a class name.
ConcatTrait
Trait to add asset pipeline functionality (concatenation / minification) to a HeadLink/HeadScript-style view helper.

Search results