EntityDataRepository for entity type data

Author: mglaman

extension.neon

@@ -13,21 +13,28 @@ parameters:
 		- engine
 	drupal:
 		drupal_root: '%currentWorkingDirectory%'
-		entityTypeStorageMapping:
-			node: Drupal\node\NodeStorage
-			taxonomy_term: Drupal\taxonomy\TermStorage
-			user: Drupal\user\UserStorage
-			block: Drupal\Core\Config\Entity\ConfigEntityStorage
-		entityStorageMapping:
-			node: Drupal\node\Entity\Node
-			taxonomy_term: Drupal\taxonomy\Entity\Term
-			user: Drupal\user\Entity\User
-			block: Drupal\block\Entity\Block
+		entityMapping:
+			node:
+				class: Drupal\node\Entity\Node
+				storage: Drupal\node\NodeStorage
+			taxonomy_term:
+				class: Drupal\taxonomy\Entity\Term
+				storage: Drupal\taxonomy\TermStorage
+			user:
+				class: Drupal\user\Entity\User
+				storage: Drupal\user\UserStorage
+			block:
+				class: Drupal\block\Entity\Block
+				storage: Drupal\Core\Config\Entity\ConfigEntityStorage
 parametersSchema:
 	drupal: structure([
 		drupal_root: string()
-		entityTypeStorageMapping: arrayOf(string())
-		entityStorageMapping: arrayOf(string())
+		entityMapping: listOf(
+			structure([
+				class: string()
+				storage: string()
+			])
+		)
 	])
 rules:
 	- mglaman\PHPStanDrupal\Rules\Classes\PluginManagerInspectionRule
@@ -38,17 +45,16 @@ rules:
 services:
 	-
 		class: mglaman\PHPStanDrupal\Drupal\ServiceMap
+	-
+		class: mglaman\PHPStanDrupal\Drupal\EntityDataRepository
+		arguments:
+			entityData: %drupal.entityMapping%
 
 	-
 		class: mglaman\PHPStanDrupal\Type\EntityTypeManagerGetStorageDynamicReturnTypeExtension
-		arguments:
-			reflectionProvider: @reflectionProvider
-			entityTypeStorageMapping: %drupal.entityTypeStorageMapping%
 		tags: [phpstan.broker.dynamicMethodReturnTypeExtension]
 	-
 		class: mglaman\PHPStanDrupal\Type\EntityStorage\EntityStorageDynamicReturnTypeExtension
-		arguments:
-			entityStorageMapping: %drupal.entityStorageMapping%
 		tags: [phpstan.broker.dynamicMethodReturnTypeExtension]
 	-
 		class: mglaman\PHPStanDrupal\Type\ContainerDynamicReturnTypeExtension

src/Drupal/EntityDataRepository.php

@@ -0,0 +1,34 @@
+<?php declare(strict_types=1);
+
+namespace mglaman\PHPStanDrupal\Drupal;
+
+final class EntityDataRepository
+{
+
+    /**
+     * @var array<string, array<string, string>>
+     */
+    private $entityData = [];
+
+    public function __construct(array $entityData)
+    {
+        $this->entityData = $entityData;
+    }
+
+    public function get(string $entityTypeId): ?array
+    {
+        return $this->entityData[$entityTypeId] ?? null;
+    }
+
+    public function getClassName(string $entityTypeId): ?string
+    {
+        $data = $this->get($entityTypeId);
+        return $data['class'] ?? null;
+    }
+
+    public function getStorageClassName(string $entityTypeId): ?string
+    {
+        $data = $this->get($entityTypeId);
+        return $data['storage'] ?? null;
+    }
+}

src/Type/EntityStorage/EntityStorageDynamicReturnTypeExtension.php

@@ -3,6 +3,7 @@
 namespace mglaman\PHPStanDrupal\Type\EntityStorage;
 
 use Drupal\Core\Entity\EntityStorageInterface;
+use mglaman\PHPStanDrupal\Drupal\EntityDataRepository;
 use PhpParser\Node\Expr\MethodCall;
 use PHPStan\Analyser\Scope;
 use PHPStan\Reflection\MethodReflection;
