chore: add explicit return types to address Symfony deprecations (#2200)

Robert Currall · web-flow · commit c15fb919429e · 2022-02-07T06:06:50.000-08:00
diff --git a/src/Collection.php b/src/Collection.php
@@ -11,6 +11,7 @@ class Collection extends Model implements \Iterator, \Countable
 {
   protected $collection_key = 'items';
 
+  /** @return void */
   #[\ReturnTypeWillChange]
   public function rewind()
   {
@@ -20,6 +21,7 @@ public function rewind()
     }
   }
 
+  /** @return mixed */
   #[\ReturnTypeWillChange]
   public function current()
   {
@@ -29,6 +31,7 @@ public function current()
     }
   }
 
+  /** @return mixed */
   #[\ReturnTypeWillChange]
   public function key()
   {
@@ -38,19 +41,22 @@ public function key()
     }
   }
 
+  /** @return void */
   #[\ReturnTypeWillChange]
   public function next()
   {
     return next($this->{$this->collection_key});
   }
 
+  /** @return bool */
   #[\ReturnTypeWillChange]
   public function valid()
   {
     $key = $this->key();
     return $key !== null && $key !== false;
   }
 
+  /** @return int */
   #[\ReturnTypeWillChange]
   public function count()
   {
@@ -60,6 +66,7 @@ public function count()
     return count($this->{$this->collection_key});
   }
 
