PHP 8.1 > internal_method_return_types

https://wiki.php.net/rfc/internal_method_return_types

PHP 8.0 added return type for abstract methods on Iterator, ArrayAccess, Countable, IteratorAggregate
PHP 8.1 made non implementation as a Deprecated Warning
PHP 9.0 (no release date at this moment) will drop the support.

Temporary Fix : adding this Attribute
Will drop the Deprecated warning.

Adding return type will break compatibility before PHP 7.4,
Return type has been added on PHP 7.0, but "mixed" special type is required, and it has been added on PHP 7.4.
In order to be compatible with future PHP 9.0, once it will be release, we will have to drop the support to PHP Version before 7.4

Currently a lot of Unix distribution in LTS are running a PHP Version older than 7.4 so moving to the final solution of "add return type" should break a lot of setup for the moment.

Author: Tybaze

lib/addon/sfPager.class.php

@@ -529,6 +529,7 @@ protected function resetIterator()
    *
    * @see Iterator
    */
+  #[\ReturnTypeWillChange]
   public function current()
   {
     if (!$this->isIteratorInitialized())
@@ -544,6 +545,7 @@ public function current()
    *
    * @see Iterator
    */
+  #[\ReturnTypeWillChange]
   public function key()
   {
     if (!$this->isIteratorInitialized())
@@ -559,6 +561,7 @@ public function key()
    *
    * @see Iterator
    */
+  #[\ReturnTypeWillChange]
   public function next()
   {
     if (!$this->isIteratorInitialized())
@@ -576,6 +579,7 @@ public function next()
    *
    * @see Iterator
    */
+  #[\ReturnTypeWillChange]
   public function rewind()
   {
     if (!$this->isIteratorInitialized())
@@ -593,6 +597,7 @@ public function rewind()
    *
    * @see Iterator
    */
+  #[\ReturnTypeWillChange]
   public function valid()
   {
     if (!$this->isIteratorInitialized())
@@ -608,6 +613,7 @@ public function valid()
    *
    * @see Countable
    */
+  #[\ReturnTypeWillChange]
   public function count()
   {
     return $this->getNbResults();

lib/escaper/sfOutputEscaperArrayDecorator.class.php

@@ -42,6 +42,7 @@ public function __construct($escapingMethod, $value)
   /**
    * Reset the array to the beginning (as required for the Iterator interface).
    */
+  #[\ReturnTypeWillChange]
   public function rewind()
   {
     reset($this->value);
@@ -54,6 +55,7 @@ public function rewind()
    *
    * @return string The key
    */
+  #[\ReturnTypeWillChange]
   public function key()
   {
     return key($this->value);
@@ -67,6 +69,7 @@ public function key()
    *
    * @return mixed The escaped value
    */
+  #[\ReturnTypeWillChange]
   public function current()
   {
     return sfOutputEscaper::escape($this->escapingMethod, current($this->value));
@@ -75,6 +78,7 @@ public function current()
   /**
    * Moves to the next element (as required by the Iterator interface).
    */
+  #[\ReturnTypeWillChange]
   public function next()
   {
     next($this->value);
@@ -91,6 +95,7 @@ public function next()
    *
    * @return bool The validity of the current element; true if it is valid
    */
+  #[\ReturnTypeWillChange]
   public function valid()
   {
     return $this->count > 0;
@@ -103,6 +108,7 @@ public function valid()
    *
    * @return bool true if the offset isset; false otherwise
    */
+  #[\ReturnTypeWillChange]
   public function offsetExists($offset)
   {
     return isset($this->value[$offset]);
@@ -115,6 +121,7 @@ public function offsetExists($offset)
    *
    * @return mixed The escaped value
    */
+  #[\ReturnTypeWillChange]
   public function offsetGet($offset)
   {
     return sfOutputEscaper::escape($this->escapingMethod, $this->value[$offset]);
@@ -132,6 +139,7 @@ public function offsetGet($offset)
    *
    * @throws sfException
    */
+  #[\ReturnTypeWillChange]
   public function offsetSet($offset, $value)
   {
     throw new sfException('Cannot set values.');
@@ -148,6 +156,7 @@ public function offsetSet($offset, $value)
    *
    * @throws sfException
    */
+  #[\ReturnTypeWillChange]
   public function offsetUnset($offset)
   {
     throw new sfException('Cannot unset values.');
@@ -158,6 +167,7 @@ public function offsetUnset($offset)
    *
    * @return int The size of the array
    */
+  #[\ReturnTypeWillChange]
   public function count()
   {
     return count($this->value);

lib/escaper/sfOutputEscaperIteratorDecorator.class.php

@@ -56,6 +56,7 @@ public function __construct($escapingMethod, Traversable $value)
    *
    * @return void
    */
+  #[\ReturnTypeWillChange]
   public function rewind()
   {
     return $this->iterator->rewind();
@@ -66,6 +67,7 @@ public function rewind()
    *
    * @return mixed The escaped value
    */
+  #[\ReturnTypeWillChange]
   public function current()
   {
     return sfOutputEscaper::escape($this->escapingMethod, $this->iterator->current());
@@ -76,6 +78,7 @@ public function current()
    *
    * @return string Iterator key
    */
+  #[\ReturnTypeWillChange]
   public function key()
   {
     return $this->iterator->key();
@@ -86,6 +89,7 @@ public function key()
    *
    * @return void
    */
+  #[\ReturnTypeWillChange]
   public function next()
   {
     return $this->iterator->next();
@@ -97,6 +101,7 @@ public function next()
    *
    * @return bool true if the current element is valid; false otherwise
    */
+  #[\ReturnTypeWillChange]
   public function valid()
   {
     return $this->iterator->valid();
@@ -109,6 +114,7 @@ public function valid()
    *
    * @return bool true if the offset isset; false otherwise
    */
+  #[\ReturnTypeWillChange]
   public function offsetExists($offset)
   {
     return isset($this->value[$offset]);
@@ -121,6 +127,7 @@ public function offsetExists($offset)
    *
    * @return mixed The escaped value
    */
+  #[\ReturnTypeWillChange]
   public function offsetGet($offset)
   {
     return sfOutputEscaper::escape($this->escapingMethod, $this->value[$offset]);
@@ -138,6 +145,7 @@ public function offsetGet($offset)
    *
    * @throws sfException
    */
+  #[\ReturnTypeWillChange]
   public function offsetSet($offset, $value)
   {
     throw new sfException('Cannot set values.');
@@ -154,6 +162,7 @@ public function offsetSet($offset, $value)
    *
    * @throws sfException
    */
+  #[\ReturnTypeWillChange]
   public function offsetUnset($offset)
   {
     throw new sfException('Cannot unset values.');

lib/escaper/sfOutputEscaperObjectDecorator.class.php

@@ -115,6 +115,7 @@ public function __isset($key)
    *
    * @return int The size of the object
    */
+  #[\ReturnTypeWillChange]
   public function count()
   {
     return count($this->value);

lib/event/sfEvent.class.php

@@ -83,7 +83,7 @@ public function getReturnValue()
   /**
    * Sets the processed flag.
    *
-   * @param Boolean $processed The processed flag value
+   * @param boolean $processed The processed flag value
    */
   public function setProcessed($processed)
   {
@@ -117,6 +117,7 @@ public function getParameters()
    *
    * @return Boolean true if the parameter exists, false otherwise
    */
+  #[\ReturnTypeWillChange]
   public function offsetExists($name)
   {
     return array_key_exists($name, $this->parameters);
@@ -129,6 +130,7 @@ public function offsetExists($name)
    *
    * @return mixed  The parameter value
    */
+  #[\ReturnTypeWillChange]
   public function offsetGet($name)
   {
     if (!array_key_exists($name, $this->parameters))
@@ -145,6 +147,7 @@ public function offsetGet($name)
    * @param string  $name   The parameter name
    * @param mixed   $value  The parameter value
    */
+  #[\ReturnTypeWillChange]
   public function offsetSet($name, $value)
   {
     $this->parameters[$name] = $value;
@@ -155,6 +158,7 @@ public function offsetSet($name, $value)
    *
    * @param string $name    The parameter name
    */
+  #[\ReturnTypeWillChange]
   public function offsetUnset($name)
   {
     unset($this->parameters[$name]);

lib/form/sfForm.class.php

@@ -1064,6 +1064,7 @@ public function resetFormFields()
    *
    * @return Boolean true if the widget exists, false otherwise
    */
+  #[\ReturnTypeWillChange]
   public function offsetExists($name)
   {
     return isset($this->widgetSchema[$name]);
@@ -1076,6 +1077,7 @@ public function offsetExists($name)
    *
    * @return sfFormField|sfFormFieldSchema A form field instance
    */
+  #[\ReturnTypeWillChange]
   public function offsetGet($name)
   {
     if (!isset($this->formFields[$name]))
@@ -1114,6 +1116,7 @@ public function offsetGet($name)
    *
    * @throws <b>LogicException</b>
    */
+  #[\ReturnTypeWillChange]
   public function offsetSet($offset, $value)
   {
     throw new LogicException('Cannot update form fields.');
@@ -1126,6 +1129,7 @@ public function offsetSet($offset, $value)
    *
    * @param string $offset The field name
    */
+  #[\ReturnTypeWillChange]
   public function offsetUnset($offset)
   {
     unset(
@@ -1227,6 +1231,7 @@ public function getErrors()
   /**
    * Resets the field names array to the beginning (implements the Iterator interface).
    */
+  #[\ReturnTypeWillChange]
   public function rewind()
   {
     $this->fieldNames = $this->widgetSchema->getPositions();
@@ -1240,6 +1245,7 @@ public function rewind()
    *
    * @return string The key
    */
+  #[\ReturnTypeWillChange]
   public function key()
   {
     return current($this->fieldNames);
@@ -1250,6 +1256,7 @@ public function key()
    *
    * @return mixed The escaped value
    */
+  #[\ReturnTypeWillChange]
   public function current()
   {
     return $this[current($this->fieldNames)];
@@ -1258,6 +1265,7 @@ public function current()
   /**
    * Moves to the next form field (implements the Iterator interface).
    */
+  #[\ReturnTypeWillChange]
   public function next()
   {
     next($this->fieldNames);
@@ -1269,6 +1277,7 @@ public function next()
    *
    * @return boolean The validity of the current element; true if it is valid
    */
+  #[\ReturnTypeWillChange]
   public function valid()
   {
     return $this->count > 0;
@@ -1279,6 +1288,7 @@ public function valid()
    *
    * @return integer The number of embedded form fields
    */
+  #[\ReturnTypeWillChange]
   public function count()
   {
     return count($this->getFormFieldSchema());