@@ -18,19 +19,13 @@ class EntityStorageDynamicReturnTypeExtension implements DynamicMethodReturnType
 {
 
     /**
-     * @var string[]
+     * @var EntityDataRepository
      */
-    private $entityStorageMapping;
+    private $entityDataRepository;
 
-    /**
-     * EntityStorageDynamicReturnTypeExtension constructor.
-     *
-     * @param string[] $entityStorageMapping
-     */
-    public function __construct(
-        array $entityStorageMapping = []
-    ) {
-        $this->entityStorageMapping = $entityStorageMapping;
+    public function __construct(EntityDataRepository $entityDataRepository)
+    {
+        $this->entityDataRepository = $entityDataRepository;
     }
 
     public function getClass(): string
@@ -64,7 +59,7 @@ public function getTypeFromMethodCall(
             return ParametersAcceptorSelector::selectSingle($methodReflection->getVariants())->getReturnType();
         }
 
-        $entityClassName = $this->entityStorageMapping[$callerType->getEntityTypeId()] ?? null;
+        $entityClassName = $this->entityDataRepository->getClassName($callerType->getEntityTypeId());
         if (null === $entityClassName) {
             return ParametersAcceptorSelector::selectSingle($methodReflection->getVariants())->getReturnType();
         }

src/Type/EntityTypeManagerGetStorageDynamicReturnTypeExtension.php

@@ -4,6 +4,7 @@
 
 use Drupal\Core\Config\Entity\ConfigEntityStorageInterface;
 use Drupal\Core\Entity\ContentEntityStorageInterface;
+use mglaman\PHPStanDrupal\Drupal\EntityDataRepository;
 use mglaman\PHPStanDrupal\Type\EntityStorage\ConfigEntityStorageType;
 use mglaman\PHPStanDrupal\Type\EntityStorage\ContentEntityStorageType;
 use mglaman\PHPStanDrupal\Type\EntityStorage\EntityStorageType;
@@ -27,20 +28,20 @@ class EntityTypeManagerGetStorageDynamicReturnTypeExtension implements DynamicMe
     private $reflectionProvider;
 
     /**
-     * @var string[]
+     * @var EntityDataRepository
      */
-    private $entityTypeStorageMapping;
+    private $entityDataRepository;
 
     /**
      * EntityTypeManagerGetStorageDynamicReturnTypeExtension constructor.
      *
      * @param ReflectionProvider $reflectionProvider
-     * @param string[] $entityTypeStorageMapping
+     * @param EntityDataRepository $entityDataRepository
      */
-    public function __construct(ReflectionProvider $reflectionProvider, array $entityTypeStorageMapping = [])
+    public function __construct(ReflectionProvider $reflectionProvider, EntityDataRepository $entityDataRepository)
     {
         $this->reflectionProvider = $reflectionProvider;
-        $this->entityTypeStorageMapping = $entityTypeStorageMapping;
+        $this->entityDataRepository = $entityDataRepository;
     }
 
     public function getClass(): string
@@ -86,8 +87,8 @@ public function getTypeFromMethodCall(
 
         $entityTypeId = $arg1->value;
 
-        if (isset($this->entityTypeStorageMapping[$entityTypeId])) {
-            $storageClassName = $this->entityTypeStorageMapping[$entityTypeId];
+        $storageClassName = $this->entityDataRepository->getStorageClassName($entityTypeId);
+        if ($storageClassName !== null) {
             $interfaces = \array_keys($this->reflectionProvider->getClass($storageClassName)->getInterfaces());
 
             if (\in_array(ConfigEntityStorageInterface::class, $interfaces, true)) {

tests/fixtures/config/phpunit-drupal-phpstan.neon

@@ -1,15 +1,18 @@
 parameters:
 	drupal:
 		drupal_root: tests/fixtures/drupal
-		entityTypeStorageMapping:
-			content_entity_using_custom_storage: Drupal\phpstan_fixtures\CustomContentEntityStorage
-			config_entity_using_default_storage: Drupal\Core\Config\Entity\ConfigEntityStorage
-			config_entity_using_custom_storage: Drupal\phpstan_fixtures\CustomConfigEntityStorage
-		entityStorageMapping:
-			content_entity_using_default_storage: Drupal\phpstan_fixtures\Entity\ContentEntityUsingDefaultStorage
-			content_entity_using_custom_storage: Drupal\phpstan_fixtures\Entity\ContentEntityUsingCustomStorage
-			config_entity_using_default_storage: Drupal\phpstan_fixtures\Entity\ConfigEntityUsingDefaultStorage
-			config_entity_using_custom_storage: Drupal\phpstan_fixtures\Entity\ConfigEntityUsingCustomStorage
+		entityMapping:
+			content_entity_using_custom_storage:
+				class: Drupal\phpstan_fixtures\Entity\ContentEntityUsingCustomStorage
+				storage: Drupal\phpstan_fixtures\CustomContentEntityStorage
+			config_entity_using_default_storage:
+				class: Drupal\phpstan_fixtures\Entity\ConfigEntityUsingDefaultStorage
+				storage: Drupal\Core\Config\Entity\ConfigEntityStorage
+			config_entity_using_custom_storage:
+				class: Drupal\phpstan_fixtures\Entity\ConfigEntityUsingCustomStorage
+				storage: Drupal\phpstan_fixtures\CustomConfigEntityStorage
+			content_entity_using_default_storage:
+				class: Drupal\phpstan_fixtures\Entity\ContentEntityUsingDefaultStorage
 includes:
 	- ../../../extension.neon
 	- ../../../vendor/phpstan/phpstan-deprecation-rules/rules.neon