Warning: This page has not been updated in over over a year and may be outdated or deprecated.
installation:migration_notes:service_names
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
installation:migration_notes:service_names [2018/01/24 18:06] – [Related Record Modules] demiankatz | installation:migration_notes:service_names [2020/03/03 17:53] – [Service Name Migration] demiankatz | ||
---|---|---|---|
Line 1: | Line 1: | ||
====== Service Name Migration ====== | ====== 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. | + | In VuFind 5.0, the switch to [[development: |
===== Core Services ===== | ===== Core Services ===== | ||
Line 18: | Line 18: | ||
The names of services defined within VuFind have also changed. | The names of services defined within VuFind have also changed. | ||
+ | |||
+ | ==== Top-Level Services ==== | ||
+ | |||
+ | Services defined by VuFind within the top-level service manager now use fully qualified class names as service names, with former names set up as aliases for backward compatibility. | ||
+ | |||
+ | * VuFind\AccountCapabilities is now VuFind\Config\AccountCapabilities | ||
+ | * VuFind\AuthManager is now VuFind\Auth\Manager | ||
+ | * VuFind\AuthPluginManager is now VuFind\Auth\PluginManager | ||
+ | * VuFind\AutocompletePluginManager is now VuFind\Autocomplete\PluginManager | ||
+ | * VuFind\CacheManager is now VuFind\Cache\Manager | ||
+ | * VuFind\ChannelProviderPluginManager is now VuFind\ChannelProvider\PluginManager | ||
+ | * VuFind\Config is now VuFind\Config\PluginManager | ||
+ | * VuFind\ContentPluginManager is now VuFind\Content\PluginManager | ||
+ | * VuFind\ContentAuthorNotesPluginManager is now VuFind\Content\AuthorNotes\PluginManager | ||
+ | * VuFind\ContentCoversPluginManager is now VuFind\Content\Covers\PluginManager | ||
+ | * VuFind\ContentExcerptsPluginManager is now VuFind\Content\Excerpts\PluginManager | ||
+ | * VuFind\ContentReviewsPluginManager is now VuFind\Content\Reviews\PluginManager | ||
+ | * VuFind\ContentSummariesPluginManager is now VuFind\Content\Summaries\PluginManager | ||
+ | * VuFind\ContentTOCPluginManager is now VuFind\Content\TOC\PluginManager | ||
+ | * VuFind\CookieManager is now VuFind\Cookie\CookieManager | ||
+ | * VuFind\DateConverter is now VuFind\Date\Converter | ||
+ | * VuFind\DbAdapter is now Zend\Db\Adapter\Adapter | ||
+ | * VuFind\DbAdapterFactory is now VuFind\Db\AdapterFactory | ||
+ | * VuFind\DbRowPluginManager is now VuFind\Db\Row\PluginManager | ||
+ | * VuFind\DbTablePluginManager is now VuFind\Db\Table\PluginManager | ||
+ | * VuFind\HierarchicalFacetHelper is now VuFind\Search\Solr\HierarchicalFacetHelper | ||
+ | * VuFind\HierarchyDriverPluginManager is now VuFind\Hierarchy\Driver\PluginManager | ||
+ | * VuFind\HierarchyTreeDataFormatterPluginManager is now VuFind\Hierarchy\TreeDataFormatter\PluginManager | ||
+ | * VuFind\HierarchyTreeDataSourcePluginManager is now VuFind\Hierarchy\TreeDataSource\PluginManager | ||
+ | * VuFind\HierarchyTreeRendererPluginManager is now VuFind\Hierarchy\TreeRenderer\PluginManager | ||
+ | * VuFind\HMAC is now VuFind\Crypt\HMAC | ||
+ | * VuFind\Http is now VuFindHttp\HttpService | ||
+ | * VuFind\ILSAuthenticator is now VuFind\Auth\ILSAuthenticator | ||
+ | * VuFind\ILSConnection is now VuFind\ILS\Connection | ||
+ | * VuFind\ILSDriverPluginManager is now VuFind\ILS\Driver\PluginManager | ||
+ | * VuFind\ILSHoldLogic is now VuFind\ILS\Logic\Holds | ||
+ | * VuFind\ILSHoldSettings is now VuFind\ILS\HoldSettings | ||
+ | * VuFind\ILSTitleHoldLogic is now VuFind\ILS\Logic\TitleHolds | ||
+ | * VuFind\IpAddressUtils is now VuFind\Net\IpAddressUtils | ||
+ | * VuFind\Logger is now VuFind\Log\Logger | ||
+ | * VuFind\Mailer is now VuFind\Mailer\Mailer | ||
+ | * VuFind\ProxyConfig is now ProxyManager\Configuration | ||
+ | * VuFind\Recaptcha is now VuFind\Service\ReCaptcha | ||
+ | * VuFind\RecommendPluginManager is now VuFind\Recommend\PluginManager | ||
+ | * VuFind\RecordCache is now VuFind\Record\Cache | ||
+ | * VuFind\RecordDriverPluginManager is now VuFind\RecordDriver\PluginManager | ||
+ | * VuFind\RecordLoader is now VuFind\Record\Loader | ||
+ | * VuFind\RecordRouter is now VuFind\Record\Router | ||
+ | * VuFind\RecordTabPluginManager is now VuFind\RecordTab\PluginManager | ||
+ | * VuFind\RelatedPluginManager is now VuFind\Related\PluginManager | ||
+ | * VuFind\ResolverDriverPluginManager is now VuFind\Resolver\Driver\PluginManager | ||
+ | * VuFind\Search is now VuFindSearch\Service | ||
+ | * VuFind\SearchOptionsPluginManager is now VuFind\Search\Options\PluginManager | ||
+ | * VuFind\SearchParamsPluginManager is now VuFind\Search\Params\PluginManager | ||
+ | * VuFind\SearchResultsPluginManager is now VuFind\Search\Results\PluginManager | ||
+ | * VuFind\SearchRunner is now VuFind\Search\SearchRunner | ||
+ | * VuFind\SearchSpecsReader is now VuFind\Config\SearchSpecsReader | ||
+ | * VuFind\SearchTabsHelper is now VuFind\Search\SearchTabsHelper | ||
+ | * VuFind\SessionManager is now Zend\Session\SessionManager | ||
+ | * VuFind\SessionPluginManager is now VuFind\Session\PluginManager | ||
+ | * VuFind\SMS is now VuFind\SMS\SMSInterface | ||
+ | * VuFind\Translator is now Zend\Mvc\I18n\Translator | ||
+ | * VuFind\WorldCatUtils is now VuFind\Connection\WorldCatUtils | ||
+ | * VuFind\YamlReader is now VuFind\Config\YamlReader | ||
==== Authentication Plugins ==== | ==== Authentication Plugins ==== | ||
Line 223: | Line 287: | ||
* userlist is now VuFind\Db\Table\UserList | * userlist is now VuFind\Db\Table\UserList | ||
* userresource is now VuFind\Db\Table\UserResource | * userresource is now VuFind\Db\Table\UserResource | ||
+ | |||
+ | ==== Hierarchy Plugins ==== | ||
+ | |||
+ | With the exception of the hierarchy driver plugins, which use " | ||
+ | |||
+ | === Drivers === | ||
+ | |||
+ | * default is now VuFind\Hierarchy\Driver\HierarchyDefault | ||
+ | * flat is now VuFind\Hierarchy\Driver\HierarchyFlat | ||
+ | |||
+ | === Tree Data Formatters === | ||
+ | |||
+ | * json is now VuFind\Hierarchy\TreeDataFormatter\Json | ||
+ | * xml is now VuFind\Hierarchy\TreeDataFormatter\Xml | ||
+ | |||
+ | === Tree Data Sources === | ||
+ | |||
+ | * solr is now VuFind\Hierarchy\TreeDataSource\Solr | ||
+ | * xmlfile is now VuFind\Hierarchy\TreeDataSource\XMLFile | ||
+ | |||
+ | === Tree Renderers === | ||
+ | |||
+ | * jstree is now VuFind\Hierarchy\TreeRenderer\JSTree' | ||
==== ILS Drivers ==== | ==== ILS Drivers ==== | ||
Line 254: | Line 341: | ||
* voyagerrestful is now VuFind\ILS\Driver\VoyagerRestful | * voyagerrestful is now VuFind\ILS\Driver\VoyagerRestful | ||
* xcncip2 is now VuFind\ILS\Driver\XCNCIP2 | * xcncip2 is now VuFind\ILS\Driver\XCNCIP2 | ||
+ | |||
+ | ==== Permission Provider Plugins ==== | ||
+ | |||
+ | Permission provider service names have been changed to match the fully qualified class names of the plugins, with the old short names set up as aliases. | ||
+ | |||
+ | * ipRange is now VuFind\Role\PermissionProvider\IpRange | ||
+ | * ipRegEx is now VuFind\Role\PermissionProvider\IpRegEx | ||
+ | * role is now VuFind\Role\PermissionProvider\Role | ||
+ | * serverParam is now VuFind\Role\PermissionProvider\ServerParam | ||
+ | * shibboleth is now VuFind\Role\PermissionProvider\Shibboleth | ||
+ | * user is now VuFind\Role\PermissionProvider\User | ||
+ | * username is now VuFind\Role\PermissionProvider\Username | ||
==== Recommendation Modules ==== | ==== Recommendation Modules ==== | ||
Line 438: | Line 537: | ||
==== View Helpers ==== | ==== View Helpers ==== | ||
- | Most view helper | + | View helpers are now defined using fully qualified class names as service names. Aliases |
- | * accountcapabilities is now accountCapabilities | + | * accountcapabilities is now VuFind\View\Helper\Root\AccountCapabilities (with alias accountCapabilities) |
- | * addellipsis is now addEllipsis | + | * addellipsis is now VuFind\View\Helper\Root\AddEllipsis (with alias addEllipsis) |
- | * addthis is now addThis | + | * addthis is now VuFind\View\Helper\Root\AddThis (with alias addThis) |
- | * authornotes is now authorNotes | + | * alphabrowse is now VuFind\View\Helper\Root\AlphaBrowse |
- | * currentpath is now currentPath | + | * auth is now VuFind\View\Helper\Root\Auth |
- | * datetime is now dateTime | + | * authornotes is now VuFind\View\Helper\Root\AuthorNotes (with alias authorNotes) |
- | * displaylanguageoption is now displayLanguageOption | + | * browse is now VuFind\View\Helper\Root\Browse |
+ | * cart is now VuFind\View\Helper\Root\Cart | ||
+ | * citation is now VuFind\View\Helper\Root\Citation | ||
+ | * context is now VuFind\View\Helper\Root\Context | ||
+ | * currentpath is now VuFind\View\Helper\Root\CurrentPath (with alias currentPath) | ||
+ | * datetime is now VuFind\View\Helper\Root\DateTime (with alias dateTime) | ||
+ | * displaylanguageoption is now VuFind\View\Helper\Root\DisplayLanguageOption (with alias displayLanguageOption) | ||
+ | * export is now VuFind\View\Helper\Root\Export | ||
+ | * feedback is now VuFind\View\Helper\Root\Feedback | ||
+ | * flashmessages is now VuFind\View\Helper\Root\Flashmessages or VuFind\View\Helper\Bootstrap3\Flashmessages | ||
+ | * geocoords is now VuFind\View\Helper\Root\GeoCoords | ||
+ | * googleanalytics is now VuFind\View\Helper\Root\GoogleAnalytics | ||
* headlink is now Zend\View\Helper\HeadLink | * headlink is now Zend\View\Helper\HeadLink | ||
* headscript is now Zend\View\Helper\HeadScript | * headscript is now Zend\View\Helper\HeadScript | ||
- | * headthemeresources is now headThemeResources | + | * headthemeresources is now VuFindTheme\View\Helper\HeadThemeResources (with alias headThemeResources) |
- | * helptext is now helpText | + | * helptext is now VuFind\View\Helper\Root\HelpText (with alias helpText) |
- | * imagelink | + | * highlight |
+ | * historylabel is now VuFind\View\Helper\Root\HistoryLabel | ||
+ | * ils is now VuFind\View\Helper\Root\Ils | ||
+ | * imagelink | ||
* inlinescript is now Zend\View\Helper\InlineScript | * inlinescript is now Zend\View\Helper\InlineScript | ||
- | * jstranslations is now jsTranslations | + | * jstranslations is now VuFind\View\Helper\Root\JsTranslations (with alias jsTranslations) |
- | * keepalive is now keepAlive | + | * keepalive is now VuFind\View\Helper\Root\KeepAlive (with alias keepAlive) |
- | * layoutclass is now layoutClass | + | * layoutclass is now VuFind\View\Helper\Bootstrap3\LayoutClass (with alias layoutClass) |
- | * openurl is now openUrl | + | * localizedNumber is now VuFind\View\Helper\Root\LocalizedNumber |
- | * proxyurl is now proxyUrl | + | * openurl is now VuFind\View\Helper\Root\OpenUrl (with alias openUrl) |
- | * recorddataformatter is now recordDataFormatter | + | * permission is now VuFind\View\Helper\Root\Permission |
- | * recordlink is now recordLink | + | * piwik is now VuFind\View\Helper\Root\Piwik |
- | * renderarray is now renderArray | + | * printms is now VuFind\View\Helper\Root\Printms |
- | * safemoneyformat is now safeMoneyFormat | + | * proxyurl is now VuFind\View\Helper\Root\ProxyUrl (with alias proxyUrl) |
- | * searchmemory is now searchMemory | + | * recaptcha is now VuFind\View\Helper\Root\Recaptcha or VuFind\View\Helper\Bootstrap3\Recaptcha |
- | * searchoptions is now searchOptions | + | * recommend is now VuFind\View\Helper\Root\Recommend |
- | * searchparams is now searchParams | + | * record is now VuFind\View\Helper\Root\Record |
- | * searchtabs is now searchTabs | + | * recorddataformatter is now VuFind\View\Helper\Root\RecordDataFormatter (with alias recordDataFormatter) |
- | * sortfacetlist is now sortFacetList | + | * recordlink is now VuFind\View\Helper\Root\RecordLink (with alias recordLink) |
- | * syndeticsplus is now syndeticsPlus | + | * related is now VuFind\View\Helper\Root\Related |
- | * systememail is now systemEmail | + | * renderarray is now VuFind\View\Helper\Root\RenderArray (with alias renderArray) |
- | * transesc is now transEsc | + | * resultfeed is now VuFind\View\Helper\Root\ResultFeed |
+ | * safemoneyformat is now VuFind\View\Helper\Root\SafeMoneyFormat (with alias safeMoneyFormat) | ||
+ | * search is now VuFind\View\Helper\Bootstrap3\Search | ||
+ | * searchmemory is now VuFind\View\Helper\Root\SearchMemory (with alias searchMemory) | ||
+ | * searchoptions is now VuFind\View\Helper\Root\SearchOptions (with alias searchOptions) | ||
+ | * searchparams is now VuFind\View\Helper\Root\SearchParams (with alias searchParams) | ||
+ | * searchtabs is now VuFind\View\Helper\Root\SearchTabs (with alias searchTabs) | ||
+ | * searchbox is now VuFind\View\Helper\Root\SearchBox | ||
+ | * sortfacetlist is now VuFind\View\Helper\Root\SortFacetList (with alias sortFacetList) | ||
+ | * summaries is now VuFind\View\Helper\Root\Summaries | ||
+ | * summon is now VuFind\View\Helper\Root\Summon | ||
+ | * syndeticsplus is now VuFind\View\Helper\Root\SyndeticsPlus (with alias syndeticsPlus) | ||
+ | * systememail is now VuFind\View\Helper\Root\SystemEmail (with alias systemEmail) | ||
+ | * transesc is now VuFind\View\Helper\Root\TransEsc (with alias transEsc) | ||
+ | * translate is now VuFind\View\Helper\Root\Translate | ||
+ | * truncate is now VuFind\View\Helper\Root\Truncate | ||
+ | * userlist is now VuFind\View\Helper\Root\UserList | ||
+ | * usertags is now VuFind\View\Helper\Root\UserTags | ||
---- struct data ---- | ---- struct data ---- | ||
---- | ---- | ||
installation/migration_notes/service_names.txt · Last modified: 2020/03/03 17:57 by demiankatz