Add PHPDoc return types

.php-cs-fixer.php

@@ -56,6 +56,10 @@
     // but we can feel free to remove it in a major version (or maybe in a minor if
     // we devote some effort into determining that it is safe)
     'no_null_property_initialization' => false,
+
+    // We have to support `@return void` to satisfy Symfony deprecations helper.
+    // See https://github.com/stripe/stripe-php/pull/1230
+    'phpdoc_no_empty_return' => false,
 ]);
 $config->setFinder($finder);
 return $config;

lib/StripeObject.php

@@ -218,7 +218,9 @@ public function offsetGet($k)
         return \array_key_exists($k, $this->_values) ? $this->_values[$k] : null;
     }
 
-    // Countable method
+    /**
+     * @return int
+     */
     #[\ReturnTypeWillChange]
     public function count()
     {
@@ -424,6 +426,9 @@ public function serializeParamsValue($value, $original, $unsaved, $force, $key =
         }
     }
 
+    /**
+     * @return mixed
+     */
     #[\ReturnTypeWillChange]
     public function jsonSerialize()
     {

lib/Util/CaseInsensitiveArray.php

@@ -27,12 +27,18 @@ public function count()
         return \count($this->container);
     }
 
+    /**
+     * @return \ArrayIterator
+     */
     #[\ReturnTypeWillChange]
     public function getIterator()
     {
         return new \ArrayIterator($this->container);
     }
 
+    /**
+     * @return void
+     */
     #[\ReturnTypeWillChange]
     public function offsetSet($offset, $value)
     {
@@ -44,6 +50,9 @@ public function offsetSet($offset, $value)
         }
     }
 
+    /**
+     * @return bool
+     */
     #[\ReturnTypeWillChange]
     public function offsetExists($offset)
     {
@@ -52,13 +61,19 @@ public function offsetExists($offset)
         return isset($this->container[$offset]);
     }
 
+    /**
+     * @return void
+     */
     #[\ReturnTypeWillChange]
     public function offsetUnset($offset)
     {
         $offset = static::maybeLowercase($offset);
         unset($this->container[$offset]);
     }
 
+    /**
+     * @return mixed
+     */
     #[\ReturnTypeWillChange]
     public function offsetGet($offset)
     {

lib/Util/Set.php

@@ -37,6 +37,9 @@ public function toArray()
         return \array_keys($this->_elts);
     }
 
+    /**
+     * @return ArrayIterator
+     */
     #[\ReturnTypeWillChange]
     public function getIterator()
     {