Symfony 8.0 support

.github/workflows/continuous-integration.yml

@@ -85,6 +85,22 @@ jobs:
             dependencies: "highest"
             symfony-version: "stable"
             proxy: "lazy-ghost"
+          # Test with upcoming Symfony 7.4
+          - topology: "server"
+            php-version: "8.2"
+            mongodb-version: "8.0"
+            driver-version: "stable"
+            dependencies: "highest"
+            symfony-version: "7.4"
+            proxy: "lazy-ghost"
+          # Test with upcoming Symfony 8.0
+          - topology: "server"
+            php-version: "8.4"
+            mongodb-version: "8.0"
+            driver-version: "stable"
+            dependencies: "highest"
+            symfony-version: "8.0"
+            proxy: "lazy-ghost"
           # Test with a sharded cluster
           # Currently disabled due to a bug where MongoDB reports "sharding status unknown"
 #          - topology: "sharded_cluster"
@@ -140,6 +156,10 @@ jobs:
           composer require --no-update symfony/console:^${{ matrix.symfony-version }}
           composer require --no-update symfony/var-dumper:^${{ matrix.symfony-version }}
           composer require --no-update --dev symfony/cache:^${{ matrix.symfony-version }}
+          if dpkg --compare-versions "${{ matrix.symfony-version }}" lt "8.0"; then
+            # LazyGhostTrait was removed from symfony/var-exporter >= 8.0
+            composer require --no-update --dev symfony/var-exporter:^${{ matrix.symfony-version }}
+          fi
 
       - name: "Install dependencies with Composer"
         uses: "ramsey/composer-install@v3"

composer.json

@@ -32,10 +32,10 @@
         "jean85/pretty-package-versions": "^1.3.0 || ^2.0.1",
         "mongodb/mongodb": "^1.21 || ^2.0@dev",
         "psr/cache": "^1.0 || ^2.0 || ^3.0",
-        "symfony/console": "^5.4 || ^6.0 || ^7.0",
+        "symfony/console": "^5.4 || ^6.4 || ^7.0",
         "symfony/deprecation-contracts": "^2.2 || ^3.0",
