Add EntityData value object for types

Author: mglaman

extension.neon

@@ -49,7 +49,7 @@ services:
 		class: mglaman\PHPStanDrupal\Drupal\EntityDataRepository
 		arguments:
 			reflectionProvider: @reflectionProvider
-			entityData: %drupal.entityMapping%
+			entityMapping: %drupal.entityMapping%
 
 	-
 		class: mglaman\PHPStanDrupal\Type\EntityTypeManagerGetStorageDynamicReturnTypeExtension

src/Drupal/EntityData.php

@@ -0,0 +1,74 @@
+<?php declare(strict_types=1);
+
+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\Reflection\ReflectionProviderStaticAccessor;
+use PHPStan\Type\ObjectType;
+
+final class EntityData
+{
+
+    /**
+     * @var string
+     */
+    private $entityTypeId;
+
+    /**
+     * @var string|null
+     */
+    private $className;
+
+    /**
+     * @var string|null
+     */
+    private $storageClassName;
+
+    /**
+     * @var ReflectionProvider
+     */
+    private $reflectionProvider;
+
+    public function __construct(string $entityTypeId, array $definition, ReflectionProvider $reflectionProvider)
+    {
+        $this->entityTypeId = $entityTypeId;
+        $this->className = $definition['class'] ?? null;
+        $this->storageClassName = $definition['storage'] ?? null;
+        // \PHPStan\Reflection\ReflectionProviderStaticAccessor::getInstance is not covered by the backward
+        // compatibility promise of PHPStan, so we must add it to our value object.
+        $this->reflectionProvider = $reflectionProvider;
+    }
+
+    public function getClassType(): ?ObjectType
+    {
+        return $this->className === null ? null : new ObjectType($this->className);
+    }
+
+    public function getStorageType(): ?ObjectType
+    {
+        if ($this->storageClassName === 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($this->storageClassName)) {
+            return null;
+        }
+
+        // @todo drop reflectionProvider for ObjectType isSuperTypeOf
+        $reflection = $this->reflectionProvider->getClass($this->storageClassName);
+        if ($reflection->implementsInterface(ConfigEntityStorageInterface::class)) {
+            return new ConfigEntityStorageType($this->entityTypeId, $this->storageClassName);
+        }
+        if ($reflection->implementsInterface(ContentEntityStorageInterface::class)) {
+            return new ContentEntityStorageType($this->entityTypeId, $this->storageClassName);
+        }
+        return new EntityStorageType($this->entityTypeId, $this->storageClassName);
+    }
+}

src/Drupal/EntityDataRepository.php

@@ -2,13 +2,7 @@
 
 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
 {
@@ -20,50 +14,27 @@ final class EntityDataRepository
     /**
      * @var array<string, array<string, string>>
      */
+    private $entityMapping;
+    /**
+     * @var array<string, EntityData|null>
+     */
     private $entityData;
 
-    public function __construct(ReflectionProvider $reflectionProvider, array $entityData)
+    public function __construct(ReflectionProvider $reflectionProvider, array $entityMapping)
     {
         $this->reflectionProvider = $reflectionProvider;
-        $this->entityData = $entityData;
+        $this->entityMapping = $entityMapping;
     }
 
-    public function get(string $entityTypeId): ?array
+    public function get(string $entityTypeId): EntityData
     {
-        return $this->entityData[$entityTypeId] ?? null;
-    }
-
-    public function getClassType(string $entityTypeId): ?ObjectType
-    {
-        $data = $this->get($entityTypeId);
-        $className = $data['class'] ?? null;
-        if ($className === null) {
-            return null;
-        }
-        return new ObjectType($className);
-    }
-
-    public function getStorageType(string $entityTypeId): ?ObjectType
-    {
-        $data = $this->get($entityTypeId);
-        $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);
+        if (!isset($this->entityData[$entityTypeId])) {
+            $this->entityData[$entityTypeId] = new EntityData(
+                $entityTypeId,
+                $this->entityMapping[$entityTypeId] ?? [],
+                $this->reflectionProvider
+            );
         }
-        return new EntityStorageType($entityTypeId, $className);
+        return $this->entityData[$entityTypeId];
     }
 }

src/Type/EntityStorage/EntityStorageDynamicReturnTypeExtension.php

@@ -59,7 +59,7 @@ public function getTypeFromMethodCall(
             return ParametersAcceptorSelector::selectSingle($methodReflection->getVariants())->getReturnType();
         }
 
-        $type = $this->entityDataRepository->getClassType($callerType->getEntityTypeId());
+        $type = $this->entityDataRepository->get($callerType->getEntityTypeId())->getClassType();
         if ($type === null) {
             return ParametersAcceptorSelector::selectSingle($methodReflection->getVariants())->getReturnType();
         }

src/Type/EntityTypeManagerGetStorageDynamicReturnTypeExtension.php

@@ -81,7 +81,7 @@ public function getTypeFromMethodCall(
 
         $entityTypeId = $arg1->value;
 
-        $storageType = $this->entityDataRepository->getStorageType($entityTypeId);
+        $storageType = $this->entityDataRepository->get($entityTypeId)->getStorageType();
         if ($storageType !== null) {
             return $storageType;
         }