Document return type of getEntityState() (#9328)

Author: derrabus

lib/Doctrine/ORM/UnitOfWork.php

@@ -951,8 +951,6 @@ private function computeAssociationChanges(array $assoc, $value): void
                     // so the exception will be raised from the DBAL layer (constraint violation).
                     throw ORMInvalidArgumentException::detachedEntityFoundThroughRelationship($assoc, $entry);
 
-                    break;
-
                 default:
                     // MANAGED associated entities are already taken into account
                     // during changeset calculation anyway, since they are in the identity map.
@@ -1568,8 +1566,10 @@ public function addToIdentityMap($entity)
      *                         This parameter can be set to improve performance of entity state detection
      *                         by potentially avoiding a database lookup if the distinction between NEW and DETACHED
      *                         is either known or does not matter for the caller of the method.
+     * @psalm-param self::STATE_*|null $assume
      *
      * @return int The entity state.
+     * @psalm-return self::STATE_*
      */
     public function getEntityState($entity, $assume = null)
     {

phpstan-baseline.neon

@@ -1890,11 +1890,6 @@ parameters:
 			count: 1
 			path: lib/Doctrine/ORM/UnitOfWork.php
 
-		-
-			message: "#^Unreachable statement \\- code above always terminates\\.$#"
-			count: 1
-			path: lib/Doctrine/ORM/UnitOfWork.php
-
 		-
 			message: "#^Access to an undefined property Doctrine\\\\Persistence\\\\Mapping\\\\ClassMetadata\\:\\:\\$name\\.$#"
 			count: 1
@@ -1904,3 +1899,4 @@ parameters:
 			message: "#^Access to an undefined property Doctrine\\\\Persistence\\\\Mapping\\\\ClassMetadata\\:\\:\\$subClasses\\.$#"
 			count: 1
 			path: lib/Doctrine/ORM/Utility/HierarchyDiscriminatorResolver.php
+

psalm-baseline.xml

@@ -3218,6 +3218,9 @@
       <code>$entity</code>
       <code>$entity</code>
     </PossiblyNullArgument>
+    <RedundantConditionGivenDocblockType occurrences="1">
+      <code>$state === UnitOfWork::STATE_DETACHED</code>
+    </RedundantConditionGivenDocblockType>
   </file>
   <file src="lib/Doctrine/ORM/Tools/EntityGenerator.php">
     <ArgumentTypeCoercion occurrences="4">