This is an old revision of the document!

Service Name Migration

In VuFind 5.0, the switch to Zend ServiceManager v3 means that internal service names are now case-sensitive. This requires some changes. This page documents pre-5.0 service names and post-5.0 equivalents to help you update your local code.

Core Services

The way VuFind addresses some core Zend services has changed.

Zend Framework

viewmanager is now ViewManager

Zend Translator Plugins

extendedini is now ExtendedIni

VuFind Services

The names of services defined within VuFind have also changed.

Controller Plugins

When overriding core Zend plugins, we now need to use the canonical class name for the plugin. For now, we're still using short names for VuFind-specific plugins.

flashmessenger is now Zend\Mvc\Plugin\FlashMessenger\FlashMessenger
newitems is now newItems
result-scroller is now resultScroller

Controllers

VuFind's controller service names now need to match the fully-qualified class names of the controllers while providing aliases that match routes in a case-sensitive fashion. By default, camelCase and lowercase aliases are provided for most controllers by default. Several modules have had to be adjusted; all of the services are listed alphabetically here.

admin is now VuFindAdmin\Controller\AdminController
adminconfig is now VuFindAdmin\Controller\ConfigController
adminmaintenance is now VuFindAdmin\Controller\MaintenanceController
adminsocial is now VuFindAdmin\Controller\SocialController
adminstatistics is now VuFindAdmin\Controller\StatisticsController
admintags is now VuFindAdmin\Controller\TagsController
ajax is now VuFind\Controller\AjaxController
alphabrowse is now VuFind\Controller\AlphabrowseController
api is now VuFindApi\Controller\ApiController
author is now VuFind\Controller\AuthorController
authority is now VuFind\Controller\AuthorityController
browse is now VuFind\Controller\BrowseController
browzine is now VuFind\Controller\BrowZineController
cart is now VuFind\Controller\CartController
channels is now VuFind\Controller\ChannelsController
collection is now VuFind\Controller\CollectionController
collections is now VuFind\Controller\CollectionsController
combined is now VuFind\Controller\CombinedController
confirm is now VuFind\Controller\ConfirmController
content is now VuFind\Controller\ContentController
cover is now VuFind\Controller\CoverController
devtools is now VuFindDevTools\Controller\DevtoolsController
eds is now VuFind\Controller\EdsController
edsrecord is now VuFind\Controller\EdsrecordController
eit is now VuFind\Controller\EITController
eitrecord is now VuFind\Controller\EITrecordController
error is now VuFind\Controller\ErrorController
externalauth is now VuFind\Controller\ExternalAuthController
feedback is now VuFind\Controller\FeedbackController
help is now Help
hierarchy is now Hierarchy
install is now Install
libguides is now LibGuides
librarycards is now LibraryCards
missingrecord is now MissingRecord
my-research is now MyResearch
oai is now OAI
pazpar2 is now Pazpar2
primo is now Primo
primorecord is now PrimoRecord
qrcode is now QRCode
record is now Record
records is now Records
search is now Search
searchapi is now VuFindApi\Controller\SearchApiController
shibbolethlogoutnotification is now ShibbolethLogoutNotification
summon is now Summon
summonrecord is now SummonRecord
tag is now Tag
upgrade is now Upgrade
web is now Web
worldcat is now Worldcat
worldcatrecord is now WorldcatRecord

View Helpers

Most view helper service names have been updated to match the case with which they are invoked. When overriding core Zend helpers, we now need to use the canonical class name for the helper.

accountcapabilities is now accountCapabilities
addellipsis is now addEllipsis
addthis is now addThis
authornotes is now authorNotes
currentpath is now currentPath
datetime is now dateTime
displaylanguageoption is now displayLanguageOption
headlink is now Zend\View\Helper\HeadLink
headscript is now Zend\View\Helper\HeadScript
headthemeresources is now headThemeResources
helptext is now helpText
imagelink is now imagelink
inlinescript is now Zend\View\Helper\InlineScript
jstranslations is now jsTranslations
keepalive is now keepAlive
layoutclass is now layoutClass
openurl is now openUrl
proxyurl is now proxyUrl
recorddataformatter is now recordDataFormatter
recordlink is now recordLink
renderarray is now renderArray
safemoneyformat is now safeMoneyFormat
searchmemory is now searchMemory
searchoptions is now searchOptions
searchparams is now searchParams
searchtabs is now searchTabs
sortfacetlist is now sortFacetList
syndeticsplus is now syndeticsPlus
systememail is now systemEmail
transesc is now transEsc

VuFind Documentation

Table of Contents