About Features Downloads Getting Started Documentation Events Support GitHub

Love VuFind®? Consider becoming a financial supporter. Your support helps build a better VuFind®!

VuFind Documentation

Site Tools

You are here: start » installation » migration_notes » service_names
Trace:
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.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
installation:migration_notes:service_names [2020/03/03 17:53] – [Service Name Migration] demiankatzinstallation:migration_notes:service_names [2020/03/03 17:57] (current) – demiankatz
Line 1: Line 1:
 ====== Service Name Migration ====== ====== Service Name Migration ======
 +
 +===== 7.0 Changes =====
 +
 +Because of the migration from Zend Framework to [[development:architecture:laminas|Laminas]] in VuFind 7.0, any service names or factories beginning with the word "Zend" need to be changed to begin with the word "Laminas" instead.
 +
 +===== 5.0 Changes =====
  
 In VuFind 5.0, the switch to [[development:architecture:laminas|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:architecture:laminas|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 =====+==== 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'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. 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.
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 "virtual" class names pointing to differently-configured instances of the same class, hierarchy-related plugin service names now match fully qualified class names, with old short names set up as aliases. With the exception of the hierarchy driver plugins, which use "virtual" class names pointing to differently-configured instances of the same class, hierarchy-related plugin service names now match fully qualified class names, with old short names set up as aliases.
  
-=== 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 ===
  
 View helpers are now defined using fully qualified class names as service names. Aliases have been adjusted to match the case by which helpers are called in templates. View helpers are now defined using fully qualified class names as service names. Aliases have been adjusted to match the case by which helpers are called in templates.
Line 602: Line 608:
  
 ---- struct data ---- ---- struct data ----
 +properties.Page Owner : 
 ---- ----
  
installation/migration_notes/service_names.1583258009.txt.gz · Last modified: 2020/03/03 17:53 by demiankatz