+  /** @return bool */
   public function offsetExists($offset)
   {
     if (!is_numeric($offset)) {
@@ -68,6 +75,7 @@ public function offsetExists($offset)
     return isset($this->{$this->collection_key}[$offset]);
   }
 
+  /** @return mixed */
   public function offsetGet($offset)
   {
     if (!is_numeric($offset)) {
@@ -77,6 +85,7 @@ public function offsetGet($offset)
     return $this->{$this->collection_key}[$offset];
   }
 
+  /** @return void */
   public function offsetSet($offset, $value)
   {
     if (!is_numeric($offset)) {
@@ -85,6 +94,7 @@ public function offsetSet($offset, $value)
     $this->{$this->collection_key}[$offset] = $value;
   }
 
+  /** @return void */
   public function offsetUnset($offset)
   {
     if (!is_numeric($offset)) {
diff --git a/src/Model.php b/src/Model.php
@@ -253,12 +253,14 @@ public function assertIsArray($obj, $method)
     }
   }
 
+  /** @return bool */
   #[\ReturnTypeWillChange]
   public function offsetExists($offset)
   {
     return isset($this->$offset) || isset($this->modelData[$offset]);
   }
 
+  /** @return mixed */
   #[\ReturnTypeWillChange]
   public function offsetGet($offset)
   {
@@ -267,6 +269,7 @@ public function offsetGet($offset)
         $this->__get($offset);
   }
 
+  /** @return void */
   #[\ReturnTypeWillChange]
   public function offsetSet($offset, $value)
   {
@@ -278,6 +281,7 @@ public function offsetSet($offset, $value)
     }
   }
 
+  /** @return void */
   #[\ReturnTypeWillChange]
   public function offsetUnset($offset)
   {

Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,7 @@ class Collection extends Model implements \Iterator, \Countable`
`11`	`11`	`{`
`12`	`12`	`protected $collection_key = 'items';`
`13`	`13`
	`14`	`+ /** @return void */`
`14`	`15`	`#[\ReturnTypeWillChange]`
`15`	`16`	`public function rewind()`
`16`	`17`	`{`
`@@ -20,6 +21,7 @@ public function rewind()`
`20`	`21`	`}`
`21`	`22`	`}`
`22`	`23`
	`24`	`+ /** @return mixed */`
`23`	`25`	`#[\ReturnTypeWillChange]`
`24`	`26`	`public function current()`
`25`	`27`	`{`
`@@ -29,6 +31,7 @@ public function current()`
`29`	`31`	`}`
`30`	`32`	`}`
`31`	`33`
	`34`	`+ /** @return mixed */`
`32`	`35`	`#[\ReturnTypeWillChange]`
`33`	`36`	`public function key()`
`34`	`37`	`{`
`@@ -38,19 +41,22 @@ public function key()`
`38`	`41`	`}`
`39`	`42`	`}`
`40`	`43`
	`44`	`+ /** @return void */`
`41`	`45`	`#[\ReturnTypeWillChange]`
`42`	`46`	`public function next()`
`43`	`47`	`{`
`44`	`48`	`return next($this->{$this->collection_key});`
`45`	`49`	`}`
`46`	`50`
	`51`	`+ /** @return bool */`
`47`	`52`	`#[\ReturnTypeWillChange]`
`48`	`53`	`public function valid()`
`49`	`54`	`{`
`50`	`55`	`$key = $this->key();`
`51`	`56`	`return $key !== null && $key !== false;`
`52`	`57`	`}`
`53`	`58`
	`59`	`+ /** @return int */`
`54`	`60`	`#[\ReturnTypeWillChange]`
`55`	`61`	`public function count()`
`56`	`62`	`{`
`@@ -60,6 +66,7 @@ public function count()`
`60`	`66`	`return count($this->{$this->collection_key});`
`61`	`67`	`}`
`62`	`68`
	`69`	`+ /** @return bool */`
`63`	`70`	`public function offsetExists($offset)`
`64`	`71`	`{`
`65`	`72`	`if (!is_numeric($offset)) {`
`@@ -68,6 +75,7 @@ public function offsetExists($offset)`
`68`	`75`	`return isset($this->{$this->collection_key}[$offset]);`
`69`	`76`	`}`
`70`	`77`
	`78`	`+ /** @return mixed */`
`71`	`79`	`public function offsetGet($offset)`
`72`	`80`	`{`
`73`	`81`	`if (!is_numeric($offset)) {`
`@@ -77,6 +85,7 @@ public function offsetGet($offset)`
`77`	`85`	`return $this->{$this->collection_key}[$offset];`
`78`	`86`	`}`
`79`	`87`
	`88`	`+ /** @return void */`
`80`	`89`	`public function offsetSet($offset, $value)`
`81`	`90`	`{`
`82`	`91`	`if (!is_numeric($offset)) {`
`@@ -85,6 +94,7 @@ public function offsetSet($offset, $value)`
`85`	`94`	`$this->{$this->collection_key}[$offset] = $value;`
`86`	`95`	`}`
`87`	`96`
	`97`	`+ /** @return void */`
`88`	`98`	`public function offsetUnset($offset)`
`89`	`99`	`{`
`90`	`100`	`if (!is_numeric($offset)) {`
Original file line number	Diff line number	Diff line change
`@@ -253,12 +253,14 @@ public function assertIsArray($obj, $method)`
`253`	`253`	`}`
`254`	`254`	`}`
`255`	`255`
	`256`	`+ /** @return bool */`
`256`	`257`	`#[\ReturnTypeWillChange]`
`257`	`258`	`public function offsetExists($offset)`
`258`	`259`	`{`
`259`	`260`	`return isset($this->$offset) \|\| isset($this->modelData[$offset]);`
`260`	`261`	`}`
`261`	`262`
	`263`	`+ /** @return mixed */`
`262`	`264`	`#[\ReturnTypeWillChange]`
`263`	`265`	`public function offsetGet($offset)`
`264`	`266`	`{`
`@@ -267,6 +269,7 @@ public function offsetGet($offset)`
`267`	`269`	`$this->__get($offset);`
`268`	`270`	`}`
`269`	`271`
	`272`	`+ /** @return void */`
`270`	`273`	`#[\ReturnTypeWillChange]`
`271`	`274`	`public function offsetSet($offset, $value)`
`272`	`275`	`{`
`@@ -278,6 +281,7 @@ public function offsetSet($offset, $value)`
`278`	`281`	`}`
`279`	`282`	`}`
`280`	`283`
	`284`	`+ /** @return void */`
`281`	`285`	`#[\ReturnTypeWillChange]`
`282`	`286`	`public function offsetUnset($offset)`
`283`	`287`	`{`