Deprecate AdapterInterface::__call method

Author: franmomu

CHANGELOG.md

@@ -33,6 +33,7 @@ a release.
 - Timestampable: Support for custom column types (like Carbon).
 - Translatable: Added an index to `Translation` entity to speed up searches using 
   `Gedmo\Translatable\Entity\Repository\TranslationRepository::findTranslations()` method. 
+- `Gedmo\Mapping\Event\AdapterInterface::getObject()` method.
 
 ### Fixed
 - Blameable, IpTraceable, Timestampable: Type handling for the tracked field values configured in the origin field.
@@ -49,6 +50,7 @@ a release.
 - Tree: When using Closure tree strategy, it is deprecated not defining the mapping associations of the closure entity.
 - `Gedmo\Tool\Logging\DBAL\QueryAnalizer` class without replacement.
 - Using YAML mapping is deprecated, you SHOULD migrate to attributes, annotations or XML.
+- `Gedmo\Mapping\Event\AdapterInterface::__call()` method.
 
 ### Changed
 - In order to use a custom cache for storing configuration of an extension, the user has to call `setCacheItemPool()`

src/Mapping/Event/Adapter/ODM.php

@@ -36,6 +36,11 @@ class ODM implements AdapterInterface
 
     public function __call($method, $args)
     {
+        @trigger_error(sprintf(
+            'Using "%s()" method is deprecated since gedmo/doctrine-extensions 3.x and will be removed in version 4.0.',
+            __METHOD__
+        ), E_USER_DEPRECATED);
+
         if (null === $this->args) {
             throw new RuntimeException('Event args must be set before calling its methods');
         }
@@ -86,7 +91,20 @@ public function getObjectManager()
             return $this->dm;
         }
 
-        return $this->__call('getDocumentManager', []);
+        if (null === $this->args) {
+            throw new \LogicException(sprintf('Event args must be set before calling "%s()".', __METHOD__));
+        }
+
+        return $this->args->getDocumentManager();
+    }
+
+    public function getObject(): object
+    {
+        if (null === $this->args) {
+            throw new \LogicException(sprintf('Event args must be set before calling "%s()".', __METHOD__));
+        }
+
+        return $this->args->getDocument();
     }
 
     public function getObjectState($uow, $object)

src/Mapping/Event/Adapter/ORM.php

@@ -36,6 +36,11 @@ class ORM implements AdapterInterface
 
     public function __call($method, $args)
     {
+        @trigger_error(sprintf(
+            'Using "%s()" method is deprecated since gedmo/doctrine-extensions 3.x and will be removed in version 4.0.',
+            __METHOD__
+        ), E_USER_DEPRECATED);
+
         if (null === $this->args) {
             throw new RuntimeException('Event args must be set before calling its methods');
         }
@@ -86,7 +91,20 @@ public function getObjectManager()
             return $this->em;
         }
 
-        return $this->__call('getEntityManager', []);
+        if (null === $this->args) {
+            throw new \LogicException(sprintf('Event args must be set before calling "%s()".', __METHOD__));
+        }
+
+        return $this->args->getEntityManager();
+    }
+
+    public function getObject(): object
+    {
+        if (null === $this->args) {
+            throw new \LogicException(sprintf('Event args must be set before calling "%s()".', __METHOD__));
+        }
+
+        return $this->args->getEntity();
     }
 
     public function getObjectState($uow, $object)

src/Mapping/Event/AdapterInterface.php

@@ -22,10 +22,13 @@
  * @author Gediminas Morkevicius <[email protected]>
  *
  * @method LifecycleEventArgs createLifecycleEventArgsInstance(object $object, ObjectManager $manager)
+ * @method object             getObject()
  */
 interface AdapterInterface
 {
     /**
+     * @deprecated since gedmo/doctrine-extensions 3.x, will be removed in version 4.0.
+     *
      * Calls a method on the event args object.
      *
      * @param string $method

tests/Gedmo/Mapping/MappingEventAdapterTest.php

@@ -55,7 +55,8 @@ public function testAdapterBehavior(): void
             ->method('getEntityManager');
 
         $eventArgsMock->expects(static::once())
-            ->method('getEntity');
+            ->method('getEntity')
+            ->willReturn(new \stdClass());
 
         $eventAdapter = new EventAdapterORM();
         $eventAdapter->setEventArgs($eventArgsMock);