Make FormatterInterface stub generic (#846)

Niklan · mglaman · web-flow · commit 59b9de035409 · 2025-05-20T15:21:15.000-05:00
* Make FormatterInterface stub generic * Add FormatterBase stub/generic * Add required stubs * Remove unused use * revise and pass T to FieldItemListInterface * Add initial FormatterInterface generic test * Add generics test data as excluded dir * Revert "Add initial FormatterInterface generic test" This reverts commit 6b3b75b. * Revert "Add generics test data as excluded dir" This reverts commit 248dcf7. * Revert generic definition to initial approach * Add more tests * WIP on tests * Fix tests * Fix tests * WIP * EntityReferenceFormatterBase stub * EntityReferenceFormatterBase stub * EntityReferenceFormatterBase stub * Fix test --------- Co-authored-by: Matt Glaman <nmd.matt@gmail.com>
diff --git a/composer.json b/composer.json
@@ -47,7 +47,8 @@
         },
         "classmap": [
             "tests/src/Type/data",
-            "tests/src/Rules/data"
+            "tests/src/Rules/data",
+            "tests/src/Generics/data"
         ]
     },
     "extra": {
diff --git a/phpstan.neon b/phpstan.neon
@@ -12,6 +12,7 @@ parameters:
 		- tests/src
 	excludePaths:
 		-  tests/src/data/*.php
+		-  tests/src/Generics/data/*.php
 		-  tests/src/Type/data/*.php
 		-  tests/src/Rules/data/*.php
 		-  tests/src/DeprecatedScope/data/*.php
diff --git a/stubs/Drupal/Component/Plugin/DependentPluginInterface.stub b/stubs/Drupal/Component/Plugin/DependentPluginInterface.stub
@@ -0,0 +1,7 @@
+<?php
+
+namespace Drupal\Component\Plugin;
+
+interface DependentPluginInterface {
+
+}
diff --git a/stubs/Drupal/Component/Plugin/DerivativeInspectionInterface.stub b/stubs/Drupal/Component/Plugin/DerivativeInspectionInterface.stub
@@ -0,0 +1,7 @@
+<?php
+
+namespace Drupal\Component\Plugin;
+
+interface DerivativeInspectionInterface {
+
+}
diff --git a/stubs/Drupal/Component/Plugin/PluginBase.stub b/stubs/Drupal/Component/Plugin/PluginBase.stub
@@ -0,0 +1,7 @@
+<?php
+
+namespace Drupal\Component\Plugin;
+
+abstract class PluginBase implements PluginInspectionInterface, DerivativeInspectionInterface {
+
+}
diff --git a/stubs/Drupal/Core/Field/EntityReferenceFieldItemList.stub b/stubs/Drupal/Core/Field/EntityReferenceFieldItemList.stub
@@ -0,0 +1,15 @@
+<?php
+
+namespace Drupal\Core\Field;
+
+use Drupal\Core\Entity\EntityInterface;
+use Drupal\Core\Field\Plugin\Field\FieldType\EntityReferenceItem;
+
+/**
+ * @template T of EntityInterface
+ * @extends FieldItemList<EntityReferenceItem<T>>
+ * @implements EntityReferenceFieldItemListInterface<T>
+ */
+class EntityReferenceFieldItemList extends FieldItemList implements EntityReferenceFieldItemListInterface {
+
+}
diff --git a/stubs/Drupal/Core/Field/FieldItemList.stub b/stubs/Drupal/Core/Field/FieldItemList.stub
@@ -5,16 +5,15 @@ namespace Drupal\Core\Field;
 use Drupal\Core\TypedData\Plugin\DataType\ItemList;
 
 /**
- * @template T of \Drupal\Core\Field\FieldItemInterface
+ * @template T of FieldItemInterface
  * @extends ItemList<T>
  * @implements FieldItemListInterface<T>
  */
 class FieldItemList extends ItemList implements FieldItemListInterface {
 
   /**
-   * @return \Drupal\Core\Field\FieldItemInterface
+   * @return T
    */
-  protected function createItem(int $offset = 0, ?mixed $value = NULL): \Drupal\Core\Field\FieldItemInterface {
-  }
+  protected function createItem(int $offset = 0, mixed $value = NULL): FieldItemInterface {}
 
 }
diff --git a/stubs/Drupal/Core/Field/FormatterBase.stub b/stubs/Drupal/Core/Field/FormatterBase.stub
@@ -0,0 +1,34 @@
+<?php
+
+namespace Drupal\Core\Field;
+
+use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
+
+/**
+ * @template T of FieldItemListInterface
+ * @implements FormatterInterface<T>
+ */
+abstract class FormatterBase extends PluginSettingsBase implements FormatterInterface, ContainerFactoryPluginInterface {
+
+  /**
+   * @param array<T> $entities_items
+   */
+  public function prepareView(array $entities_items): void {}
+
+  /**
+   * @param T $items
+   * @param string|null $langcode
+   *
+   * @return array<int|string, mixed>
+   */
+  public function view(FieldItemListInterface $items, $langcode = NULL) {}
+
+  /**
+   * @param T $items
+   * @param string $langcode
+   *
+   * @return array<int, array<int|string, mixed>>
+   */
+  public function viewElements(FieldItemListInterface $items, $langcode) {}
+
+}
diff --git a/stubs/Drupal/Core/Field/FormatterInterface.stub b/stubs/Drupal/Core/Field/FormatterInterface.stub
@@ -0,0 +1,31 @@
+<?php
+
+namespace Drupal\Core\Field;
+
+/**
+ * @template T of FieldItemListInterface
+ */
+interface FormatterInterface extends PluginSettingsInterface {
+
+  /**
+   * @param array<T> $entities_items
+   */
+  public function prepareView(array $entities_items): void;
+
+  /**
+   * @param T $items
+   * @param string|null $langcode
+   *
+   * @return array<int|string, mixed>
+   */
+  public function view(FieldItemListInterface $items, $langcode = NULL);
+
+  /**
+   * @param T $items
+   * @param string $langcode
+   *
+   * @return array<int, array<int|string, mixed>>
+   */
+  public function viewElements(FieldItemListInterface $items, $langcode);
+
+}
diff --git a/stubs/Drupal/Core/Field/Plugin/Field/FieldFormatter/EntityReferenceFormatterBase.stub b/stubs/Drupal/Core/Field/Plugin/Field/FieldFormatter/EntityReferenceFormatterBase.stub
@@ -0,0 +1,37 @@
+<?php
+
+namespace Drupal\Core\Field\Plugin\Field\FieldFormatter;
+
+use Drupal\Core\Entity\EntityInterface;
+use Drupal\Core\Field\EntityReferenceFieldItemList;
+use Drupal\Core\Field\FieldItemListInterface;
+use Drupal\Core\Field\FormatterBase;
+
+/**
+ * @template T of EntityInterface
+ * @extends FormatterBase<EntityReferenceFieldItemList<T>>
+ */
+abstract class EntityReferenceFormatterBase extends FormatterBase {
+
+  /**
+   * @param array<EntityReferenceFieldItemList<T>> $entities_items
+   */
+  public function prepareView(array $entities_items): void {}
+
+  /**
+   * @param EntityReferenceFieldItemList<T> $items
+   * @param string|null $langcode
+   *
+   * @return array<int|string, mixed>
+   */
+  public function view(FieldItemListInterface $items, $langcode = NULL) {}
+
+  /**
+   * @param EntityReferenceFieldItemList<T> $items
+   * @param string $langcode
+   *
+   * @return array<int, array<int|string, mixed>>
+   */
+  public function viewElements(FieldItemListInterface $items, $langcode) {}
+
+}
diff --git a/stubs/Drupal/Core/Field/PluginSettingsBase.stub b/stubs/Drupal/Core/Field/PluginSettingsBase.stub
@@ -0,0 +1,10 @@
+<?php
+
+namespace Drupal\Core\Field;
+
+use Drupal\Component\Plugin\DependentPluginInterface;
+use Drupal\Core\Plugin\PluginBase;
+
+abstract class PluginSettingsBase extends PluginBase implements PluginSettingsInterface, DependentPluginInterface {
+
+}
diff --git a/stubs/Drupal/Core/Field/PluginSettingsInterface.stub b/stubs/Drupal/Core/Field/PluginSettingsInterface.stub
@@ -0,0 +1,10 @@
+<?php
+
+namespace Drupal\Core\Field;
+
+use Drupal\Component\Plugin\PluginInspectionInterface;
+use Drupal\Core\Config\Entity\ThirdPartySettingsInterface;
+
+interface PluginSettingsInterface extends PluginInspectionInterface, ThirdPartySettingsInterface {
+
+}
diff --git a/stubs/Drupal/Core/Plugin/ContainerFactoryPluginInterface.stub b/stubs/Drupal/Core/Plugin/ContainerFactoryPluginInterface.stub
@@ -0,0 +1,7 @@
+<?php
+
+namespace Drupal\Core\Plugin;
+
+interface ContainerFactoryPluginInterface {
+
+}
diff --git a/stubs/Drupal/Core/Plugin/PluginBase.stub b/stubs/Drupal/Core/Plugin/PluginBase.stub
@@ -0,0 +1,9 @@
+<?php
+
+namespace Drupal\Core\Plugin;
+
+use Drupal\Component\Plugin\PluginBase as ComponentPluginBase;
+
+abstract class PluginBase extends ComponentPluginBase {
+
+}
diff --git a/tests/src/Generics/EntityReferenceFieldItemListGenericTest.php b/tests/src/Generics/EntityReferenceFieldItemListGenericTest.php
@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace mglaman\PHPStanDrupal\Tests\Generics;
+
+use mglaman\PHPStanDrupal\Tests\AdditionalConfigFilesTrait;
+use PHPStan\Testing\TypeInferenceTestCase;
+
+final class EntityReferenceFieldItemListGenericTest extends TypeInferenceTestCase
+{
+    use AdditionalConfigFilesTrait;
+
+    public static function dataFileAsserts(): iterable
+    {
+        yield from self::gatherAssertTypes(__DIR__ . '/data/entity-reference-field-item-list.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);
+    }
+}
diff --git a/tests/src/Generics/EntityReferenceFormatterBaseGenericTest.php b/tests/src/Generics/EntityReferenceFormatterBaseGenericTest.php
@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace mglaman\PHPStanDrupal\Tests\Generics;
+
+use mglaman\PHPStanDrupal\Tests\AdditionalConfigFilesTrait;
+use PHPStan\Testing\TypeInferenceTestCase;
+
+final class EntityReferenceFormatterBaseGenericTest extends TypeInferenceTestCase
+{
+    use AdditionalConfigFilesTrait;
+
+    public static function dataFileAsserts(): iterable
+    {
+        yield from self::gatherAssertTypes(__DIR__ . '/data/entity-reference-formatter-base.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);
+    }
+}
diff --git a/tests/src/Generics/EntityReferenceItemGenericTest.php b/tests/src/Generics/EntityReferenceItemGenericTest.php
@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace mglaman\PHPStanDrupal\Tests\Generics;
+
+use mglaman\PHPStanDrupal\Tests\AdditionalConfigFilesTrait;
+use PHPStan\Testing\TypeInferenceTestCase;
+
+final class EntityReferenceItemGenericTest extends TypeInferenceTestCase
+{
+    use AdditionalConfigFilesTrait;
+
+    public static function dataFileAsserts(): iterable
+    {
+        yield from self::gatherAssertTypes(__DIR__ . '/data/entity-reference-item.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);
+    }
+}
diff --git a/tests/src/Generics/FormatterBaseGenericTest.php b/tests/src/Generics/FormatterBaseGenericTest.php
@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace mglaman\PHPStanDrupal\Tests\Generics;
+
+use mglaman\PHPStanDrupal\Tests\AdditionalConfigFilesTrait;
+use PHPStan\Testing\TypeInferenceTestCase;
+
+final class FormatterBaseGenericTest extends TypeInferenceTestCase
+{
+    use AdditionalConfigFilesTrait;
+
+    public static function dataFileAsserts(): iterable
+    {
+        yield from self::gatherAssertTypes(__DIR__ . '/data/formatter-base.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);
+    }
+}
diff --git a/tests/src/Generics/FormatterInterfaceGenericTest.php b/tests/src/Generics/FormatterInterfaceGenericTest.php
@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace mglaman\PHPStanDrupal\Tests\Generics;
+
+use mglaman\PHPStanDrupal\Tests\AdditionalConfigFilesTrait;
+use PHPStan\Testing\TypeInferenceTestCase;
+
+final class FormatterInterfaceGenericTest extends TypeInferenceTestCase
+{
+    use AdditionalConfigFilesTrait;
+
+    public static function dataFileAsserts(): iterable
+    {
+        yield from self::gatherAssertTypes(__DIR__ . '/data/formatter-interface.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);
+    }
+}
diff --git a/tests/src/Generics/data/entity-reference-field-item-list.php b/tests/src/Generics/data/entity-reference-field-item-list.php
diff --git a/tests/src/Generics/data/entity-reference-formatter-base.php b/tests/src/Generics/data/entity-reference-formatter-base.php
diff --git a/tests/src/Generics/data/entity-reference-item.php b/tests/src/Generics/data/entity-reference-item.php
diff --git a/tests/src/Generics/data/formatter-base.php b/tests/src/Generics/data/formatter-base.php
diff --git a/tests/src/Generics/data/formatter-interface.php b/tests/src/Generics/data/formatter-interface.php

-Original file line number
+Diff line change
@@ @@ -0,0 +1,7 @@ @@
 +<?php
++
 +namespace Drupal\Component\Plugin;
++
 +interface DependentPluginInterface {
++
 +}