Add stubs for core field types

mglaman · mglaman · commit 0cff2b6efe73 · 2022-02-18T16:29:19.000-05:00
diff --git a/extension.neon b/extension.neon
@@ -13,6 +13,37 @@ parameters:
 		- engine
 	scanFiles:
 		- stubs/Twig/functions.stub
+	stubFiles:
+		- stubs/Drupal/Component/Plugin/PluginInspectionInterface.stub
+		- stubs/Drupal/Core/Field/Plugin/Field/FieldItemBase.stub
+		- stubs/Drupal/Core/Field/Plugin/Field/FieldItemInterface.stub
+		- stubs/Drupal/Core/Field/Plugin/Field/PreconfiguredFieldUiOptionsInterface.stub
+		- stubs/Drupal/Core/Field/Plugin/Field/FieldType/BooleanItem.stub
+		- stubs/Drupal/Core/Field/Plugin/Field/FieldType/ChangedItem.stub
+		- stubs/Drupal/Core/Field/Plugin/Field/FieldType/CreatedItem.stub
+		- stubs/Drupal/Core/Field/Plugin/Field/FieldType/DecimalItem.stub
+		- stubs/Drupal/Core/Field/Plugin/Field/FieldType/EmailItem.stub
+		- stubs/Drupal/Core/Field/Plugin/Field/FieldType/EntityReferenceItem.stub
+		- stubs/Drupal/Core/Field/Plugin/Field/FieldType/FloatItem.stub
+		- stubs/Drupal/Core/Field/Plugin/Field/FieldType/IntegerItem.stub
+		- stubs/Drupal/Core/Field/Plugin/Field/FieldType/LanguageItem.stub
+		- stubs/Drupal/Core/Field/Plugin/Field/FieldType/MapItem.stub
+		- stubs/Drupal/Core/Field/Plugin/Field/FieldType/NumericItemBase.stub
+		- stubs/Drupal/Core/Field/Plugin/Field/FieldType/PasswordItem.stub
+		- stubs/Drupal/Core/Field/Plugin/Field/FieldType/StringItem.stub
+		- stubs/Drupal/Core/Field/Plugin/Field/FieldType/StringItemBase.stub
+		- stubs/Drupal/Core/Field/Plugin/Field/FieldType/StringLongItem.stub
+		- stubs/Drupal/Core/Field/Plugin/Field/FieldType/TimestampItem.stub
+		- stubs/Drupal/Core/Field/Plugin/Field/FieldType/UriItem.stub
+		- stubs/Drupal/Core/Field/Plugin/Field/FieldType/UuidItem.stub
+		- stubs/Drupal/Core/TypedData/ComplexDataInterface.stub
+		- stubs/Drupal/Core/TypedData/OptionsProviderInterface.stub
+		- stubs/Drupal/Core/TypedData/TraversableTypedDataInterface.stub
+		- stubs/Drupal/Core/TypedData/TypedData.stub
+		- stubs/Drupal/Core/TypedData/TypedDataInterface.stub
+		- stubs/Drupal/Core/TypedData/Plugin/DataType/Map.stub
+		- stubs/Drupal/link/LinkItemInterface.stub
+		- stubs/Drupal/link/Plugin/Field/FieldType/LinkItem.stub
 	drupal:
 		drupal_root: '%currentWorkingDirectory%'
 		entityMapping:
diff --git a/src/Reflection/FieldItemListPropertyReflection.php b/src/Reflection/FieldItemListPropertyReflection.php
@@ -43,6 +43,7 @@ public function getReadableType(): Type
             return new ObjectType('Drupal\Core\Entity\EntityInterface');
         }
         if ($this->propertyName === 'target_id') {
+            // @todo needs to be union type.
             return new StringType();
         }
         // @todo this is wrong, integer/bool/decimal/etc all use single value property.
