Convert from Laminas\Db to Doctrine

composer.json

@@ -30,6 +30,8 @@
         "colinmollenhour/credis": "1.13.0",
         "composer/package-versions-deprecated": "1.11.99.5",
         "composer/semver": "3.3.2",
+        "doctrine/doctrine-orm-module": "^5.0",
+        "doctrine/orm": "^2.10.2",
         "endroid/qr-code": "4.4.9",
         "jasig/phpcas": "1.5.0",
         "laminas/laminas-cache": "3.1.3",

config/application.config.php

@@ -3,6 +3,8 @@
 
 // Set up modules:
 $modules = [
+    'DoctrineModule',
+    'DoctrineORMModule',
     'Laminas\Cache',
     'Laminas\Cache\Storage\Adapter\BlackHole',
     'Laminas\Cache\Storage\Adapter\Filesystem',

config/cli-config.php

@@ -0,0 +1,6 @@
+<?php
+
+$app = include __DIR__ . '/application.php';
+return \Doctrine\ORM\Tools\Console\ConsoleRunner::createHelperSet(
+    $app->getServiceManager()->get('doctrine.entity_manager.orm_default')
+);

module/VuFind/config/module.config.php

@@ -338,6 +338,7 @@
     'service_manager' => [
         'allow_override' => true,
         'factories' => [
+            'Doctrine\ORM\Mapping\Driver\AnnotationDriver' => 'VuFind\Db\AnnotationDriverFactory',
             'League\CommonMark\ConverterInterface' => 'VuFind\Service\MarkdownFactory',
             'ProxyManager\Configuration' => 'VuFind\Service\ProxyConfigFactory',
             'VuFind\AjaxHandler\PluginManager' => 'VuFind\ServiceManager\AbstractPluginManagerFactory',
@@ -378,7 +379,10 @@
             'VuFind\Crypt\HMAC' => 'VuFind\Crypt\HMACFactory',
             'VuFind\Date\Converter' => 'VuFind\Service\DateConverterFactory',
             'VuFind\Db\AdapterFactory' => 'VuFind\Service\ServiceWithConfigIniFactory',
+            'VuFind\Db\Connection' => 'VuFind\Db\ConnectionFactory',
+            'VuFind\Db\Entity\PluginManager' => 'VuFind\ServiceManager\AbstractPluginManagerFactory',
             'VuFind\Db\Row\PluginManager' => 'VuFind\ServiceManager\AbstractPluginManagerFactory',
+            'VuFind\Db\Service\PluginManager' => 'VuFind\ServiceManager\AbstractPluginManagerFactory',
             'VuFind\Db\Table\PluginManager' => 'VuFind\ServiceManager\AbstractPluginManagerFactory',
             'VuFind\DigitalContent\OverdriveConnector' => 'VuFind\DigitalContent\OverdriveConnectorFactory',
             'VuFind\DoiLinker\PluginManager' => 'VuFind\ServiceManager\AbstractPluginManagerFactory',
@@ -464,6 +468,7 @@
             'VuFind\ServiceManager\ServiceInitializer',
         ],
         'aliases' => [
+            'doctrine.connection.orm_vufind' => 'VuFind\Db\Connection',
             'League\CommonMark\MarkdownConverterInterface' => 'League\CommonMark\ConverterInterface',
             'Request' => 'VuFind\Http\PhpEnvironment\Request',
             'VuFind\AccountCapabilities' => 'VuFind\Config\AccountCapabilities',
@@ -533,6 +538,41 @@
             'VuFind\Form\Form' => false,
         ],
     ],
+    'doctrine' => [
+        'cache' => [
+            'filesystem' => [
+                'directory' => LOCAL_CACHE_DIR . '/doctrine',
+            ],
+        ],
+        'configuration' => [
+            'orm_default' => [
+                'query_cache' => 'filesystem',
+                'result_cache' => 'filesystem',
+                'metadata_cache' => 'filesystem',
+                'hydration_cache' => 'filesystem',
+            ],
+        ],
+        'driver' => [
+            'vufind_annotation_driver' => [
+                'class' => \Doctrine\ORM\Mapping\Driver\AnnotationDriver::class,
+                'cache' => 'filesystem',
+                'paths' => [
+                    'module/VuFind/src/VuFind/Db/Entity',
+                ],
+            ],
+            'orm_default' => [
+                'drivers' => [
+                    'VuFind\Db\Entity' => 'vufind_annotation_driver',
+                ],
+            ],
+        ],
+        'entitymanager' => [
+            'orm_vufind' => [
+                'connection' => 'orm_vufind',
+                'configuration' => 'orm_vufind',
+            ],
+        ],
+    ],
     'translator' => [],
     'translator_plugins' => [
         'factories' => [
@@ -595,7 +635,9 @@
             'content_toc' => [ /* see VuFind\Content\TOC\PluginManager for defaults */ ],
             'contentblock' => [ /* see VuFind\ContentBlock\PluginManager for defaults */ ],
             'cover_layer' => [ /* see VuFind\Cover\Layer\PluginManager for defaults */ ],
+            'db_entity' => [ /* see VuFind\Db\Entity\PluginManager for defaults */ ],
             'db_row' => [ /* see VuFind\Db\Row\PluginManager for defaults */ ],
+            'db_service' => [ /* see VuFind\Db\Service\PluginManager for defaults */ ],
             'db_table' => [ /* see VuFind\Db\Table\PluginManager for defaults */ ],
             'doilinker' => [ /* see VuFind\DoiLinker\PluginManager for defaults */ ],
             'form_handler' => [ /* see VuFind\Form\Handler\PluginManager for defaults */],

module/VuFind/src/VuFind/Controller/AbstractBase.php

@@ -505,6 +505,19 @@ public function getTable($table)
             ->get($table);
     }
 
+    /**
+     * Get a database service object.
+     *
+     * @param string $name Name of service to retrieve
+     *
+     * @return \VuFind\Db\Service\AbstractService
+     */
+    public function getDbService(string $name): \VuFind\Db\Service\AbstractService
+    {
+        return $this->serviceLocator->get(\VuFind\Db\Service\PluginManager::class)
+            ->get($name);
+    }
+
     /**
      * Get the full URL to one of VuFind's routes.
      *

module/VuFind/src/VuFind/Controller/UpgradeController.php

@@ -533,8 +533,8 @@ public function fixdatabaseAction()
             // content -- the checks below should be platform-independent.
 
             // Check for legacy tag bugs:
-            $resourceTagsTable = $this->getTable('ResourceTags');
-            $anonymousTags = $resourceTagsTable->getAnonymousCount();
+            $tagService = $this->getDbService(\VuFind\Db\Service\TagService::class);
+            $anonymousTags = $tagService->getAnonymousCount();
             if ($anonymousTags > 0 && !isset($this->cookie->skipAnonymousTags)) {
                 $this->getRequest()->getQuery()->set('anonymousCnt', $anonymousTags);
                 return $this->redirect()->toRoute('upgrade-fixanonymoustags');