Merge pull request #277 from ptt-homme/feature/issue-240-expand-list-of-entity-type-storages

Expand list of entity type storages

Author: mglaman

README.md

@@ -91,16 +91,16 @@ directory using the `drupal.drupal_root` parameter.
 
 ```
 parameters:
-    drupal:
-        drupal_root: /path/to/drupal
+	drupal:
+		drupal_root: /path/to/drupal
 ```
 
 You can also use container parameters. For instance you can always set it to the current working directory.
 
 ```
 parameters:
-    drupal:
-        drupal_root: %currentWorkingDirectory%
+	drupal:
+		drupal_root: %currentWorkingDirectory%
 ```
 
 ### Entity storage mappings.
@@ -111,23 +111,36 @@ default mapping can be found in `extension.neon`. For example:
 
 ```
 parameters:
-    drupal:
-        entityTypeStorageMapping:
-            node: Drupal\node\NodeStorage
-            taxonomy_term: Drupal\taxonomy\TermStorage
-            user: Drupal\user\UserStorage
-            block: Drupal\Core\Config\Entity\ConfigEntityStorage
+	drupal:
+		entityMapping:
+			block:
+				class: Drupal\block\Entity\Block
+				storage: Drupal\Core\Config\Entity\ConfigEntityStorage
+			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
 ```
 
 To add support for custom entities, you may add the same definition in your project's `phpstan.neon`. See the following
 example for adding a mapping for Search API:
 
 ```
 parameters:
-    drupal:
-        entityTypeStorageMapping:
-            search_api_index: Drupal\search_api\Entity\SearchApiConfigEntityStorage
-            search_api_server: Drupal\search_api\Entity\SearchApiConfigEntityStorage
+	drupal:
+		entityMapping:
+			block:
+				search_api_index:
+					class: Drupal\search_api\Entity\Index
+					storage: Drupal\search_api\Entity\SearchApiConfigEntityStorage
+				search_api_server:
+					class: Drupal\search_api\Entity\Server
+					storage: Drupal\search_api\Entity\SearchApiConfigEntityStorage			    
 ```
 
 Similarly, the `EntityStorageDynamicReturnTypeExtension` service helps to determine the type of the entity which is
@@ -145,11 +158,19 @@ The default mapping can be found in `extension.neon`:
 ```neon
 parameters:
 	drupal:
-		entityStorageMapping:
-			node: Drupal\node\Entity\Node
-			taxonomy_term: Drupal\taxonomy\Entity\Term
-			user: Drupal\user\Entity\User
-			block: Drupal\block\Entity\Block
+		entityMapping:
+			block:
+				class: Drupal\block\Entity\Block
+				storage: Drupal\Core\Config\Entity\ConfigEntityStorage
+			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
 ```
 
 To add support for custom entities, you may add the same definition in your project's `phpstan.neon` likewise.

extension.neon

@@ -14,17 +14,218 @@ parameters:
 	drupal:
 		drupal_root: '%currentWorkingDirectory%'
 		entityMapping:
