Issue #3297084: Automated Drupal 10 compatibility fixes

composer.json

@@ -25,7 +25,7 @@
     "minimum-stability": "dev",
     "prefer-stable": true,
     "require-dev": {
-        "drupal/core": "^9",
+        "drupal/core": "^9 || ^10",
         "drupal/coder": "^8.3",
         "phpunit/phpunit": "^6.5 || ^7"
     },

entity_normalization.info.yml

@@ -2,8 +2,7 @@ name: Entity Normalization
 description: Provides a way to easily create entity normalizing definitions in YAML files.
 package: Entity Normalization
 type: module
-core: 8.x
-core_version_requirement: ^8 || ^9
+core_version_requirement: ^9 || ^10
 dependencies:
   - drupal:system (>=8.5.0)
   - drupal:serialization

entity_normalization.services.yml

@@ -20,5 +20,6 @@ services:
 
   entity_normalization.field_item.normalizer:
     class: Drupal\entity_normalization\Normalizer\FieldItemNormalizer
+    arguments: ['@file_url_generator']
     tags:
       - { name: normalizer, priority: 10 }

entity_normalization_normalizers/entity_normalization_normalizers.info.yml

@@ -3,8 +3,7 @@ description: Provides some normalizers for the entity_normalization module.
 package: Entity Normalization
 
 type: module
-core: 8.x
-core_version_requirement: ^8 || ^9
+core_version_requirement: ^9 || ^10
 
 dependencies:
   - entity_normalization:entity_normalization

entity_normalization_normalizers/src/Normalizer/DateTimeToEpochNormalizer.php