diff --git a/stubs/Drupal/Component/Plugin/PluginInspectionInterface.stub b/stubs/Drupal/Component/Plugin/PluginInspectionInterface.stub
@@ -0,0 +1,6 @@
+<?php
+
+namespace Drupal\Component\Plugin;
+
+interface PluginInspectionInterface {
+}
diff --git a/stubs/Drupal/Core/Field/Plugin/Field/FieldItemBase.stub b/stubs/Drupal/Core/Field/Plugin/Field/FieldItemBase.stub
@@ -0,0 +1,8 @@
+<?php
+
+namespace Drupal\Core\Field;
+
+use Drupal\Core\TypedData\Plugin\DataType\Map;
+
+abstract class FieldItemBase extends Map implements FieldItemInterface {
+}
diff --git a/stubs/Drupal/Core/Field/Plugin/Field/FieldItemInterface.stub b/stubs/Drupal/Core/Field/Plugin/Field/FieldItemInterface.stub
@@ -0,0 +1,8 @@
+<?php
+
+namespace Drupal\Core\Field;
+
+use Drupal\Core\TypedData\ComplexDataInterface;
+
+interface FieldItemInterface extends ComplexDataInterface {
+}
diff --git a/stubs/Drupal/Core/Field/Plugin/Field/FieldType/BooleanItem.stub b/stubs/Drupal/Core/Field/Plugin/Field/FieldType/BooleanItem.stub
@@ -0,0 +1,12 @@
+<?php
+
+namespace Drupal\Core\Field\Plugin\Field\FieldType;
+
+use Drupal\Core\Field\FieldItemBase;
+use Drupal\Core\TypedData\OptionsProviderInterface;
+
+/**
+ * @property int $value
+ */
+class BooleanItem extends FieldItemBase implements OptionsProviderInterface {
+}
diff --git a/stubs/Drupal/Core/Field/Plugin/Field/FieldType/ChangedItem.stub b/stubs/Drupal/Core/Field/Plugin/Field/FieldType/ChangedItem.stub
@@ -0,0 +1,6 @@
+<?php
+
+namespace Drupal\Core\Field\Plugin\Field\FieldType;
+
+class ChangedItem extends CreatedItem {
+}
diff --git a/stubs/Drupal/Core/Field/Plugin/Field/FieldType/CreatedItem.stub b/stubs/Drupal/Core/Field/Plugin/Field/FieldType/CreatedItem.stub
@@ -0,0 +1,6 @@
+<?php
+
+namespace Drupal\Core\Field\Plugin\Field\FieldType;
+
+class CreatedItem extends TimestampItem {
+}
diff --git a/stubs/Drupal/Core/Field/Plugin/Field/FieldType/DecimalItem.stub b/stubs/Drupal/Core/Field/Plugin/Field/FieldType/DecimalItem.stub
@@ -0,0 +1,9 @@
+<?php
+
+namespace Drupal\Core\Field\Plugin\Field\FieldType;
+
+/**
+ * @property string $value
+ */
+class DecimalItem extends NumericItemBase {
+}
diff --git a/stubs/Drupal/Core/Field/Plugin/Field/FieldType/EmailItem.stub b/stubs/Drupal/Core/Field/Plugin/Field/FieldType/EmailItem.stub
@@ -0,0 +1,11 @@
+<?php
+
+namespace Drupal\Core\Field\Plugin\Field\FieldType;
+
+use Drupal\Core\Field\FieldItemBase;
+
+/**
+ * @property string $value
+ */
+class EmailItem extends FieldItemBase {
+}
diff --git a/stubs/Drupal/Core/Field/Plugin/Field/FieldType/EntityReferenceItem.stub b/stubs/Drupal/Core/Field/Plugin/Field/FieldType/EntityReferenceItem.stub
@@ -0,0 +1,14 @@
+<?php
+
+namespace Drupal\Core\Field\Plugin\Field\FieldType;
+
+use Drupal\Core\Field\FieldItemBase;
+use Drupal\Core\Field\PreconfiguredFieldUiOptionsInterface;
+use Drupal\Core\TypedData\OptionsProviderInterface;
+
+/**
+ * @property string|integer $target_id
+ * @property \Drupal\Core\Entity\EntityInterface $entity
+ */
+class EntityReferenceItem extends FieldItemBase implements OptionsProviderInterface, PreconfiguredFieldUiOptionsInterface {
+}
diff --git a/stubs/Drupal/Core/Field/Plugin/Field/FieldType/FloatItem.stub b/stubs/Drupal/Core/Field/Plugin/Field/FieldType/FloatItem.stub
@@ -0,0 +1,9 @@
+<?php
+
+namespace Drupal\Core\Field\Plugin\Field\FieldType;
+
+/**
+ * @property float $value
+ */
+class FloatItem extends NumericItemBase {
+}
diff --git a/stubs/Drupal/Core/Field/Plugin/Field/FieldType/IntegerItem.stub b/stubs/Drupal/Core/Field/Plugin/Field/FieldType/IntegerItem.stub
@@ -0,0 +1,9 @@
+<?php
+
+namespace Drupal\Core\Field\Plugin\Field\FieldType;
+
+/**
+ * @property int $value
+ */
+class IntegerItem extends NumericItemBase {
+}
diff --git a/stubs/Drupal/Core/Field/Plugin/Field/FieldType/LanguageItem.stub b/stubs/Drupal/Core/Field/Plugin/Field/FieldType/LanguageItem.stub
@@ -0,0 +1,13 @@
+<?php
+
+namespace Drupal\Core\Field\Plugin\Field\FieldType;
+
+use Drupal\Core\Field\FieldItemBase;
+use Drupal\Core\TypedData\OptionsProviderInterface;
+
+/**
+ * @property string $value
+ * @property \Drupal\Core\Language\LanguageInterface $language
+ */
+class LanguageItem extends FieldItemBase implements OptionsProviderInterface {
+}
diff --git a/stubs/Drupal/Core/Field/Plugin/Field/FieldType/MapItem.stub b/stubs/Drupal/Core/Field/Plugin/Field/FieldType/MapItem.stub
@@ -0,0 +1,11 @@
+<?php
+
+namespace Drupal\Core\Field\Plugin\Field\FieldType;
+
+use Drupal\Core\Field\FieldItemBase;
+
+/**
+ * @property array<string, mixed> $value
+ */
+class MapItem extends FieldItemBase {
+}
diff --git a/stubs/Drupal/Core/Field/Plugin/Field/FieldType/NumericItemBase.stub b/stubs/Drupal/Core/Field/Plugin/Field/FieldType/NumericItemBase.stub
@@ -0,0 +1,8 @@
+<?php
+
+namespace Drupal\Core\Field\Plugin\Field\FieldType;
+
+use Drupal\Core\Field\FieldItemBase;
+
+abstract class NumericItemBase extends FieldItemBase {
+}
diff --git a/stubs/Drupal/Core/Field/Plugin/Field/FieldType/PasswordItem.stub b/stubs/Drupal/Core/Field/Plugin/Field/FieldType/PasswordItem.stub
@@ -0,0 +1,10 @@
+<?php
+
+namespace Drupal\Core\Field\Plugin\Field\FieldType;
+
+/**
+ * @property ?string $existing
+ * @property bool $pre_hashed
+ */
+class PasswordItem extends StringItem {
+}
diff --git a/stubs/Drupal/Core/Field/Plugin/Field/FieldType/StringItem.stub b/stubs/Drupal/Core/Field/Plugin/Field/FieldType/StringItem.stub
@@ -0,0 +1,6 @@
+<?php
+
+namespace Drupal\Core\Field\Plugin\Field\FieldType;
+
+class StringItem extends StringItemBase {
+}
diff --git a/stubs/Drupal/Core/Field/Plugin/Field/FieldType/StringItemBase.stub b/stubs/Drupal/Core/Field/Plugin/Field/FieldType/StringItemBase.stub
@@ -0,0 +1,11 @@
+<?php
+
+namespace Drupal\Core\Field\Plugin\Field\FieldType;
+
+use Drupal\Core\Field\FieldItemBase;
+
+/**
+ * @property string $value
+ */
+abstract class StringItemBase extends FieldItemBase {
+}
diff --git a/stubs/Drupal/Core/Field/Plugin/Field/FieldType/StringLongItem.stub b/stubs/Drupal/Core/Field/Plugin/Field/FieldType/StringLongItem.stub
@@ -0,0 +1,6 @@
+<?php
+
+namespace Drupal\Core\Field\Plugin\Field\FieldType;
+
+class StringLongItem extends StringItemBase {
+}
diff --git a/stubs/Drupal/Core/Field/Plugin/Field/FieldType/TimestampItem.stub b/stubs/Drupal/Core/Field/Plugin/Field/FieldType/TimestampItem.stub
@@ -0,0 +1,11 @@
+<?php
+
+namespace Drupal\Core\Field\Plugin\Field\FieldType;
+
+use Drupal\Core\Field\FieldItemBase;
+
+/**
+ * @property string $value
+ */
+class TimestampItem extends FieldItemBase {
+}
diff --git a/stubs/Drupal/Core/Field/Plugin/Field/FieldType/UriItem.stub b/stubs/Drupal/Core/Field/Plugin/Field/FieldType/UriItem.stub
@@ -0,0 +1,6 @@
+<?php
+
+namespace Drupal\Core\Field\Plugin\Field\FieldType;
+
+class UriItem extends StringItem {
+}
diff --git a/stubs/Drupal/Core/Field/Plugin/Field/FieldType/UuidItem.stub b/stubs/Drupal/Core/Field/Plugin/Field/FieldType/UuidItem.stub
@@ -0,0 +1,6 @@
+<?php
+
+namespace Drupal\Core\Field\Plugin\Field\FieldType;
+
+class UuidItem extends StringItem {
+}
diff --git a/stubs/Drupal/Core/Field/Plugin/Field/PreconfiguredFieldUiOptionsInterface.stub b/stubs/Drupal/Core/Field/Plugin/Field/PreconfiguredFieldUiOptionsInterface.stub
@@ -0,0 +1,6 @@
+<?php
+
+namespace Drupal\Core\Field;
+
+interface PreconfiguredFieldUiOptionsInterface {
+}
diff --git a/stubs/Drupal/Core/TypedData/ComplexDataInterface.stub b/stubs/Drupal/Core/TypedData/ComplexDataInterface.stub
@@ -0,0 +1,6 @@
+<?php
+
+namespace Drupal\Core\TypedData;
+
+interface ComplexDataInterface extends TraversableTypedDataInterface {
+}
diff --git a/stubs/Drupal/Core/TypedData/OptionsProviderInterface.stub b/stubs/Drupal/Core/TypedData/OptionsProviderInterface.stub
@@ -0,0 +1,6 @@
+<?php
+
+namespace Drupal\Core\TypedData;
+
+interface OptionsProviderInterface {
+}
diff --git a/stubs/Drupal/Core/TypedData/Plugin/DataType/Map.stub b/stubs/Drupal/Core/TypedData/Plugin/DataType/Map.stub
@@ -0,0 +1,12 @@
+<?php
+
+namespace Drupal\Core\TypedData\Plugin\DataType;
+
+use Drupal\Core\TypedData\TypedData;
+use Drupal\Core\TypedData\ComplexDataInterface;
+
+/**
+ * @implements \IteratorAggregate<string, \Drupal\Core\TypedData\TypedDataInterface>
+ */
+class Map extends TypedData implements \IteratorAggregate, ComplexDataInterface {
+}
diff --git a/stubs/Drupal/Core/TypedData/TraversableTypedDataInterface.stub b/stubs/Drupal/Core/TypedData/TraversableTypedDataInterface.stub
@@ -0,0 +1,9 @@
+<?php
+
+namespace Drupal\Core\TypedData;
+
+/**
+ * @extends \Traversable<string, \Drupal\Core\TypedData\TypedDataInterface>
+ */
+interface TraversableTypedDataInterface extends TypedDataInterface, \Traversable {
+}
diff --git a/stubs/Drupal/Core/TypedData/TypedData.stub b/stubs/Drupal/Core/TypedData/TypedData.stub
@@ -0,0 +1,8 @@
+<?php
+
+namespace Drupal\Core\TypedData;
+
+use Drupal\Component\Plugin\PluginInspectionInterface;
+
+abstract class TypedData implements TypedDataInterface, PluginInspectionInterface {
+}
diff --git a/stubs/Drupal/Core/TypedData/TypedDataInterface.stub b/stubs/Drupal/Core/TypedData/TypedDataInterface.stub
@@ -0,0 +1,6 @@
+<?php
+
+namespace Drupal\Core\TypedData;
+
+interface TypedDataInterface {
+}
diff --git a/stubs/Drupal/link/LinkItemInterface.stub b/stubs/Drupal/link/LinkItemInterface.stub
@@ -0,0 +1,8 @@
+<?php
+
+namespace Drupal\link;
+
+use Drupal\Core\Field\FieldItemInterface;
+
+interface LinkItemInterface extends FieldItemInterface {
+}
diff --git a/stubs/Drupal/link/Plugin/Field/FieldType/LinkItem.stub b/stubs/Drupal/link/Plugin/Field/FieldType/LinkItem.stub
@@ -0,0 +1,15 @@
+<?php
+
+namespace Drupal\link\Plugin\Field\FieldType;
+
+use Drupal\Core\Field\FieldItemBase;
+use Drupal\link\LinkItemInterface;
+
+/**
+ * @property string $uri
+ * @property string $title
+ * @property array<string, mixed> $options
+ */
+class LinkItem extends FieldItemBase implements LinkItemInterface {
+
+}
diff --git a/tests/src/Type/FieldTypesTest.php b/tests/src/Type/FieldTypesTest.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 FieldTypesTest extends TypeInferenceTestCase
+{
+    use AdditionalConfigFilesTrait;
+
+    public function dataFileAsserts(): iterable
+    {
+        yield from $this->gatherAssertTypes(__DIR__ . '/data/field-types.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/Type/data/field-types.php b/tests/src/Type/data/field-types.php

Original file line number	Diff line number	Diff line change
`@@ -43,6 +43,7 @@ public function getReadableType(): Type`
`43`	`43`	`return new ObjectType('Drupal\Core\Entity\EntityInterface');`
`44`	`44`	`}`
`45`	`45`	`if ($this->propertyName === 'target_id') {`
	`46`	`+ // @todo needs to be union type.`
`46`	`47`	`return new StringType();`
`47`	`48`	`}`
`48`	`49`	`// @todo this is wrong, integer/bool/decimal/etc all use single value property.`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,6 @@ @@
 +<?php
++
 +namespace Drupal\Component\Plugin;
++
 +interface PluginInspectionInterface {
 +}