Verified Commit 567f20ed authored by Dave Long's avatar Dave Long
Browse files

docs: #3496417 Fix PHPStan missingType.generics for FieldItemListInterface not specifying its type 

By: mondrake
By: mglaman
By: smustgrave
By: catch
By: mstrelan
(cherry picked from commit 41ee2804)
parent a3460c4f

core/.phpstan-baseline.php

+0 −54
Original line number Diff line number Diff line
@@ -4172,12 +4172,6 @@ 
	'count' => 1,

	'path' => __DIR__ . '/lib/Drupal/Core/Entity/ContentEntityBase.php',

];

$ignoreErrors[] = [

	'message' => '#^Method Drupal\\\\Core\\\\Entity\\\\ContentEntityBase\\:\\:getTranslatedField\\(\\) return type with generic interface Drupal\\\\Core\\\\Field\\\\FieldItemListInterface does not specify its types\\: T$#',

	'identifier' => 'missingType.generics',

	'count' => 1,

	'path' => __DIR__ . '/lib/Drupal/Core/Entity/ContentEntityBase.php',

];

$ignoreErrors[] = [

	'message' => '#^Method Drupal\\\\Core\\\\Entity\\\\ContentEntityBase\\:\\:onChange\\(\\) has no return type specified\\.$#',

	'identifier' => 'missingType.return',
@@ -4424,12 +4418,6 @@ 
	'count' => 1,

	'path' => __DIR__ . '/lib/Drupal/Core/Entity/ContentEntityNullStorage.php',

];

$ignoreErrors[] = [

	'message' => '#^Method Drupal\\\\Core\\\\Entity\\\\ContentEntityNullStorage\\:\\:readFieldItemsToPurge\\(\\) return type with generic interface Drupal\\\\Core\\\\Field\\\\FieldItemListInterface does not specify its types\\: T$#',

	'identifier' => 'missingType.generics',

	'count' => 1,

	'path' => __DIR__ . '/lib/Drupal/Core/Entity/ContentEntityNullStorage.php',

];

$ignoreErrors[] = [

	'message' => '#^Method Drupal\\\\Core\\\\Entity\\\\ContentEntityStorageBase\\:\\:deleteRevision\\(\\) has no return type specified\\.$#',

	'identifier' => 'missingType.return',
@@ -4550,12 +4538,6 @@ 
	'count' => 1,

	'path' => __DIR__ . '/lib/Drupal/Core/Entity/ContentEntityStorageBase.php',

];

$ignoreErrors[] = [

	'message' => '#^Method Drupal\\\\Core\\\\Entity\\\\ContentEntityStorageBase\\:\\:readFieldItemsToPurge\\(\\) return type with generic interface Drupal\\\\Core\\\\Field\\\\FieldItemListInterface does not specify its types\\: T$#',

	'identifier' => 'missingType.generics',

	'count' => 1,

	'path' => __DIR__ . '/lib/Drupal/Core/Entity/ContentEntityStorageBase.php',

];

$ignoreErrors[] = [

	'message' => '#^Method Drupal\\\\Core\\\\Entity\\\\ContentEntityStorageBase\\:\\:resetCache\\(\\) has no return type specified\\.$#',

	'identifier' => 'missingType.return',
@@ -5846,12 +5828,6 @@ 
	'count' => 1,

	'path' => __DIR__ . '/lib/Drupal/Core/Entity/Sql/SqlContentEntityStorage.php',

];

$ignoreErrors[] = [

	'message' => '#^Method Drupal\\\\Core\\\\Entity\\\\Sql\\\\SqlContentEntityStorage\\:\\:readFieldItemsToPurge\\(\\) return type with generic interface Drupal\\\\Core\\\\Field\\\\FieldItemListInterface does not specify its types\\: T$#',

	'identifier' => 'missingType.generics',

	'count' => 1,

	'path' => __DIR__ . '/lib/Drupal/Core/Entity/Sql/SqlContentEntityStorage.php',

];

