Leverage generic persistence event classes

doctrine · Apr 10, 2022 · 5d7153f · 5d7153f
1 parent e13422a
commit 5d7153f
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 34 deletions.
diff --git a/lib/Doctrine/ORM/Event/LifecycleEventArgs.php b/lib/Doctrine/ORM/Event/LifecycleEventArgs.php
@@ -11,7 +11,7 @@
  * Lifecycle Events are triggered by the UnitOfWork during lifecycle transitions
  * of entities.
  *
- * @link   www.doctrine-project.org
+ * @extends BaseLifecycleEventArgs<EntityManagerInterface>
  */
 class LifecycleEventArgs extends BaseLifecycleEventArgs
 {

diff --git a/lib/Doctrine/ORM/Event/LoadClassMetadataEventArgs.php b/lib/Doctrine/ORM/Event/LoadClassMetadataEventArgs.php
@@ -11,8 +11,7 @@
 /**
  * Class that holds event arguments for a loadMetadata event.
  *
- * @method __construct(ClassMetadata $classMetadata, EntityManagerInterface $objectManager)
- * @method ClassMetadata getClassMetadata()
+ * @extends BaseLoadClassMetadataEventArgs<ClassMetadata<object>, EntityManagerInterface>
  */
 class LoadClassMetadataEventArgs extends BaseLoadClassMetadataEventArgs
 {

diff --git a/lib/Doctrine/ORM/Event/OnClassMetadataNotFoundEventArgs.php b/lib/Doctrine/ORM/Event/OnClassMetadataNotFoundEventArgs.php
@@ -4,6 +4,7 @@
 
 namespace Doctrine\ORM\Event;
 
+use Doctrine\ORM\EntityManagerInterface;
 use Doctrine\Persistence\Event\ManagerEventArgs;
 use Doctrine\Persistence\Mapping\ClassMetadata;
 use Doctrine\Persistence\ObjectManager;
@@ -13,6 +14,8 @@
  *
  * This object is mutable by design, allowing callbacks having access to it to set the
  * found metadata in it, and therefore "cancelling" a `onClassMetadataNotFound` event
+ *
+ * @extends ManagerEventArgs<EntityManagerInterface>
  */
 class OnClassMetadataNotFoundEventArgs extends ManagerEventArgs
 {
@@ -23,7 +26,8 @@ class OnClassMetadataNotFoundEventArgs extends ManagerEventArgs
     private $foundMetadata;
 
     /**
-     * @param string $className
+     * @param string                 $className
+     * @param EntityManagerInterface $objectManager
      */
     public function __construct($className, ObjectManager $objectManager)
     {

diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -160,16 +160,6 @@ parameters:
 			count: 1
 			path: lib/Doctrine/ORM/EntityRepository.php
 
-		-
-			message: "#^Method Doctrine\\\\ORM\\\\Event\\\\LifecycleEventArgs\\:\\:getEntityManager\\(\\) should return Doctrine\\\\ORM\\\\EntityManagerInterface but returns Doctrine\\\\Persistence\\\\ObjectManager\\.$#"
-			count: 1
-			path: lib/Doctrine/ORM/Event/LifecycleEventArgs.php
-
-		-
-			message: "#^Method Doctrine\\\\ORM\\\\Event\\\\LoadClassMetadataEventArgs\\:\\:getEntityManager\\(\\) should return Doctrine\\\\ORM\\\\EntityManagerInterface but returns Doctrine\\\\Persistence\\\\ObjectManager\\.$#"
-			count: 1
-			path: lib/Doctrine/ORM/Event/LoadClassMetadataEventArgs.php
-
 		-
 			message: "#^Call to an undefined method Doctrine\\\\DBAL\\\\Platforms\\\\AbstractPlatform\\:\\:getTableHiLoCurrentValSql\\(\\)\\.$#"
 			count: 1
@@ -1744,3 +1734,4 @@ parameters:
 			message: "#^Access to an undefined property Doctrine\\\\Persistence\\\\Mapping\\\\ClassMetadata\\:\\:\\$subClasses\\.$#"
 			count: 1
 			path: lib/Doctrine/ORM/Utility/HierarchyDiscriminatorResolver.php
+
diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -346,22 +346,6 @@
       <code>find</code>
     </TooManyArguments>
   </file>
-  <file src="lib/Doctrine/ORM/Event/LifecycleEventArgs.php">
-    <LessSpecificReturnStatement occurrences="1">
-      <code>$this-&gt;getObjectManager()</code>
-    </LessSpecificReturnStatement>
-    <MoreSpecificReturnType occurrences="1">
-      <code>EntityManagerInterface</code>
-    </MoreSpecificReturnType>
-  </file>
-  <file src="lib/Doctrine/ORM/Event/LoadClassMetadataEventArgs.php">
-    <LessSpecificReturnStatement occurrences="1">
-      <code>$this-&gt;getObjectManager()</code>
-    </LessSpecificReturnStatement>
-    <MoreSpecificReturnType occurrences="1">
-      <code>EntityManagerInterface</code>
-    </MoreSpecificReturnType>
-  </file>
   <file src="lib/Doctrine/ORM/Event/OnClassMetadataNotFoundEventArgs.php">
     <RedundantCastGivenDocblockType occurrences="1">
       <code>(string) $className</code>
@@ -2662,6 +2646,12 @@
     </RedundantConditionGivenDocblockType>
   </file>
   <file src="lib/Doctrine/ORM/Repository/DefaultRepositoryFactory.php">
+    <InvalidReturnStatement occurrences="1">
+      <code>$this-&gt;repositoryList[$repositoryHash] = $this-&gt;createRepository($entityManager, $entityName)</code>
+    </InvalidReturnStatement>
+    <InvalidReturnType occurrences="1">
+      <code>ObjectRepository</code>
+    </InvalidReturnType>
     <TypeDoesNotContainType occurrences="1">
       <code>$repository instanceof EntityRepository</code>
     </TypeDoesNotContainType>

diff --git a/tests/Doctrine/Tests/EventListener/CacheMetadataListener.php b/tests/Doctrine/Tests/EventListener/CacheMetadataListener.php
@@ -5,10 +5,9 @@
 namespace Doctrine\Tests\EventListener;
 
 use Doctrine\ORM\EntityManagerInterface;
+use Doctrine\ORM\Event\LoadClassMetadataEventArgs;
 use Doctrine\ORM\Mapping\ClassMetadata;
-use Doctrine\Persistence\Event\LoadClassMetadataEventArgs;
 
-use function assert;
 use function strstr;
 
 class CacheMetadataListener
@@ -26,8 +25,7 @@ class CacheMetadataListener
     public function loadClassMetadata(LoadClassMetadataEventArgs $event): void
     {
         $metadata = $event->getClassMetadata();
-        assert($metadata instanceof ClassMetadata);
-        $em = $event->getObjectManager();
+        $em       = $event->getObjectManager();
 
         if (strstr($metadata->name, 'Doctrine\Tests\Models\Cache')) {
             return;