Issue #3232074 by bbrala, daffie, effulgentsia, catch, gabesullice, alexpott:...

Issue #3232074 by bbrala, daffie, effulgentsia, catch, gabesullice, alexpott: [Symfony 6] Add "array|string|int|float|bool|\ArrayObject|null" to all Normalizer classes that implement the method ::normalize()

core/modules/jsonapi/src/Normalizer/Value/CacheableNormalization.php

@@ -16,7 +16,7 @@
  * @see https://www.drupal.org/project/drupal/issues/3032787
  * @see jsonapi.api.php
  */
-class CacheableNormalization implements CacheableDependencyInterface {
+class CacheableNormalization extends TemporaryArrayObjectThrowingExceptions implements CacheableDependencyInterface {
 
   use CacheableDependencyTrait;
 

core/modules/jsonapi/src/Normalizer/Value/TemporaryArrayObjectThrowingExceptions.php

+<?php
+
+namespace Drupal\jsonapi\Normalizer\Value;
+
+/**
+ * An \ArrayObject that throws an exception when used as an ArrayObject.
+ *
+ * @internal This class implements all methods for class \ArrayObject and throws
+ *   an \Exception when one of those methods is called.
+ */
+class TemporaryArrayObjectThrowingExceptions extends \ArrayObject {
+
+  /**
+   * Append a value to the ArrayObject.
+   *
+   * @param mixed $value
+   *   The value to append to the ArrayObject.
+   *
+   * @throws \Exception
+   *   This class does not support this action but it must implement it, because
+   *   it is extending \ArrayObject.
+   */
+  public function append($value): void {
+    throw new \Exception('This ' . __CLASS__ . ' does not support this action but it must implement it, because it is extending \ArrayObject.');
+  }
+
+  /**
+   * Sort the ArrayObject.
+   *
+   * @param int $flags
+   *   The flags to sort the ArrayObject by.
+   *
+   * @return bool
+   *   This method always returns TRUE.
+   *
+   * @throws \Exception
+   *   This class does not support this action but it must implement it, because
+   *   it is extending \ArrayObject.
+   */
+  public function asort($flags = SORT_REGULAR): bool {
+    throw new \Exception('This ' . __CLASS__ . ' does not support this action but it must implement it, because it is extending \ArrayObject.');
+  }
+
+  /**
+   * Count the ArrayObject.
+   *
+   * @return int
+   *   The number of public properties in the \ArrayObject.
+   *
+   * @throws \Exception
+   *   This class does not support this action but it must implement it, because
+   *   it is extending \ArrayObject.
+   */
+  public function count(): int {
+    throw new \Exception('This ' . __CLASS__ . ' does not support this action but it must implement it, because it is extending \ArrayObject.');
+  }
+
+  /**
+   * Exchange the current array with another array or object.
+   *
+   * @param array|object $array
+   *   The array to replace for the current array.
+   *
+   * @return array
+   *   The new array or object to exchange with the current array.
+   *
+   * @throws \Exception
+   *   This class does not support this action but it must implement it, because
+   *   it is extending \ArrayObject.
+   */
+  public function exchangeArray($array): array {
+    throw new \Exception('This ' . __CLASS__ . ' does not support this action but it must implement it, because it is extending \ArrayObject.');
+  }
+
+  /**
+   * Exports the \ArrayObject to an array.
+   *
+   * @return array
+   *   Returns a copy of the array.
+   *
+   * @throws \Exception
+   *   This class does not support this action but it must implement it, because
+   *   it is extending \ArrayObject.
+   */
+  public function getArrayCopy(): array {
+    throw new \Exception('This ' . __CLASS__ . ' does not support this action but it must implement it, because it is extending \ArrayObject.');
+  }
+
+  /**
+   * Gets the behavior flags of the \ArrayObject.
+   *
+   * @return int
+   *   Returns the behavior flags of the \ArrayObject.
+   *
+   * @throws \Exception
+   *   This class does not support this action but it must implement it, because
+   *   it is extending \ArrayObject.
+   */
+  public function getFlags(): int {
+    throw new \Exception('This ' . __CLASS__ . ' does not support this action but it must implement it, because it is extending \ArrayObject.');
+  }
+
+  /**
+   * Create a new iterator from an ArrayObject instance.
+   *
+   * @return \Iterator
+   *   An iterator from the ArrayObject.
+   *
+   * @throws \Exception
+   *   This class does not support this action but it must implement it, because
+   *   it is extending \ArrayObject.
+   */
+  public function getIterator(): \Iterator {
+    throw new \Exception('This ' . __CLASS__ . ' does not support this action but it must implement it, because it is extending \ArrayObject.');
+  }
+
+  /**
+   * Gets the class name of the array iterator that is used by \ArrayObject::getIterator().
+   *
+   * @return string
+   *   Returns the iterator class name that is used to iterate over this object.
+   *
+   * @throws \Exception
+   *   This class does not support this action but it must implement it, because
+   *   it is extending \ArrayObject.
+   */
+  public function getIteratorClass(): string {
+    throw new \Exception('This ' . __CLASS__ . ' does not support this action but it must implement it, because it is extending \ArrayObject.');
+  }
+
+  /**
+   * Sort the entries by key.
+   *
+   * @param int $flags
+   *   The flags to sort the ArrayObject by.
+   *
+   * @return bool
+   *   This method always returns TRUE.
+   *
+   * @throws \Exception
+   *   This class does not support this action but it must implement it, because
+   *   it is extending \ArrayObject.
+   */
+  public function ksort($flags = SORT_REGULAR): bool {
+    throw new \Exception('This ' . __CLASS__ . ' does not support this action but it must implement it, because it is extending \ArrayObject.');
+  }
+
+  /**
+   * Sort an array using a case insensitive "natural order" algorithm.
+   *
+   * @return bool
+   *   This method always returns TRUE.
+   *
+   * @throws \Exception
+   *   This class does not support this action but it must implement it, because
+   *   it is extending \ArrayObject.
+   */
+  public function natcasesort(): bool {
+    throw new \Exception('This ' . __CLASS__ . ' does not support this action but it must implement it, because it is extending \ArrayObject.');
+  }
+
+  /**
+   * Sort entries using a "natural order" algorithm.
+   *
+   * @return bool
+   *   This method always returns TRUE.
+   *
+   * @throws \Exception
+   *   This class does not support this action but it must implement it, because
+   *   it is extending \ArrayObject.
+   */
+  public function natsort(): bool {
+    throw new \Exception('This ' . __CLASS__ . ' does not support this action but it must implement it, because it is extending \ArrayObject.');
+  }
+
+  /**
+   * Returns whether the requested index exists.
+   *
+   * @param mixed $key
+   *   The index being checked.
+   *
+   * @return bool
+   *   Return TRUE if the requested index exists, otherwise FALSE.
+   *
+   * @throws \Exception
+   *   This class does not support this action but it must implement it, because
+   *   it is extending \ArrayObject.
+   */
+  public function offsetExists($key): bool {
+    throw new \Exception('This ' . __CLASS__ . ' does not support this action but it must implement it, because it is extending \ArrayObject.');
+  }
+
+  /**
+   * Returns the value at the specified index.
+   *
+   * @param mixed $key
+   *   The index with the value.
+   *
+   * @return mixed
+   *   The value at the specified index or null.
+   *
+   * @throws \Exception
+   *   This class does not support this action but it must implement it, because
+   *   it is extending \ArrayObject.
+   */
+  #[\ReturnTypeWillChange]
+  public function offsetGet($key) {
+    throw new \Exception('This ' . __CLASS__ . ' does not support this action but it must implement it, because it is extending \ArrayObject.');
+  }
+
+  /**
+   * Sets the value at the specified index to new value.
+   *
+   * @param mixed $key
+   *   The index being set.
+   * @param mixed $value
+   *   The new value for the key.
+   *
+   * @throws \Exception
+   *   This class does not support this action but it must implement it, because
+   *   it is extending \ArrayObject.
+   */
+  public function offsetSet($key, $value): void {
+    throw new \Exception('This ' . __CLASS__ . ' does not support this action but it must implement it, because it is extending \ArrayObject.');
+  }
+
+  /**
+   * Unsets the value at the specified index.
+   *
+   * @param mixed $key
+   *   The index being unset.
+   *
+   * @throws \Exception
+   *   This class does not support this action but it must implement it, because
+   *   it is extending \ArrayObject.
+   */
+  public function offsetUnset($key): void {
+    throw new \Exception('This ' . __CLASS__ . ' does not support this action but it must implement it, because it is extending \ArrayObject.');
+  }
+
+  /**
+   * Serialize the \ArrayObject.
+   *
+   * @throws \Exception
+   *   This class does not support this action but it must implement it, because
+   *   it is extending \ArrayObject.
+   */
+  public function serialize(): string {
+    throw new \Exception('This ' . __CLASS__ . ' does not support this action but it must implement it, because it is extending \ArrayObject.');
+  }
+
+  /**
+   * Sets the behavior flags for the \ArrayObject.
+   *
+   * @param int $flags
+   *   Set the flags that change the behavior of the \ArrayObject.
+   *
+   * @throws \Exception
+   *   This class does not support this action but it must implement it, because
+   *   it is extending \ArrayObject.
+   */
+  public function setFlags($flags): void {
+    throw new \Exception('This ' . __CLASS__ . ' does not support this action but it must implement it, because it is extending \ArrayObject.');
+  }
+
+  /**
+   * Sets the iterator classname for the \ArrayObject.
+   *
+   * @param string $iteratorClass
+   *   The classname of the array iterator to use when iterating over this
+   *   object.
+   *
+   * @throws \Exception
+   *   This class does not support this action but it must implement it, because
+   *   it is extending \ArrayObject.
+   */
+  public function setIteratorClass($iteratorClass): void {
+    throw new \Exception('This ' . __CLASS__ . ' does not support this action but it must implement it, because it is extending \ArrayObject.');
+  }
+
+  /**
+   * Sort the entries with a user-defined comparison function.
+   *
+   * @param callable $callback
+   *   The comparison function must return an integer less than, equal to, or
+   *   greater than zero if the first argument is considered to be respectively
+   *   less than, equal to, or greater than the second.
+   *
+   * @return bool
+   *   This method always returns TRUE.
+   *
+   * @throws \Exception
+   *   This class does not support this action but it must implement it, because
+   *   it is extending \ArrayObject.
+   */
+  public function uasort($callback): bool {
+    throw new \Exception('This ' . __CLASS__ . ' does not support this action but it must implement it, because it is extending \ArrayObject.');
+  }
+
+  /**
+   * Sort the entries by keys using a user-defined comparison function.
+   *
+   * @param callable $callback
+   *   The comparison function must return an integer less than, equal to, or
+   *   greater than zero if the first argument is considered to be respectively
+   *   less than, equal to, or greater than the second.
+   *
+   * @return bool
+   *   This method always returns TRUE.
+   *
+   * @throws \Exception
+   *   This class does not support this action but it must implement it, because
+   *   it is extending \ArrayObject.
+   */
+  public function uksort($callback): bool {
+    throw new \Exception('This ' . __CLASS__ . ' does not support this action but it must implement it, because it is extending \ArrayObject.');
+  }
+
+  /**
+   * Unserialize the \ArrayObject.
+   *
+   * @throws \Exception
+   *   This class does not support this action but it must implement it, because
+   *   it is extending \ArrayObject.
+   */
+  public function unserialize($data): void {
+    throw new \Exception('This ' . __CLASS__ . ' does not support this action but it must implement it, because it is extending \ArrayObject.');
+  }
+
+}