Return object types from entity data repository

Author: mglaman

extension.neon

@@ -29,7 +29,7 @@ parameters:
 parametersSchema:
 	drupal: structure([
 		drupal_root: string()
-		entityMapping: listOf(
+		entityMapping: arrayOf(
 			structure([
 				class: string()
 				storage: string()
@@ -48,6 +48,7 @@ services:
 	-
 		class: mglaman\PHPStanDrupal\Drupal\EntityDataRepository
 		arguments:
+			reflectionProvider: @reflectionProvider
 			entityData: %drupal.entityMapping%
 
 	-

src/Drupal/EntityDataRepository.php

@@ -2,16 +2,29 @@
 
 namespace mglaman\PHPStanDrupal\Drupal;
 
+use Drupal\Core\Config\Entity\ConfigEntityStorageInterface;
+use Drupal\Core\Entity\ContentEntityStorageInterface;
+use mglaman\PHPStanDrupal\Type\EntityStorage\ConfigEntityStorageType;
+use mglaman\PHPStanDrupal\Type\EntityStorage\ContentEntityStorageType;
+use mglaman\PHPStanDrupal\Type\EntityStorage\EntityStorageType;
+use PHPStan\Reflection\ReflectionProvider;
+use PHPStan\Type\ObjectType;
+
 final class EntityDataRepository
 {
+    /**
+     * @var ReflectionProvider
+     */
+    private $reflectionProvider;
 
     /**
      * @var array<string, array<string, string>>
      */
-    private $entityData = [];
+    private $entityData;
 
-    public function __construct(array $entityData)
+    public function __construct(ReflectionProvider $reflectionProvider, array $entityData)
     {
+        $this->reflectionProvider = $reflectionProvider;
         $this->entityData = $entityData;
     }
 
@@ -20,15 +33,37 @@ public function get(string $entityTypeId): ?array
         return $this->entityData[$entityTypeId] ?? null;
     }
 
-    public function getClassName(string $entityTypeId): ?string
+    public function getClassType(string $entityTypeId): ?ObjectType
     {
         $data = $this->get($entityTypeId);
-        return $data['class'] ?? null;
+        $className = $data['class'] ?? null;
+        if ($className === null) {
+            return null;
+        }
+        return new ObjectType($className);
     }
 
-    public function getStorageClassName(string $entityTypeId): ?string
+    public function getStorageType(string $entityTypeId): ?ObjectType
     {
         $data = $this->get($entityTypeId);
-        return $data['storage'] ?? null;
+        $className = $data['storage'] ?? null;
+        if ($className === null) {
+            // @todo get entity type class reflection and return proper storage for entity type
+            // example: config storage, sqlcontententitystorage, etc.
+            // $className = reflectedDecision.
+            return null;
+        }
+        if (!$this->reflectionProvider->hasClass($className)) {
+            return null;
+        }
+
+        $reflection = $this->reflectionProvider->getClass($className);
+        if ($reflection->implementsInterface(ConfigEntityStorageInterface::class)) {
+            return new ConfigEntityStorageType($entityTypeId, $className);
+        }
+        if ($reflection->implementsInterface(ContentEntityStorageInterface::class)) {
+            return new ContentEntityStorageType($entityTypeId, $className);
+        }
+        return new EntityStorageType($entityTypeId, $className);
     }
 }

src/Type/EntityStorage/EntityStorageDynamicReturnTypeExtension.php

@@ -59,12 +59,10 @@ public function getTypeFromMethodCall(
             return ParametersAcceptorSelector::selectSingle($methodReflection->getVariants())->getReturnType();
         }
 
-        $entityClassName = $this->entityDataRepository->getClassName($callerType->getEntityTypeId());
-        if (null === $entityClassName) {
+        $type = $this->entityDataRepository->getClassType($callerType->getEntityTypeId());
+        if ($type === null) {
             return ParametersAcceptorSelector::selectSingle($methodReflection->getVariants())->getReturnType();
         }
-
-        $type = new ObjectType($entityClassName);
         if (\in_array($methodReflection->getName(), ['load', 'loadUnchanged'], true)) {
             return TypeCombinator::addNull($type);
         }

src/Type/EntityTypeManagerGetStorageDynamicReturnTypeExtension.php

@@ -22,10 +22,6 @@
 
 class EntityTypeManagerGetStorageDynamicReturnTypeExtension implements DynamicMethodReturnTypeExtension
 {
-    /**
-     * @var ReflectionProvider
-     */
-    private $reflectionProvider;
 
     /**
      * @var EntityDataRepository
@@ -35,12 +31,10 @@ class EntityTypeManagerGetStorageDynamicReturnTypeExtension implements DynamicMe
     /**
      * EntityTypeManagerGetStorageDynamicReturnTypeExtension constructor.
      *
-     * @param ReflectionProvider $reflectionProvider
      * @param EntityDataRepository $entityDataRepository
      */
-    public function __construct(ReflectionProvider $reflectionProvider, EntityDataRepository $entityDataRepository)
+    public function __construct(EntityDataRepository $entityDataRepository)
     {
-        $this->reflectionProvider = $reflectionProvider;
         $this->entityDataRepository = $entityDataRepository;
     }
 
@@ -87,23 +81,11 @@ public function getTypeFromMethodCall(
 
         $entityTypeId = $arg1->value;
 
-        $storageClassName = $this->entityDataRepository->getStorageClassName($entityTypeId);
-        if ($storageClassName !== null) {
-            $interfaces = \array_keys($this->reflectionProvider->getClass($storageClassName)->getInterfaces());
-
-            if (\in_array(ConfigEntityStorageInterface::class, $interfaces, true)) {
-                return new ConfigEntityStorageType($entityTypeId, $storageClassName);
-            }
-
-            if (\in_array(ContentEntityStorageInterface::class, $interfaces, true)) {
-                return new ContentEntityStorageType($entityTypeId, $storageClassName);
-            }
-
-            return new EntityStorageType($entityTypeId, $storageClassName);
+        $storageType = $this->entityDataRepository->getStorageType($entityTypeId);
+        if ($storageType !== null) {
+            return $storageType;
         }
 
-        // @todo get entity type class reflection and return proper storage for entity type
-        // example: config storage, sqlcontententitystorage, etc.
         if ($returnType instanceof ObjectType) {
             return new EntityStorageType($entityTypeId, $returnType->getClassName());
         }