+			aggregator_feed:
+				class: Drupal\aggregator\Entity\Feed
+				storage: Drupal\aggregator\FeedStorage
+
+			aggregator_item:
+				class: Drupal\aggregator\Entity\Item
+				storage: Drupal\aggregator\ItemStorage
+
+			block:
+				class: Drupal\block\Entity\Block
+				storage: Drupal\Core\Config\Entity\ConfigEntityStorage
+
+			block_content:
+				class: Drupal\block_content\Entity\BlockContent
+				storage: Drupal\Core\Entity\Sql\SqlContentEntityStorage
+
+			block_content_type:
+				class: Drupal\block_content\Entity\BlockContentType
+				storage: Drupal\Core\Config\Entity\ConfigEntityStorage
+
+			comment_type:
+				class: Drupal\comment\Entity\CommentType
+				storage: Drupal\Core\Config\Entity\ConfigEntityStorage
+
+			comment:
+				class: Drupal\comment\Entity\Comment
+				storage: Drupal\comment\CommentStorage
+
+			contact_form:
+				class: Drupal\contact\Entity\ContactForm
+				storage: Drupal\Core\Config\Entity\ConfigEntityStorage
+
+			contact_message:
+				class: Drupal\contact\Entity\Message
+				storage: Drupal\Core\Entity\ContentEntityNullStorage
+
+			content_moderation_state:
+				class: Drupal\content_moderation\Entity\ContentModerationState
+				storage: Drupal\Core\Entity\Sql\SqlContentEntityStorage
+
+			editor:
+				class: Drupal\editor\Entity\Editor
+				storage: Drupal\Core\Config\Entity\ConfigEntityStorage
+
+			field_config:
+				class: Drupal\field\Entity\FieldConfig
+				storage: Drupal\field\FieldConfigStorage
+
+			field_storage_config:
+				class: Drupal\field\Entity\FieldStorageConfig
+				storage: Drupal\field\FieldStorageConfigStorage
+
+			file:
+				class: Drupal\file\Entity\File
+				storage: Drupal\file\FileStorage
+
+			filter_format:
+				class: Drupal\filter\Entity\FilterFormat
+				storage: Drupal\Core\Config\Entity\ConfigEntityStorage
+
+			image_style:
+				class: Drupal\image\Entity\ImageStyle
+				storage: Drupal\image\ImageStyleStorage
+
+			imce_profile:
+				class: Drupal\imce\Entity\ImceProfile
+				storage: Drupal\Core\Config\Entity\ConfigEntityStorage
+
+			configurable_language:
+				class: Drupal\language\Entity\ConfigurableLanguage
+				storage: Drupal\Core\Config\Entity\ConfigEntityStorage
+
+			language_content_settings:
+				class: Drupal\language\Entity\ContentLanguageSettings
+				storage: Drupal\Core\Config\Entity\ConfigEntityStorage
+
+			media_type:
+				class: Drupal\media\Entity\MediaType
+				storage: Drupal\Core\Config\Entity\ConfigEntityStorage
+
+			media:
+				class: Drupal\media\Entity\Media
+				storage: Drupal\media\MediaStorage
+
+			menu_link_content:
+				class: Drupal\menu_link_content\Entity\MenuLinkContent
+				storage: \Drupal\menu_link_content\MenuLinkContentStorage
+
+			metatag_defaults:
+				class: Drupal\metatag\Entity\MetatagDefaults
+				storage: Drupal\Core\Config\Entity\ConfigEntityStorage
+
+			node_type:
+				class: Drupal\node\Entity\NodeType
+				storage: Drupal\Core\Config\Entity\ConfigEntityStorage
+
 			node:
 				class: Drupal\node\Entity\Node
 				storage: Drupal\node\NodeStorage
+
+			path_alias:
+				class: Drupal\path_alias\Entity\PathAlias
+				storage: Drupal\path_alias\PathAliasStorage
+
+			rdf_mapping:
+				class: Drupal\rdf\Entity\RdfMapping
+				storage: Drupal\Core\Config\Entity\ConfigEntityStorage
+
+			responsive_image_style:
+				class: Drupal\responsive_image\Entity\ResponsiveImageStyle
+				storage: Drupal\Core\Config\Entity\ConfigEntityStorage
+
+			search_page:
+				class: Drupal\search\Entity\SearchPage
+				storage: Drupal\Core\Config\Entity\ConfigEntityStorage
+
+			search_api_server:
+				class: Drupal\search_api\Entity\Server
+				storage: Drupal\search_api\Entity\SearchApiConfigEntityStorage
+
+			search_api_index:
+				class: Drupal\search_api\Entity\Index
+				storage: Drupal\search_api\Entity\SearchApiConfigEntityStorage
+
+			search_api_task:
+				class: Drupal\search_api\Entity\Task
+				storage: Drupal\Core\Entity\Sql\SqlContentEntityStorage
+
+			shortcut_set:
+				class: Drupal\shortcut\Entity\ShortcutSet
+				storage: Drupal\shortcut\ShortcutSetStorage
+
+			shortcut:
+				class: Drupal\shortcut\Entity\Shortcut
+				storage: Drupal\Core\Entity\Sql\SqlContentEntityStorage
+
+			action:
+				class: Drupal\system\Entity\Action
+				storage: Drupal\Core\Config\Entity\ConfigEntityStorage
+
+			menu:
+				class: Drupal\system\Entity\Menu
+				storage: Drupal\system\MenuStorage
+
 			taxonomy_term:
 				class: Drupal\taxonomy\Entity\Term
 				storage: Drupal\taxonomy\TermStorage
