Merge pull request #433 from jacktonkin/generic-field-stubs

mglaman · web-flow · commit 5995dad10439 · 2022-07-13T13:49:27.000-05:00
Generic FieldItemListInterface and related stubs
diff --git a/stubs/Drupal/Core/Entity/FieldableEntityInterface.stub b/stubs/Drupal/Core/Entity/FieldableEntityInterface.stub
@@ -4,6 +4,11 @@ namespace Drupal\Core\Entity;
 
 interface FieldableEntityInterface extends EntityInterface {
 
+    /**
+     * @return \Drupal\Core\Field\FieldItemListInterface<\Drupal\Core\Field\FieldItemInterface>
+     */
+    public function get(string $field_name);
+
     /**
      * @return array<string, \Drupal\Core\Field\FieldDefinitionInterface>
      */
diff --git a/stubs/Drupal/Core/Field/EntityReferenceFieldItemListInterface.stub b/stubs/Drupal/Core/Field/EntityReferenceFieldItemListInterface.stub
@@ -0,0 +1,16 @@
+<?php
+
+namespace Drupal\Core\Field;
+
+use Drupal\Core\Entity\EntityInterface;
+use Drupal\Core\Field\Plugin\Field\FieldType\EntityReferenceItem;
+
+/**
+ * @template T of EntityInterface
+ * @extends FieldItemListInterface<EntityReferenceItem<T>>
+ * @property int|string|null $target_id
+ * @property ?T $entity
+ */
+interface EntityReferenceFieldItemListInterface extends FieldItemListInterface {
+
+}
diff --git a/stubs/Drupal/Core/Field/FieldDefinitionInterface.stub b/stubs/Drupal/Core/Field/FieldDefinitionInterface.stub
diff --git a/stubs/Drupal/Core/Field/FieldItemBase.stub b/stubs/Drupal/Core/Field/FieldItemBase.stub
diff --git a/stubs/Drupal/Core/Field/FieldItemInterface.stub b/stubs/Drupal/Core/Field/FieldItemInterface.stub
diff --git a/stubs/Drupal/Core/Field/FieldItemListInterface.stub b/stubs/Drupal/Core/Field/FieldItemListInterface.stub
@@ -0,0 +1,15 @@
+<?php
+
+namespace Drupal\Core\Field;
+
+use Drupal\Core\Access\AccessibleInterface;
+use Drupal\Core\TypedData\ListInterface;
+
+/**
+ * @template T of FieldItemInterface
+ * @extends ListInterface<T>
+ * @property mixed $value
+ */
+interface FieldItemListInterface extends ListInterface {
+
+}
diff --git a/stubs/Drupal/Core/Field/Plugin/Field/FieldItemListInterface.stub b/stubs/Drupal/Core/Field/Plugin/Field/FieldItemListInterface.stub
diff --git a/stubs/Drupal/Core/Field/Plugin/Field/FieldType/EntityReferenceItem.stub b/stubs/Drupal/Core/Field/Plugin/Field/FieldType/EntityReferenceItem.stub
@@ -7,8 +7,9 @@ use Drupal\Core\Field\PreconfiguredFieldUiOptionsInterface;
 use Drupal\Core\TypedData\OptionsProviderInterface;
 
 /**
- * @property string|integer $target_id
- * @property \Drupal\Core\Entity\EntityInterface|null $entity
+ * @template T of \Drupal\Core\Entity\EntityInterface
+ * @property ?T $entity
+ * @property string|int|null $target_id
  */
 class EntityReferenceItem extends FieldItemBase implements OptionsProviderInterface, PreconfiguredFieldUiOptionsInterface {
 }
diff --git a/stubs/Drupal/Core/Field/PreconfiguredFieldUiOptionsInterface.stub b/stubs/Drupal/Core/Field/PreconfiguredFieldUiOptionsInterface.stub
diff --git a/stubs/Drupal/Core/TypedData/ComplexDataInterface.stub b/stubs/Drupal/Core/TypedData/ComplexDataInterface.stub
@@ -2,5 +2,8 @@
 
 namespace Drupal\Core\TypedData;
 
+/**
+ * @extends TraversableTypedDataInterface<string, TypedDataInterface>
+ */
 interface ComplexDataInterface extends TraversableTypedDataInterface {
 }
diff --git a/stubs/Drupal/Core/TypedData/ListInterface.stub b/stubs/Drupal/Core/TypedData/ListInterface.stub
@@ -0,0 +1,22 @@
+<?php
+
+namespace Drupal\Core\TypedData;
+
+/**
+ * @template T of TypedDataInterface
+ * @extends TraversableTypedDataInterface<int, T>
+ * @extends \ArrayAccess<int,T>
+ */
+interface ListInterface extends TraversableTypedDataInterface, \ArrayAccess, \Countable {
+
+  /**
+   * @return ?T
+   */
+  public function first();
+
+  /**
+   * @return ?T
+   */
+  public function get(int $index);
+
+}
diff --git a/stubs/Drupal/Core/TypedData/TraversableTypedDataInterface.stub b/stubs/Drupal/Core/TypedData/TraversableTypedDataInterface.stub
@@ -3,7 +3,9 @@
 namespace Drupal\Core\TypedData;
 
 /**
- * @extends \Traversable<string, \Drupal\Core\TypedData\TypedDataInterface>
+ * @template I of int|string
+ * @template T of TypedDataInterface
+ * @extends \Traversable<I, T>
  */
 interface TraversableTypedDataInterface extends TypedDataInterface, \Traversable {
 }
diff --git a/stubs/Drupal/file/FileInterface.stub b/stubs/Drupal/file/FileInterface.stub
@@ -0,0 +1,9 @@
+<?php
+
+namespace Drupal\file;
+
+use Drupal\Core\Entity\EntityInterface;
+
+interface FileInterface extends EntityInterface {
+
+}
diff --git a/stubs/Drupal/file/Plugin/Field/FieldType/FileItem.stub b/stubs/Drupal/file/Plugin/Field/FieldType/FileItem.stub
@@ -3,8 +3,10 @@
 namespace Drupal\file\Plugin\Field\FieldType;
 
 use Drupal\Core\Field\Plugin\Field\FieldType\EntityReferenceItem;
+use Drupal\file\FileInterface;
 
 /**
+ * @extends EntityReferenceItem<FileInterface>
  * @property bool $display
  * @property string $description
  */
diff --git a/tests/src/Reflection/EntityFieldsViaMagicReflectionExtensionTest.php b/tests/src/Reflection/EntityFieldsViaMagicReflectionExtensionTest.php
@@ -80,7 +80,7 @@ public function dataHasProperty(): \Generator
         yield 'field item list_interface: value' => [
             \Drupal\Core\Field\FieldItemListInterface::class,
             'value',
-            true,
+            false,
         ];
         // @todo support more proeprties.
         yield 'field item list: format' => [
diff --git a/tests/src/Type/data/field-types.php b/tests/src/Type/data/field-types.php
@@ -68,7 +68,7 @@
 $entity_reference_field = $node->get('field_entity_reference')->first();
 assert($entity_reference_field instanceof EntityReferenceItem);
 assertType(EntityReferenceItem::class, $entity_reference_field);
-assertType('int|string', $entity_reference_field->target_id);
+assertType('int|string|null', $entity_reference_field->target_id);
 assertType('Drupal\Core\Entity\EntityInterface|null', $entity_reference_field->entity);
 
 // FloatItem.

Original file line number	Diff line number	Diff line change
`@@ -2,5 +2,8 @@`
`2`	`2`
`3`	`3`	`namespace Drupal\Core\TypedData;`
`4`	`4`
	`5`	`+/**`
	`6`	`+ * @extends TraversableTypedDataInterface<string, TypedDataInterface>`
	`7`	`+ */`
`5`	`8`	`interface ComplexDataInterface extends TraversableTypedDataInterface {`
`6`	`9`	`}`