@@ -23,7 +23,7 @@ class DateTimeToEpochNormalizer implements NormalizerInterface {
   /**
    * {@inheritdoc}
    */
-  public function supportsNormalization($data, $format = NULL) {
+  public function supportsNormalization($data, ?string $format = null, array $context = []): bool {
     return $data instanceof DateTimeItem;
   }
 

entity_normalization_normalizers/src/Normalizer/EntityUrlNormalizer.php

@@ -13,7 +13,7 @@ class EntityUrlNormalizer implements NormalizerInterface {
   /**
    * {@inheritdoc}
    */
-  public function normalize($object, $format = NULL, array $context = []) {
+  public function normalize($object, $format = NULL, array $context = []): array|string|int|float|bool|\ArrayObject|NULL {
     /** @var \Drupal\Core\Entity\EntityInterface $object */
 
     return $object->toUrl()->toString(TRUE)->getGeneratedUrl();
@@ -22,7 +22,7 @@ class EntityUrlNormalizer implements NormalizerInterface {
   /**
    * {@inheritdoc}
    */
-  public function supportsNormalization($data, $format = NULL) {
+  public function supportsNormalization($data, ?string $format = null, array $context = []): bool {
     return $data instanceof EntityInterface;
   }
 

entity_normalization_normalizers/src/Normalizer/NodeTypeNormalizer.php

@@ -13,7 +13,7 @@ class NodeTypeNormalizer implements NormalizerInterface {
   /**
    * {@inheritdoc}
    */
-  public function normalize($object, $format = NULL, array $context = []) {
+  public function normalize($object, $format = NULL, array $context = []): array|string|int|float|bool|\ArrayObject|NULL {
     /** @var \Drupal\node\NodeTypeInterface $object */
     return $object->id();
   }
@@ -21,7 +21,7 @@ class NodeTypeNormalizer implements NormalizerInterface {
   /**
    * {@inheritdoc}
    */
-  public function supportsNormalization($data, $format = NULL) {
+  public function supportsNormalization($data, ?string $format = null, array $context = []): bool {
     return $data instanceof NodeTypeInterface;
   }
 

entity_normalization_normalizers/src/Normalizer/NullNormalizer.php

@@ -12,14 +12,14 @@ class NullNormalizer implements NormalizerInterface {
   /**
    * {@inheritdoc}
    */
-  public function normalize($object, $format = NULL, array $context = []) {
+  public function normalize($object, $format = NULL, array $context = []): array|string|int|float|bool|\ArrayObject|NULL {
     return NULL;
   }
 
   /**
    * {@inheritdoc}
    */
-  public function supportsNormalization($data, $format = NULL) {
+  public function supportsNormalization($data, ?string $format = null, array $context = []): bool {
     return TRUE;
   }
 

entity_normalization_normalizers/src/Normalizer/RichTextNormalizer.php

@@ -14,7 +14,7 @@ class RichTextNormalizer implements NormalizerInterface {
   /**
    * {@inheritdoc}
    */
-  public function normalize($object, $format = NULL, array $context = []) {
+  public function normalize($object, $format = NULL, array $context = []): array|string|int|float|bool|\ArrayObject|NULL {
     /** @var \Drupal\text\Plugin\Field\FieldType\TextItemBase $object */
     return $object->getValue()['value'];
   }
@@ -22,7 +22,7 @@ class RichTextNormalizer implements NormalizerInterface {
   /**
    * {@inheritdoc}
    */
-  public function supportsNormalization($data, $format = NULL) {
+  public function supportsNormalization($data, ?string $format = null, array $context = []): bool {
     return $data instanceof TextLongItem || $data instanceof TextWithSummaryItem;
   }
 

entity_normalization_normalizers/src/Normalizer/TermParentIdNormalizer.php

@@ -13,7 +13,7 @@ class TermParentIdNormalizer implements NormalizerInterface {
   /**
    * {@inheritdoc}
    */
-  public function normalize($object, $format = NULL, array $context = []) {
+  public function normalize($object, $format = NULL, array $context = []): array|string|int|float|bool|\ArrayObject|NULL {
     /** @var \Drupal\taxonomy\TermInterface $object */
 
     $result = 0;
@@ -26,7 +26,7 @@ class TermParentIdNormalizer implements NormalizerInterface {
   /**
    * {@inheritdoc}
    */
-  public function supportsNormalization($data, $format = NULL) {
+  public function supportsNormalization($data, ?string $format = null, array $context = []): bool {
     return $data instanceof TermInterface;
   }
 

entity_normalization_normalizers/tests/src/Unit/Normalizer/DateTimeToEpochNormalizerTest.php

@@ -22,7 +22,8 @@ class DateTimeToEpochNormalizerTest extends UnitTestCase {
   /**
    * {@inheritdoc}
    */
-  protected function setUp() {
+  protected function setUp(): void {
+    parent::setUp();
     $this->normalizer = new DateTimeToEpochNormalizer();
   }
 

entity_normalization_normalizers/tests/src/Unit/Normalizer/EntityUrlNormalizerTest.php

@@ -24,7 +24,8 @@ class EntityUrlNormalizerTest extends UnitTestCase {
   /**
    * {@inheritdoc}
    */
-  protected function setUp() {
+  protected function setUp(): void {
+    parent::setUp();
     $this->normalizer = new EntityUrlNormalizer();
   }
 

entity_normalization_normalizers/tests/src/Unit/Normalizer/NodeTypeNormalizerTest.php

@@ -22,7 +22,8 @@ class NodeTypeNormalizerTest extends UnitTestCase {
   /**
    * {@inheritdoc}
    */
-  protected function setUp() {
+  protected function setUp(): void {
+    parent::setUp();
     $this->normalizer = new NodeTypeNormalizer();
   }
 

entity_normalization_normalizers/tests/src/Unit/Normalizer/NullNormalizerTest.php

@@ -21,7 +21,8 @@ class NullNormalizerTest extends UnitTestCase {
   /**
    * {@inheritdoc}
    */
-  protected function setUp() {
+  protected function setUp(): void {
+    parent::setUp();
     $this->normalizer = new NullNormalizer();
   }
 

entity_normalization_normalizers/tests/src/Unit/Normalizer/RichTextNormalizerTest.php

@@ -24,7 +24,8 @@ class RichTextNormalizerTest extends UnitTestCase {
   /**
    * {@inheritdoc}
    */
-  protected function setUp() {
+  protected function setUp(): void {
+    parent::setUp();
     $this->normalizer = new RichTextNormalizer();
   }
 

entity_normalization_normalizers/tests/src/Unit/Normalizer/TermParentIdNormalizerTest.php

@@ -22,7 +22,8 @@ class TermParentIdNormalizerTest extends UnitTestCase {
   /**
    * {@inheritdoc}
    */
-  protected function setUp() {
+  protected function setUp(): void {
+    parent::setUp();
     $this->normalizer = new TermParentIdNormalizer();
   }
 

src/Normalizer/EntityConfigNormalizer.php

@@ -51,7 +51,7 @@ class EntityConfigNormalizer extends NormalizerBase implements NormalizerAwareIn
   /**
    * {@inheritdoc}
    */
-  public function normalize($object, $format = NULL, array $context = []) {
+  public function normalize($object, $format = NULL, array $context = []): array|string|int|float|bool|\ArrayObject|NULL {
     /** @var \Drupal\Core\Entity\FieldableEntityInterface $object */
 
     $config = $this->normalizationManager->getEntityConfig($object, $format);
@@ -105,7 +105,7 @@ class EntityConfigNormalizer extends NormalizerBase implements NormalizerAwareIn
   /**
    * {@inheritdoc}
    */
-  public function supportsNormalization($data, $format = NULL) {
+  public function supportsNormalization($data, ?string $format = null, array $context = []): bool {
     return parent::supportsNormalization($data, $format) && $this->normalizationManager->hasEntityConfig($data, $format);
   }
 

src/Normalizer/FieldItemListNormalizer.php

@@ -45,7 +45,7 @@ class FieldItemListNormalizer extends NormalizerBase implements ContextAwareNorm
   /**
    * {@inheritdoc}
    */
-  public function normalize($object, $format = NULL, array $context = []) {
+  public function normalize($object, $format = NULL, array $context = []): array|string|int|float|bool|\ArrayObject|NULL {
     /** @var \Drupal\Core\Field\FieldItemListInterface $object */
 
     $fieldDefinition = $object->getFieldDefinition();
@@ -116,7 +116,7 @@ class FieldItemListNormalizer extends NormalizerBase implements ContextAwareNorm
   /**
    * {@inheritdoc}
    */
-  public function supportsNormalization($data, $format = NULL, array $context = []) {
+  public function supportsNormalization($data, $format = NULL, array $context = []): bool {
     return isset($context['field_config']) &&
       $context['field_config'] instanceof FieldConfigInterface &&
       parent::supportsNormalization($data, $format);

src/Normalizer/FieldItemNormalizer.php

@@ -25,10 +25,19 @@ class FieldItemNormalizer extends DefaultFieldItemNormalizer implements ContextA
    */
   protected $supportedInterfaceOrClass = FieldItemInterface::class;
 
+  /**
+   * This creates a FieldItemNormalizer object.
+   *
+   * @param \Drupal\Core\File\FileUrlGeneratorInterface $fileUrlGenerator
+   *   The file URL generator.
+   */
+  public function __construct(protected $fileUrlGenerator) {
+  }
+
   /**
    * {@inheritdoc}
    */
-  public function normalize($object, $format = NULL, array $context = []) {
+  public function normalize($object, $format = NULL, array $context = []): array|string|int|float|bool|\ArrayObject|NULL {
     /** @var \Drupal\Core\Field\FieldItemInterface $object */
 
     if ($object instanceof StringItem
@@ -54,7 +63,7 @@ class FieldItemNormalizer extends DefaultFieldItemNormalizer implements ContextA
         'alt' => $object->get('alt')->getValue(),
         'title' => $object->get('title')->getValue(),
         // @todo find a way to speed up the url generation, this takes more than 30% of the time.
-        'url' => file_create_url($object->entity->getFileUri()),
+        'url' => $this->fileUrlGenerator->generateAbsoluteString($object->entity->getFileUri()),
       ];
       return $normalizedValue;
     }
@@ -76,7 +85,7 @@ class FieldItemNormalizer extends DefaultFieldItemNormalizer implements ContextA
   /**
    * {@inheritdoc}
    */
-  public function supportsNormalization($data, $format = NULL, array $context = []) {
+  public function supportsNormalization($data, $format = NULL, array $context = []): bool {
     return isset($context['field_config']) &&
       $context['field_config'] instanceof FieldConfigInterface &&
       parent::supportsNormalization($data, $format);

tests/src/Unit/FieldItemNormalizerTest.php

@@ -20,11 +20,20 @@ class FieldItemNormalizerTest extends UnitTestCase {
    */
   protected $normalizer;
 
+  /**
+   * The fileUrlGenerator service to inject.
+   *
+   * @var \Drupal\Core\File\FileUrlGeneratorInterface
+   */
+  protected $fileUrlGenerator;
+
   /**
    * {@inheritdoc}
    */
-  protected function setUp() {
-    $this->normalizer = new FieldItemNormalizer();
+  protected function setUp(): void {
+    parent::setUp();
+    $this->fileUrlGenerator = $this->getMockBuilder('Drupal\Core\File\FileUrlGenerator')->getMock();
+    $this->normalizer = new FieldItemNormalizer($this->fileUrlGenerator);
   }
 
   /**