Merge pull request #251 from mglaman/entity-default-storage-lookup

Use entity storage class inferred from entity type

Author: mglaman

extension.neon

@@ -25,16 +25,18 @@ parameters:
 				storage: Drupal\user\UserStorage
 			block:
 				class: Drupal\block\Entity\Block
-				storage: Drupal\Core\Config\Entity\ConfigEntityStorage
 parametersSchema:
 	drupal: structure([
 		drupal_root: string()
-		entityMapping: arrayOf(
+		entityMapping: arrayOf(anyOf(
+			structure([
+				class: string()
+			]),
 			structure([
 				class: string()
 				storage: string()
 			])
-		)
+		))
 	])
 rules:
 	- mglaman\PHPStanDrupal\Rules\Classes\PluginManagerInspectionRule

src/Drupal/EntityData.php

@@ -2,7 +2,9 @@
 
 namespace mglaman\PHPStanDrupal\Drupal;
 
+use Drupal\Core\Config\Entity\ConfigEntityInterface;
 use Drupal\Core\Config\Entity\ConfigEntityStorageInterface;
+use Drupal\Core\Entity\ContentEntityInterface;
 use Drupal\Core\Entity\ContentEntityStorageInterface;
 use Drupal\Core\Entity\EntityStorageInterface;
 use mglaman\PHPStanDrupal\Type\EntityStorage\ConfigEntityStorageType;
@@ -43,10 +45,17 @@ public function getClassType(): ?ObjectType
     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;
+            $classType = $this->getClassType();
+            if ($classType === null) {
+                return null;
+            }
+            if ((new ObjectType(ConfigEntityInterface::class))->isSuperTypeOf($classType)->yes()) {
+                $this->storageClassName = 'Drupal\Core\Config\Entity\ConfigEntityStorage';
+            } elseif ((new ObjectType(ContentEntityInterface::class))->isSuperTypeOf($classType)->yes()) {
+                $this->storageClassName = 'Drupal\Core\Entity\Sql\SqlContentEntityStorage';
+            } else {
+                return null;
+            }
         }
 
         $storageType = new ObjectType($this->storageClassName);

tests/src/Type/data/entity-type-manager.php

@@ -12,9 +12,7 @@
 assertType('Drupal\taxonomy\TermStorage', $etm->getStorage('taxonomy_term'));
 assertType('Drupal\Core\Entity\EntityStorageInterface', $etm->getStorage('search_api_index'));
 assertType('Drupal\Core\Config\Entity\ConfigEntityStorage', $etm->getStorage('block'));
-// @todo fix this assert with a lookup on known entity class type.
-// assertType('Drupal\Core\Entity\Sql\SqlContentEntityStorage', $etm->getStorage('content_entity_using_default_storage'));
-assertType('Drupal\Core\Entity\EntityStorageInterface', $etm->getStorage('content_entity_using_default_storage'));
+assertType('Drupal\Core\Entity\Sql\SqlContentEntityStorage', $etm->getStorage('content_entity_using_default_storage'));
 assertType('Drupal\phpstan_fixtures\CustomContentEntityStorage', $etm->getStorage('content_entity_using_custom_storage'));
 assertType('Drupal\Core\Config\Entity\ConfigEntityStorage', $etm->getStorage('config_entity_using_default_storage'));
 assertType('Drupal\phpstan_fixtures\CustomConfigEntityStorage', $etm->getStorage('config_entity_using_custom_storage'));