Stub EntityTypeManagerInterface::getDefinition for conditional null return (#883)

Author: mglaman

stubs/Drupal/Core/Entity/EntityTypeManagerInterface.stub

@@ -0,0 +1,10 @@
+<?php
+
+namespace Drupal\Core\Entity;
+
+interface EntityTypeManagerInterface {
+    /**
+     * @return ($exception_on_invalid is true ? EntityTypeInterface : EntityTypeInterface|null)
+     */
+    public function getDefinition(string $entity_type_id, bool $exception_on_invalid = TRUE);
+}

tests/src/Type/EntityTypeManagerGetDefinitionTypeTest.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace mglaman\PHPStanDrupal\Tests\Type;
+
+use mglaman\PHPStanDrupal\Tests\AdditionalConfigFilesTrait;
+use PHPStan\Testing\TypeInferenceTestCase;
+
+final class EntityTypeManagerGetDefinitionTypeTest extends TypeInferenceTestCase
+{
+    use AdditionalConfigFilesTrait;
+
+    public static function dataFileAsserts(): iterable
+    {
+        yield from self::gatherAssertTypes(__DIR__ . '/data/entity-type-manager-definition.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-manager-definition.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace EntityTypeManagerGetDefinition;
+
+use function PHPStan\Testing\assertType;
+
+$etm = \Drupal::entityTypeManager();
+
+// When $exception_on_invalid is true (default), it should always return EntityTypeInterface
+assertType('Drupal\Core\Entity\EntityTypeInterface', $etm->getDefinition('node'));
+assertType('Drupal\Core\Entity\EntityTypeInterface', $etm->getDefinition('node', TRUE));
+
+// When $exception_on_invalid is false, it may return EntityTypeInterface or null
+assertType('Drupal\Core\Entity\EntityTypeInterface|null', $etm->getDefinition('non_existent_entity_type', FALSE));
+
+// Test with variable parameter
+$exception_on_invalid = false;
+assertType('Drupal\Core\Entity\EntityTypeInterface|null', $etm->getDefinition('some_entity_type', $exception_on_invalid));
+
+$exception_on_invalid = true;
+assertType('Drupal\Core\Entity\EntityTypeInterface', $etm->getDefinition('some_entity_type', $exception_on_invalid));