+
+			taxonomy_vocabulary:
+				class: Drupal\taxonomy\Entity\Vocabulary
+				storage: Drupal\taxonomy\VocabularyStorage
+
+			tour:
+				class: Drupal\tour\Entity\Tour
+				storage: Drupal\Core\Config\Entity\ConfigEntityStorage
+
 			user:
 				class: Drupal\user\Entity\User
 				storage: Drupal\user\UserStorage
-			block:
-				class: Drupal\block\Entity\Block
+
+			user_role:
+				class: Drupal\user\Entity\Role
+				storage: Drupal\user\RoleStorage
+
+			webform:
+				class: Drupal\webform\Entity\Webform
+				storage: \Drupal\webform\WebformEntityStorage
+
+			webform_submission:
+				class: Drupal\webform\Entity\WebformSubmission
+				storage: Drupal\webform\WebformSubmissionStorage
+
+			webform_options:
+				class: Drupal\webform\Entity\WebformOptions
+				storage: \Drupal\webform\WebformOptionsStorage
+
+			workflow:
+				class: Drupal\workflows\Entity\Workflow
+				storage: Drupal\Core\Config\Entity\ConfigEntityStorage
+
+			pathauto_pattern:
+				class: Drupal\pathauto\Entity\PathautoPattern
+				storage: Drupal\Core\Config\Entity\ConfigEntityStorage
+
+			view:
+				class: Drupal\views\Entity\View
+				storage: Drupal\Core\Config\Entity\ConfigEntityStorage
+
+			date_format:
+				class: Drupal\Core\Datetime\Entity\DateFormat
+				storage: Drupal\Core\Config\Entity\ConfigEntityStorage
+
+			entity_form_mode:
+				class: Drupal\Core\Entity\Entity\EntityFormMode
+				storage: Drupal\Core\Config\Entity\ConfigEntityStorage
+
+			entity_view_display:
+				class: Drupal\layout_builder\Entity\LayoutBuilderEntityViewDisplay
+				storage: Drupal\layout_builder\Entity\LayoutBuilderEntityViewDisplayStorage
+
+			entity_form_display:
+				class: Drupal\Core\Entity\Entity\EntityFormDisplay
+				storage: Drupal\Core\Config\Entity\ConfigEntityStorage
+
+			entity_view_mode:
+				class: Drupal\Core\Entity\Entity\EntityViewMode
+				storage: Drupal\Core\Config\Entity\ConfigEntityStorage
+
+			base_field_override:
+				class: Drupal\Core\Field\Entity\BaseFieldOverride
+				storage: Drupal\Core\Field\BaseFieldOverrideStorage
+
 parametersSchema:
 	drupal: structure([
 		drupal_root: string()

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

@@ -10,7 +10,7 @@
 assertType('Drupal\node\NodeStorage', $etm->getStorage('node'));
 assertType('Drupal\user\UserStorage', $etm->getStorage('user'));
 assertType('Drupal\taxonomy\TermStorage', $etm->getStorage('taxonomy_term'));
-assertType('Drupal\Core\Entity\EntityStorageInterface', $etm->getStorage('search_api_index'));
+assertType('Drupal\search_api\Entity\SearchApiConfigEntityStorage', $etm->getStorage('search_api_index'));
 assertType('Drupal\Core\Config\Entity\ConfigEntityStorage', $etm->getStorage('block'));
 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'));