$ignoreErrors[] = [

	'message' => '#^Method Drupal\\\\Core\\\\Entity\\\\Sql\\\\SqlContentEntityStorage\\:\\:restore\\(\\) has no return type specified\\.$#',

	'identifier' => 'missingType.return',
@@ -7126,12 +7102,6 @@ 
	'count' => 1,

	'path' => __DIR__ . '/lib/Drupal/Core/Field/FieldStorageDefinitionListenerInterface.php',

];

$ignoreErrors[] = [

	'message' => '#^Method Drupal\\\\Core\\\\Field\\\\FieldTypePluginManager\\:\\:createFieldItemList\\(\\) return type with generic interface Drupal\\\\Core\\\\Field\\\\FieldItemListInterface does not specify its types\\: T$#',

	'identifier' => 'missingType.generics',

	'count' => 1,

	'path' => __DIR__ . '/lib/Drupal/Core/Field/FieldTypePluginManager.php',

];

$ignoreErrors[] = [

	'message' => '#^Method Drupal\\\\Core\\\\Field\\\\FieldTypePluginManager\\:\\:getGroupedDefinitionsTrait\\(\\) has no return type specified\\.$#',

	'identifier' => 'missingType.return',
@@ -7150,12 +7120,6 @@ 
	'count' => 1,

	'path' => __DIR__ . '/lib/Drupal/Core/Field/FieldTypePluginManager.php',

];

$ignoreErrors[] = [

	'message' => '#^Method Drupal\\\\Core\\\\Field\\\\FieldTypePluginManagerInterface\\:\\:createFieldItemList\\(\\) return type with generic interface Drupal\\\\Core\\\\Field\\\\FieldItemListInterface does not specify its types\\: T$#',

	'identifier' => 'missingType.generics',

	'count' => 1,

	'path' => __DIR__ . '/lib/Drupal/Core/Field/FieldTypePluginManagerInterface.php',

];

$ignoreErrors[] = [

	'message' => '#^Method Drupal\\\\Core\\\\Field\\\\FieldUpdateActionBase\\:\\:execute\\(\\) has no return type specified\\.$#',

	'identifier' => 'missingType.return',
@@ -18936,12 +18900,6 @@ 
	'count' => 1,

	'path' => __DIR__ . '/modules/jsonapi/src/JsonApiResource/LinkCollection.php',

];

$ignoreErrors[] = [

	'message' => '#^Method Drupal\\\\jsonapi\\\\JsonApiResource\\\\ResourceObject\\:\\:extractContentEntityFields\\(\\) return type with generic interface Drupal\\\\Core\\\\Field\\\\FieldItemListInterface does not specify its types\\: T$#',

	'identifier' => 'missingType.generics',

	'count' => 1,

	'path' => __DIR__ . '/modules/jsonapi/src/JsonApiResource/ResourceObject.php',

];

$ignoreErrors[] = [

	'message' => '#^Method Drupal\\\\jsonapi\\\\JsonapiServiceProvider\\:\\:alter\\(\\) has no return type specified\\.$#',

	'identifier' => 'missingType.return',
@@ -29139,12 +29097,6 @@ 
	'count' => 1,

	'path' => __DIR__ . '/modules/serialization/tests/src/Unit/Encoder/XmlEncoderTest.php',

];

$ignoreErrors[] = [

	'message' => '#^Method Drupal\\\\Tests\\\\serialization\\\\Unit\\\\Normalizer\\\\ContentEntityNormalizerTest\\:\\:createMockFieldListItem\\(\\) return type with generic interface Drupal\\\\Core\\\\Field\\\\FieldItemListInterface does not specify its types\\: T$#',

	'identifier' => 'missingType.generics',

	'count' => 1,

	'path' => __DIR__ . '/modules/serialization/tests/src/Unit/Normalizer/ContentEntityNormalizerTest.php',

];

