Add stubs for ContentEntityInterface and FieldableEntityInterface

Fixes #412 and provides iterable template for content entities.

Author: mglaman

phpstan.neon

@@ -10,5 +10,6 @@ parameters:
 		- tests/src
 	excludePaths:
 		-  tests/src/Type/data/*.php
+		-  tests/src/Rules/data/*.php
 	dynamicConstantNames:
 		- Drupal::VERSION

stubs/Drupal/Core/Entity/ContentEntityInterface.stub

@@ -0,0 +1,12 @@
+<?php
+
+namespace Drupal\Core\Entity;
+
+/**
+ * @extends \Traversable<string, \Drupal\Core\Field\FieldItemListInterface>
+ *
+ * @see \Drupal\Core\Entity\FieldableEntityInterface::getFields
+ */
+interface ContentEntityInterface extends \Traversable, FieldableEntityInterface, TranslatableRevisionableInterface, SynchronizableInterface {
+
+}

stubs/Drupal/Core/Entity/FieldableEntityInterface.stub

@@ -0,0 +1,36 @@
+<?php
+
+namespace Drupal\Core\Entity;
+
+interface FieldableEntityInterface extends EntityInterface {
+
+    /**
+     * @return array<string, \Drupal\Core\Field\FieldDefinitionInterface>
+     */
+    public static function baseFieldDefinitions(EntityTypeInterface $entity_type): array;
+
+    /**
+     * @return array<string, \Drupal\Core\Field\FieldDefinitionInterface>
+     */
+    public static function bundleFieldDefinitions(EntityTypeInterface $entity_type, string $bundle, array $base_field_definitions): array;
+
+    /**
+     * @return array<string, \Drupal\Core\Field\FieldDefinitionInterface>
+     */
+    public function getFieldDefinitions(): array;
+
+    /**
+     * @return array<string, mixed>
+     */
+    public function toArray(): array;
+
+    /**
+     * @return array<string, \Drupal\Core\Field\FieldItemListInterface>
+     */
+    public function getFields(bool $include_computed = TRUE): array;
+
+    /**
+     * @return array<string, \Drupal\Core\Field\FieldItemListInterface>
+     */
+    public function getTranslatableFields(bool $include_computed = TRUE): array;
+}

tests/src/Rules/EntityParameterTypehintRuleTest.php

@@ -0,0 +1,26 @@
+<?php declare(strict_types=1);
+
+namespace mglaman\PHPStanDrupal\Tests\Rules;
+
+use mglaman\PHPStanDrupal\Tests\DrupalRuleTestCase;
+use PHPStan\Rules\Functions\MissingFunctionParameterTypehintRule;
+use PHPStan\Rules\MissingTypehintCheck;
+use PHPStan\Rules\Rule;
+
+final class EntityParameterTypehintRuleTest extends DrupalRuleTestCase
+{
+    protected function getRule(): Rule
+    {
+        $broker = $this->createReflectionProvider();
+        // @phpstan-ignore-next-line
+        return new MissingFunctionParameterTypehintRule(new MissingTypehintCheck($broker, true, true, true, true, []));
+    }
+
+    public function testRule(): void
+    {
+        $this->analyse(
+            [__DIR__.'/data/entity-parameters.php'],
+            []
+        );
+    }
+}

tests/src/Rules/data/entity-parameters.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace ContentEntityParameters;
+
+use Drupal\Core\Entity\Entity\EntityViewDisplay;
+use Drupal\user\Entity\User;
+
+function node_insert(\Drupal\node\NodeInterface $node): void {
+
+}
+function user_insert(User $user): void {
+
+}
+
+function config_insert(EntityViewDisplay $viewDisplay): void {
+
+}

tests/src/Type/EntityTypesTest.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace mglaman\PHPStanDrupal\Tests\Type;
+
+use mglaman\PHPStanDrupal\Tests\AdditionalConfigFilesTrait;
+use PHPStan\Testing\TypeInferenceTestCase;
+
+final class EntityTypesTest extends TypeInferenceTestCase
+{
+    use AdditionalConfigFilesTrait;
+
+    public function dataFileAsserts(): iterable
+    {
+        yield from $this->gatherAssertTypes(__DIR__ . '/data/entity-type-stubs.php');
+    }
+
+    /**
+     * @dataProvider dataFileAsserts
+     * @param string $assertType
+     * @param string $file
+     * @param mixed ...$args
+     */
+    public function testFileAsserts(
+        string $assertType,
+        string $file,
+        ...$args
+    ): void
+    {
+        $this->assertFileAsserts($assertType, $file, ...$args);
+    }
+}

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

@@ -0,0 +1,17 @@
+<?php
+
+namespace EntityTypeStubs;
+
+use Drupal\Core\Entity\ContentEntityInterface;
+use Drupal\Core\Field\FieldItemListInterface;
+use Drupal\node\Entity\Node;
+
+use function PHPStan\Testing\assertType;
+
+function (ContentEntityInterface $entity): void
+{
+    foreach ($entity as $name => $field) {
+        assertType('string', $name);
+        assertType(FieldItemListInterface::class, $field);
+    }
+};