Deprecate AsDocumentListener::$method and $lazy (not working)

doctrine · Dec 21, 2023 · a6dae81 · a6dae81
1 parent 6bec2f0
commit a6dae81
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 4 deletions.
diff --git a/Attribute/AsDocumentListener.php b/Attribute/AsDocumentListener.php
@@ -5,6 +5,7 @@
 namespace Doctrine\Bundle\MongoDBBundle\Attribute;
 
 use Attribute;
+use Doctrine\Deprecations\Deprecation;
 
 /**
  * Service tag to autoconfigure document listeners.
@@ -14,9 +15,27 @@ class AsDocumentListener
 {
     public function __construct(
         public ?string $event = null,
+        /** @deprecated the method name is the same as the event name */
         public ?string $method = null,
+        /** @deprecated not supported */
         public ?bool $lazy = null,
         public ?string $connection = null,
     ) {
+        // phpcs:disable SlevomatCodingStandard.ControlStructures.EarlyExit.EarlyExitNotUsed
+        if ($method !== null) {
+            Deprecation::trigger(
+                'doctrine/mongodb-odm-bundle',
+                '4.7',
+                'The method name is the same as the event name, so it can be omitted.',
+            );
+        }
+
+        if ($lazy !== null) {
+            Deprecation::trigger(
+                'doctrine/mongodb-odm-bundle',
+                '4.7',
+                'Lazy loading is not supported.',
+            );
+        }
     }
 }
diff --git a/Tests/DependencyInjection/DoctrineMongoDBExtensionTest.php b/Tests/DependencyInjection/DoctrineMongoDBExtensionTest.php
@@ -94,8 +94,8 @@ public function testAsDocumentListenerAttribute(): void
         self::assertSame([
             [
                 'event' => 'prePersist',
-                'method' => 'onPrePersist',
-                'lazy' => true,
+                'method' => null,
+                'lazy' => null,
                 'connection' => 'test',
             ],
         ], $listenerDefinition->getTag('doctrine_mongodb.odm.event_listener'));

diff --git a/...Injection/Fixtures/Bundles/DocumentListenerBundle/EventListener/TestAttributeListener.php b/...Injection/Fixtures/Bundles/DocumentListenerBundle/EventListener/TestAttributeListener.php
@@ -6,10 +6,10 @@
 
 use Doctrine\Bundle\MongoDBBundle\Attribute\AsDocumentListener;
 
-#[AsDocumentListener(event: 'prePersist', method: 'onPrePersist', lazy: true, connection: 'test')]
+#[AsDocumentListener(event: 'prePersist', connection: 'test')]
 class TestAttributeListener
 {
-    public function onPrePersist(): void
+    public function prePersist(): void
     {
     }
 }