$ignoreErrors[] = [

	'message' => '#^Method Drupal\\\\Tests\\\\serialization\\\\Unit\\\\Normalizer\\\\DateTimeIso8601NormalizerTestDrupalDateTime\\:\\:setTimezone\\(\\) has no return type specified\\.$#',

	'identifier' => 'missingType.return',
@@ -48149,12 +48101,6 @@ 
	'count' => 1,

	'path' => __DIR__ . '/tests/Drupal/Tests/Core/DependencyInjection/DependencySerializationTest.php',

];

$ignoreErrors[] = [

	'message' => '#^Method Drupal\\\\Tests\\\\Core\\\\Entity\\\\EntityConstraintViolationListTest\\:\\:setupEntity\\(\\) return type with generic interface Drupal\\\\Core\\\\Field\\\\FieldItemListInterface does not specify its types\\: T$#',

	'identifier' => 'missingType.generics',

	'count' => 1,

	'path' => __DIR__ . '/tests/Drupal/Tests/Core/Entity/EntityConstraintViolationListTest.php',

];

$ignoreErrors[] = [

	'message' => '#^Method Drupal\\\\Tests\\\\Core\\\\Entity\\\\EntityFieldManagerTest\\:\\:setUpEntityWithFieldDefinition\\(\\) return type with generic interface Prophecy\\\\Prophecy\\\\ProphecyInterface does not specify its types\\: T$#',

	'identifier' => 'missingType.generics',

core/lib/Drupal/Core/Entity/ContentEntityBase.php

+1 −1
Original line number Diff line number Diff line
@@ -613,7 +613,7 @@ public function get($field_name) { 
  /**

   * Gets a translated field.

   *

   * @return \Drupal\Core\Field\FieldItemListInterface

   * @return \Drupal\Core\Field\FieldItemListInterface<\Drupal\Core\Field\FieldItemInterface>

   *   The translated field.

   */

  protected function getTranslatedField($name, $langcode) {

core/lib/Drupal/Core/Entity/ContentEntityStorageBase.php

+1 −1
Original line number Diff line number Diff line
@@ -590,7 +590,7 @@ public function purgeFieldData(FieldDefinitionInterface $field_definition, $batc 
   * @param int $batch_size

   *   The maximum number of field data records to purge before returning.

   *

   * @return \Drupal\Core\Field\FieldItemListInterface[]

   * @return array<int,\Drupal\Core\Field\FieldItemListInterface<\Drupal\Core\Field\FieldItemInterface>>

   *   An array of field item lists, keyed by entity revision id.

   */

  abstract protected function readFieldItemsToPurge(FieldDefinitionInterface $field_definition, $batch_size);

core/lib/Drupal/Core/Field/FieldItemList.php

+4 −0
Original line number Diff line number Diff line
@@ -17,6 +17,10 @@ 
 * properties. Note that even single-valued entity fields are represented as

 * list of field items, however for easy access to the contained item the entity

 * field delegates __get() and __set() calls directly to the first item.

 *

 * @template T of \Drupal\Core\Field\FieldItemInterface

 * @extends \Drupal\Core\TypedData\Plugin\DataType\ItemList<T>

 * @implements \Drupal\Core\Field\FieldItemListInterface<T>

 */

class FieldItemList extends ItemList implements FieldItemListInterface {

core/lib/Drupal/Core/Field/FieldItemListInterface.php

+4 −0
Original line number Diff line number Diff line
@@ -23,6 +23,10 @@ 
 * When implementing this interface which extends Traversable, make sure to list

 * IteratorAggregate or Iterator before this interface in the implements clause.

 *

 * @template T of \Drupal\Core\Field\FieldItemInterface

 * @extends \Drupal\Core\TypedData\ListInterface<T>

 * @property mixed $value

 *

 * @see \Drupal\Core\Field\FieldItemInterface

 */

interface FieldItemListInterface extends ListInterface, AccessibleInterface {