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 revision | ||
| installation:migration_notes:service_names [2018/02/05 21:59] – [Top-Level Services] demiankatz | installation:migration_notes:service_names [2020/03/03 17:57] (current) – 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. | + | ===== 7.0 Changes ===== |
| - | ===== Core Services | + | Because of the migration from Zend Framework to [[development: |
| + | |||
| + | ===== 5.0 Changes ===== | ||
| + | |||
| + | In VuFind 5.0, the switch to [[development: | ||
| + | |||
| + | ==== Core Services ==== | ||
| The way VuFind addresses some core Zend services has changed. | The way VuFind addresses some core Zend services has changed. | ||
| - | ==== Zend Framework | + | === Zend Framework === |
| * viewmanager is now ViewManager | * viewmanager is now ViewManager | ||
| - | ==== Zend Translator Plugins | + | === Zend Translator Plugins === |
| * extendedini is now ExtendedIni | * extendedini is now ExtendedIni | ||
| - | ===== VuFind Services | + | ==== VuFind Services ==== |
| The names of services defined within VuFind have also changed. | The names of services defined within VuFind have also changed. | ||
| - | ==== Top-Level Services | + | === 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. | 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. | ||
| Line 83: | Line 89: | ||
| * VuFind\YamlReader is now VuFind\Config\YamlReader | * VuFind\YamlReader is now VuFind\Config\YamlReader | ||
| - | ==== Authentication Plugins | + | === Authentication Plugins === |
| We now use fully-qualified class names as primary service names, with the old short, lowercase names as aliases. | We now use fully-qualified class names as primary service names, with the old short, lowercase names as aliases. | ||
| Line 98: | Line 104: | ||
| * sip2 is now VuFind\Auth\SIP2 | * sip2 is now VuFind\Auth\SIP2 | ||
| - | ==== Autocomplete Plugins | + | === Autocomplete Plugins === |
| We now use fully-qualified class names as primary service names, with the old short, lowercase names as aliases. | We now use fully-qualified class names as primary service names, with the old short, lowercase names as aliases. | ||
| Line 110: | Line 116: | ||
| * tag is now VuFind\Autocomplete\Tag | * tag is now VuFind\Autocomplete\Tag | ||
| - | ==== Channel Providers | + | === Channel Providers === |
| We now use fully-qualified class names as primary service names, with the old short, lowercase names as aliases. | We now use fully-qualified class names as primary service names, with the old short, lowercase names as aliases. | ||
| Line 120: | Line 126: | ||
| * similaritems is now VuFind\ChannelProvider\SimilarItems | * similaritems is now VuFind\ChannelProvider\SimilarItems | ||
| - | ==== Controller Plugins | + | === Controller Plugins === |
| We now use fully-qualified class names as service names, with aliases for the case-sensitive short name used for invoking the plugins in controller code. | We now use fully-qualified class names as service names, with aliases for the case-sensitive short name used for invoking the plugins in controller code. | ||
| Line 138: | Line 144: | ||
| * storageRetrievalRequests is now VuFind\Controller\Plugin\StorageRetrievalRequests | * storageRetrievalRequests is now VuFind\Controller\Plugin\StorageRetrievalRequests | ||
| - | ==== Controllers | + | === Controllers === |
| VuFind' | VuFind' | ||
| Line 204: | Line 210: | ||
| * worldcatrecord is now VuFind\Controller\WorldcatrecordController | * worldcatrecord is now VuFind\Controller\WorldcatrecordController | ||
| - | ==== Content Loader Plugins | + | === Content Loader Plugins === |
| These service names now match fully qualified class names, with old short names set up as aliases. | These service names now match fully qualified class names, with old short names set up as aliases. | ||
| - | === Author Notes === | + | == Author Notes == |
| * syndetics is now VuFind\Content\AuthorNotes\Syndetics | * syndetics is now VuFind\Content\AuthorNotes\Syndetics | ||
| * syndeticsplus is now VuFind\Content\AuthorNotes\SyndeticsPlus | * syndeticsplus is now VuFind\Content\AuthorNotes\SyndeticsPlus | ||
| - | === Covers | + | == Covers == |
| * amazon is now VuFind\Content\Covers\Amazon | * amazon is now VuFind\Content\Covers\Amazon | ||
| Line 226: | Line 232: | ||
| * syndetics is now VuFind\Content\Covers\Syndetics | * syndetics is now VuFind\Content\Covers\Syndetics | ||
| - | === Excerpts | + | == Excerpts == |
| * syndetics is now VuFind\Content\Excerpts\Syndetics | * syndetics is now VuFind\Content\Excerpts\Syndetics | ||
| * syndeticsplus is now VuFind\Content\Excerpts\SyndeticsPlus | * syndeticsplus is now VuFind\Content\Excerpts\SyndeticsPlus | ||
| - | === Reviews | + | == Reviews == |
| * amazon is now VuFind\Content\Reviews\Amazon | * amazon is now VuFind\Content\Reviews\Amazon | ||
| Line 240: | Line 246: | ||
| * syndeticsplus is now VuFind\Content\Reviews\SyndeticsPlus | * syndeticsplus is now VuFind\Content\Reviews\SyndeticsPlus | ||
| - | === Summaries | + | == Summaries == |
| * syndetics is now VuFind\Content\Summaries\Syndetics | * syndetics is now VuFind\Content\Summaries\Syndetics | ||
| * syndeticsplus is now VuFind\Content\Summaries\SyndeticsPlus | * syndeticsplus is now VuFind\Content\Summaries\SyndeticsPlus | ||
| - | === Tables of Contents | + | == Tables of Contents == |
| * syndetics is now VuFind\Content\TOC\Syndetics | * syndetics is now VuFind\Content\TOC\Syndetics | ||
| * syndeticsplus is now VuFind\Content\TOC\SyndeticsPlus | * syndeticsplus is now VuFind\Content\TOC\SyndeticsPlus | ||
| - | ==== Database Row Gateways | + | === Database Row Gateways === |
| Row gateway service names now match fully qualified class names, with old short names set up as aliases. | Row gateway service names now match fully qualified class names, with old short names set up as aliases. | ||
| Line 269: | Line 275: | ||
| * userresource is now VuFind\Db\Row\UserResource | * userresource is now VuFind\Db\Row\UserResource | ||
| - | ==== Database Table Gateways | + | === Database Table Gateways === |
| Table gateway service names now match fully qualified class names, with old short names set up as aliases. | Table gateway service names now match fully qualified class names, with old short names set up as aliases. | ||
| Line 288: | Line 294: | ||
| * userresource is now VuFind\Db\Table\UserResource | * userresource is now VuFind\Db\Table\UserResource | ||
| - | ==== Hierarchy Plugins | + | === Hierarchy Plugins === |
| With the exception of the hierarchy driver plugins, which use " | With the exception of the hierarchy driver plugins, which use " | ||
| - | === Drivers | + | == Drivers == |
| * default is now VuFind\Hierarchy\Driver\HierarchyDefault | * default is now VuFind\Hierarchy\Driver\HierarchyDefault | ||
| * flat is now VuFind\Hierarchy\Driver\HierarchyFlat | * flat is now VuFind\Hierarchy\Driver\HierarchyFlat | ||
| - | === Tree Data Formatters | + | == Tree Data Formatters == |
| * json is now VuFind\Hierarchy\TreeDataFormatter\Json | * json is now VuFind\Hierarchy\TreeDataFormatter\Json | ||
| * xml is now VuFind\Hierarchy\TreeDataFormatter\Xml | * xml is now VuFind\Hierarchy\TreeDataFormatter\Xml | ||
| - | === Tree Data Sources | + | == Tree Data Sources == |
| * solr is now VuFind\Hierarchy\TreeDataSource\Solr | * solr is now VuFind\Hierarchy\TreeDataSource\Solr | ||
| * xmlfile is now VuFind\Hierarchy\TreeDataSource\XMLFile | * xmlfile is now VuFind\Hierarchy\TreeDataSource\XMLFile | ||
| - | === Tree Renderers | + | == Tree Renderers == |
| * jstree is now VuFind\Hierarchy\TreeRenderer\JSTree' | * jstree is now VuFind\Hierarchy\TreeRenderer\JSTree' | ||
| - | ==== ILS Drivers | + | === ILS Drivers === |
| ILS driver service names have been changed to match the fully qualified class names of the plugins, with the old short names set up as aliases. | ILS driver service names have been changed to match the fully qualified class names of the plugins, with the old short names set up as aliases. | ||
| Line 342: | Line 348: | ||
| * xcncip2 is now VuFind\ILS\Driver\XCNCIP2 | * xcncip2 is now VuFind\ILS\Driver\XCNCIP2 | ||
| - | ==== Permission Provider Plugins | + | === 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. | 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. | ||
| Line 354: | Line 360: | ||
| * username is now VuFind\Role\PermissionProvider\Username | * username is now VuFind\Role\PermissionProvider\Username | ||
| - | ==== Recommendation Modules | + | === Recommendation Modules === |
| Recommendation module service names have been changed to match the fully qualified class names of the plugins, with the old short names set up as aliases. | Recommendation module service names have been changed to match the fully qualified class names of the plugins, with the old short names set up as aliases. | ||
| Line 395: | Line 401: | ||
| * worldcatidentities is now VuFind\Recommend\WorldCatIdentities | * worldcatidentities is now VuFind\Recommend\WorldCatIdentities | ||
| - | ==== Record Drivers | + | === Record Drivers === |
| Record drivers now use fully qualified class names as service names, with the previous service names set up as aliases. | Record drivers now use fully qualified class names as service names, with the previous service names set up as aliases. | ||
| Line 415: | Line 421: | ||
| * worldcat is now VuFind\RecordDriver\WorldCat | * worldcat is now VuFind\RecordDriver\WorldCat | ||
| - | ==== Record Tab Plugins | + | === Record Tab Plugins === |
| Record tab plugins now use fully qualified class names as service names, with the previous service names set up as aliases. | Record tab plugins now use fully qualified class names as service names, with the previous service names set up as aliases. | ||
| Line 435: | Line 441: | ||
| * usercomments is now VuFind\RecordTab\UserComments | * usercomments is now VuFind\RecordTab\UserComments | ||
| - | ==== Related Record Modules | + | === Related Record Modules === |
| Related record modules now use fully qualified class names as service names, with the previous service names set up as aliases. | Related record modules now use fully qualified class names as service names, with the previous service names set up as aliases. | ||
| Line 443: | Line 449: | ||
| * worldcatsimilar is now VuFind\Related\WorldCatSimilar | * worldcatsimilar is now VuFind\Related\WorldCatSimilar | ||
| - | ==== Resolver Drivers | + | === Resolver Drivers === |
| Resolver drivers now use fully qualified class names as service names, with the previous service names set up as aliases. | Resolver drivers now use fully qualified class names as service names, with the previous service names set up as aliases. | ||
| Line 453: | Line 459: | ||
| * redi is now VuFind\Resolver\Driver\Redi | * redi is now VuFind\Resolver\Driver\Redi | ||
| - | ==== Search Objects | + | === Search Objects === |
| The options, params and results objects now use fully qualified class names as service names, with the previous service names set up as aliases. | The options, params and results objects now use fully qualified class names as service names, with the previous service names set up as aliases. | ||
| - | === Options | + | == Options == |
| * browzine is now VuFind\Search\BrowZine\Options | * browzine is now VuFind\Search\BrowZine\Options | ||
| Line 480: | Line 486: | ||
| * worldcat is now VuFind\Search\WorldCat\Options | * worldcat is now VuFind\Search\WorldCat\Options | ||
| - | === Params | + | == Params == |
| * browzine is now VuFind\Search\BrowZine\Params | * browzine is now VuFind\Search\BrowZine\Params | ||
| Line 503: | Line 509: | ||
| * worldcat is now VuFind\Search\WorldCat\Params | * worldcat is now VuFind\Search\WorldCat\Params | ||
| - | === Results | + | == Results == |
| * browzine is now VuFind\Search\BrowZine\Results | * browzine is now VuFind\Search\BrowZine\Results | ||
| Line 527: | Line 533: | ||
| - | ==== Session Handlers | + | === Session Handlers === |
| Session handlers now use fully qualified class names as service names, with the previous service names set up as aliases. | Session handlers now use fully qualified class names as service names, with the previous service names set up as aliases. | ||
| Line 535: | Line 541: | ||
| * memcache is now VuFind\Session\Memcache | * memcache is now VuFind\Session\Memcache | ||
| - | ==== 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 ---- | ||
| + | properties.Page Owner : | ||
| ---- | ---- | ||
installation/migration_notes/service_names.1517867994.txt.gz · Last modified: 2018/02/05 21:59 by demiankatz