-        "symfony/var-dumper": "^5.4 || ^6.0 || ^7.0",
-        "symfony/var-exporter": "^6.2 || ^7.0"
+        "symfony/var-dumper": "^5.4 || ^6.4 || ^7.0",
+        "symfony/var-exporter": "^6.4 || ^7.0"
     },
     "require-dev": {
         "ext-bcmath": "*",
@@ -49,7 +49,7 @@
         "phpstan/phpstan-phpunit": "^2.0",
         "phpunit/phpunit": "^10.4",
         "squizlabs/php_codesniffer": "^3.5",
-        "symfony/cache": "^5.4 || ^6.0 || ^7.0"
+        "symfony/cache": "^5.4 || ^6.4 || ^7.0"
     },
     "conflict": {
         "doctrine/annotations": "<1.12 || >=3.0"

docs/en/reference/console-commands.rst

@@ -1,7 +1,7 @@
 Console Commands
 ================
 
-Doctrine MongoDB ODM offers some console commands, which utilize Symfony2's
+Doctrine MongoDB ODM offers some console commands, which utilize Symfony's
 Console component, to ease your development process:
 
 - ``odm:clear-cache:metadata`` - Clear all metadata cache of the various cache drivers.

lib/Doctrine/ODM/MongoDB/Tools/Console/Command/ClearCache/MetadataCommand.php

@@ -22,8 +22,7 @@ class MetadataCommand extends Command
 {
     use CommandCompatibility;
 
-    /** @return void */
-    protected function configure()
+    private function doConfigure(): void
     {
         $this
         ->setName('odm:clear-cache:metadata')

lib/Doctrine/ODM/MongoDB/Tools/Console/Command/CommandCompatibility.php

@@ -9,10 +9,32 @@
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 
-if ((new ReflectionMethod(Command::class, 'execute'))->hasReturnType()) {
+// Symfony 8
+if ((new ReflectionMethod(Command::class, 'configure'))->hasReturnType()) {
     /** @internal */
     trait CommandCompatibility
     {
+        protected function configure(): void
+        {
+            $this->doConfigure();
+        }
+
+        protected function execute(InputInterface $input, OutputInterface $output): int
+        {
+            return $this->doExecute($input, $output);
+        }
+    }
+// Symfony 7
+} elseif ((new ReflectionMethod(Command::class, 'execute'))->hasReturnType()) {
+    /** @internal */
+    trait CommandCompatibility
+    {
+        /** @return void */
+        protected function configure()
+        {
+            $this->doConfigure();
+        }
+
         protected function execute(InputInterface $input, OutputInterface $output): int
         {
             return $this->doExecute($input, $output);
@@ -22,6 +44,12 @@ protected function execute(InputInterface $input, OutputInterface $output): int
     /** @internal */
     trait CommandCompatibility
     {
+        /** @return void */
+        protected function configure()
+        {
+            $this->doConfigure();
+        }
+
         /**
          * {@inheritDoc}
          *

lib/Doctrine/ODM/MongoDB/Tools/Console/Command/GenerateHydratorsCommand.php

@@ -31,8 +31,7 @@ class GenerateHydratorsCommand extends Command
 {
     use CommandCompatibility;
 
-    /** @return void */
-    protected function configure()
+    private function doConfigure(): void
     {
         $this
         ->setName('odm:generate:hydrators')

lib/Doctrine/ODM/MongoDB/Tools/Console/Command/GeneratePersistentCollectionsCommand.php

@@ -31,8 +31,7 @@ class GeneratePersistentCollectionsCommand extends Command
 {
     use CommandCompatibility;
 
-    /** @return void */
-    protected function configure()
+    private function doConfigure(): void
     {
         $this
             ->setName('odm:generate:persistent-collections')

lib/Doctrine/ODM/MongoDB/Tools/Console/Command/GenerateProxiesCommand.php

@@ -35,8 +35,7 @@ class GenerateProxiesCommand extends Command
 {
     use CommandCompatibility;
 
-    /** @return void */
-    protected function configure()
+    private function doConfigure(): void
     {
         $this
         ->setName('odm:generate:proxies')

lib/Doctrine/ODM/MongoDB/Tools/Console/Command/QueryCommand.php

@@ -27,8 +27,7 @@ class QueryCommand extends Command
 {
     use CommandCompatibility;
 
-    /** @return void */
-    protected function configure()
+    private function doConfigure(): void
     {
         $this
         ->setName('odm:query')

lib/Doctrine/ODM/MongoDB/Tools/Console/Command/Schema/AbstractCommand.php

@@ -19,16 +19,15 @@
 
 abstract class AbstractCommand extends Command
 {
+    use AbstractCommandCompatibility;
+
     public const DB           = 'db';
     public const COLLECTION   = 'collection';
     public const INDEX        = 'index';
     public const SEARCH_INDEX = 'search-index';
 
-    /** @return void */
-    protected function configure()
+    private function configureCommonOptions(): void
     {
-        parent::configure();
-
         $this
             ->addOption('maxTimeMs', null, InputOption::VALUE_REQUIRED, 'An optional maxTimeMs that will be used for all schema operations.')
             ->addOption('w', null, InputOption::VALUE_REQUIRED, 'An optional w option for the write concern that will be used for all schema operations.')

lib/Doctrine/ODM/MongoDB/Tools/Console/Command/Schema/AbstractCommandCompatibility.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\ODM\MongoDB\Tools\Console\Command\Schema;
+
+use ReflectionMethod;
+use Symfony\Component\Console\Command\Command;
+
+// Symfony 8
+if ((new ReflectionMethod(Command::class, 'configure'))->hasReturnType()) {
+    /** @internal */
+    trait AbstractCommandCompatibility
+    {
+        protected function configure(): void
+        {
+            $this->configureCommonOptions();
+        }
+    }
+} else {
+    /** @internal */
+    trait AbstractCommandCompatibility
+    {
+        /** @return void */
+        protected function configure()
+        {
+            $this->configureCommonOptions();
+        }
+    }
+}

lib/Doctrine/ODM/MongoDB/Tools/Console/Command/Schema/CreateCommand.php

@@ -30,8 +30,7 @@ class CreateCommand extends AbstractCommand
         self::SEARCH_INDEX => ['search index(es)', 'search indexes'],
     ];
 
-    /** @return void */
-    protected function configure()
+    private function doConfigure(): void
     {
         parent::configure();
 

lib/Doctrine/ODM/MongoDB/Tools/Console/Command/Schema/DropCommand.php

@@ -31,8 +31,7 @@ class DropCommand extends AbstractCommand
         self::SEARCH_INDEX => ['search index(es)', 'search indexes'],
     ];
 
-    /** @return void */
-    protected function configure()
+    protected function doConfigure(): void
     {
         parent::configure();
 

lib/Doctrine/ODM/MongoDB/Tools/Console/Command/Schema/ShardCommand.php

@@ -19,8 +19,7 @@ class ShardCommand extends AbstractCommand
 {
     use CommandCompatibility;
 
-    /** @return void */
-    protected function configure()
+    private function doConfigure(): void
     {
         parent::configure();
 

lib/Doctrine/ODM/MongoDB/Tools/Console/Command/Schema/UpdateCommand.php

@@ -19,8 +19,7 @@ class UpdateCommand extends AbstractCommand
 {
     use CommandCompatibility;
 
-    /** @return void */
-    protected function configure()
+    private function doConfigure(): void
     {
         parent::configure();
 

lib/Doctrine/ODM/MongoDB/Tools/Console/Command/Schema/ValidateCommand.php

@@ -19,8 +19,7 @@ class ValidateCommand extends Command
 {
     use CommandCompatibility;
 
-    /** @return void */
-    protected function configure()
+    private function doConfigure(): void
     {
         $this
             ->setName('odm:schema:validate')

phpcs.xml.dist

@@ -67,6 +67,7 @@
     <rule ref="PSR1.Classes.ClassDeclaration.MultipleClasses">
         <exclude-pattern>lib/Doctrine/ODM/MongoDB/Mapping/Driver/CompatibilityAnnotationDriver.php</exclude-pattern>
         <exclude-pattern>lib/Doctrine/ODM/MongoDB/Tools/Console/Command/CommandCompatibility.php</exclude-pattern>
+        <exclude-pattern>lib/Doctrine/ODM/MongoDB/Tools/Console/Command/Schema/AbstractCommandCompatibility.php</exclude-pattern>
         <exclude-pattern>lib/Doctrine/ODM/MongoDB/Tools/Console/Helper/DocumentManagerHelper.php</exclude-pattern>
         <exclude-pattern>*/tests/*</exclude-pattern>
     </rule>