Phpstan Differences from Php7 to Php8, Again (#2665)

These changes have already been implemented twice, and been regressed twice. I'll try once more (with a different approach), then give up ...

As configured, Phpstan running under Php7 reports no errors. However, running under Php8, it reports 100 (!) errors. The vast majority of these are due to two reasons:
- renaming parameters in Php builtin functions in preparation for named parameters.
- using the new class GdImage rather than type resource as the argument type for many image-based functions.

Regardless of the cause, this will be a problem sooner or later. This PR is an attempt to get ahead of that problem. For source members, it mostly adds annotations or updates doc-blocks. Only 2 members have changes to executable code, and these are very minor - BitWise and Writer/Xlsx. For test members, all baseline errors are deleted and the code is fixed. Php7 and Php8 both report no errors with this configuration.

Author: oleibman

phpstan-baseline.neon

@@ -3226,6 +3226,7 @@ public function _translateFormulaToEnglish($formula)
         if (self::$functionReplaceToExcel === null) {
             self::$functionReplaceToExcel = [];
             foreach (array_keys(self::$localeFunctions) as $excelFunctionName) {
+                // @phpstan-ignore-next-line
                 self::$functionReplaceToExcel[] = '$1' . trim($excelFunctionName) . '$2';
             }
             foreach (array_keys(self::$localeBoolean) as $excelBoolean) {
@@ -4490,6 +4491,7 @@ private function processTokenStack($tokens, $cellID = null, ?Cell $cell = null)
                             if ($operand1Data['reference'] === null) {
                                 if ((trim($operand1Data['value']) != '') && (is_numeric($operand1Data['value']))) {
                                     $operand1Data['reference'] = $cell->getColumn() . $operand1Data['value'];
+                                // @phpstan-ignore-next-line
                                 } elseif (trim($operand1Data['reference']) == '') {
                                     $operand1Data['reference'] = $cell->getCoordinate();
                                 } else {
@@ -4499,6 +4501,7 @@ private function processTokenStack($tokens, $cellID = null, ?Cell $cell = null)
                             if ($operand2Data['reference'] === null) {
                                 if ((trim($operand2Data['value']) != '') && (is_numeric($operand2Data['value']))) {
                                     $operand2Data['reference'] = $cell->getColumn() . $operand2Data['value'];
+                                // @phpstan-ignore-next-line
                                 } elseif (trim($operand2Data['reference']) == '') {
                                     $operand2Data['reference'] = $cell->getCoordinate();
                                 } else {

src/PhpSpreadsheet/Calculation/Calculation.php

@@ -211,13 +211,14 @@ public static function BITRSHIFT($number, $shiftAmount)
      *
      * @param mixed $value
      *
-     * @return float|int
+     * @return float
      */
     private static function validateBitwiseArgument($value)
     {
         $value = self::nullFalseTrueToNumber($value);
 
         if (is_numeric($value)) {
+            $value = (float) $value;
             if ($value == floor($value)) {
                 if (($value > 2 ** 48 - 1) || ($value < 0)) {
                     throw new Exception(ExcelError::NAN());

src/PhpSpreadsheet/Calculation/Engineering/BitWise.php

@@ -166,6 +166,7 @@ public static function ROW($cellAddress = null, ?Cell $cell = null)
                 function ($value) {
                     return [$value];
                 },
+                // @phpstan-ignore-next-line
                 range($startAddress, $endAddress)
             );
         }

src/PhpSpreadsheet/Calculation/LookupRef/RowColumnInformation.php

@@ -148,6 +148,7 @@ public static function splitRange($range)
         $exploded = explode(',', $range);
         $counter = count($exploded);
         for ($i = 0; $i < $counter; ++$i) {
+            // @phpstan-ignore-next-line
             $exploded[$i] = explode(':', $exploded[$i]);
         }
 
@@ -544,7 +545,7 @@ private static function getCellBlocksFromRangeString($rangeString)
 
         // split range sets on intersection (space) or union (,) operators
         $tokens = preg_split('/([ ,])/', $rangeString, -1, PREG_SPLIT_DELIM_CAPTURE);
-        // separate the range sets and the operators into arrays
+        /** @phpstan-ignore-next-line */
         $split = array_chunk($tokens, 2);
         $ranges = array_column($split, 0);
         $operators = array_column($split, 1);

src/PhpSpreadsheet/Cell/Coordinate.php

@@ -808,6 +808,7 @@ protected function handleCallback(DOMElement $element, $callbackTag, array $call
         if (isset($callbacks[$callbackTag])) {
             $elementHandler = $callbacks[$callbackTag];
             if (method_exists($this, $elementHandler)) {
+                // @phpstan-ignore-next-line
                 call_user_func([$this, $elementHandler], $element);
             }
         }

src/PhpSpreadsheet/Helper/Html.php

@@ -71,6 +71,7 @@ public function getContext()
      */
     public function add(string $data): void
     {
+        /** @phpstan-ignore-next-line */
         $words = array_values(unpack('V16', $data));
 
         $A = $this->a;

src/PhpSpreadsheet/Reader/Xls/MD5.php

@@ -164,11 +164,15 @@ public static function imagecreatefrombmp($bmpFilename)
     {
         //    Load the image into a string
         $file = fopen($bmpFilename, 'rb');
+        /** @phpstan-ignore-next-line */
         $read = fread($file, 10);
+        // @phpstan-ignore-next-line
         while (!feof($file) && ($read != '')) {
+            // @phpstan-ignore-next-line
             $read .= fread($file, 1024);
         }
 
+        /** @phpstan-ignore-next-line */
         $temp = unpack('H*', $read);
         $hex = $temp[1];
         $header = substr($hex, 0, 108);
@@ -196,6 +200,8 @@ public static function imagecreatefrombmp($bmpFilename)
         $y = 1;
 
         //    Create newimage
+
+        /** @phpstan-ignore-next-line */
         $image = imagecreatetruecolor($width, $height);
 
         //    Grab the body from the image
@@ -241,7 +247,10 @@ public static function imagecreatefrombmp($bmpFilename)
             $b = hexdec($body[$i_pos] . $body[$i_pos + 1]);
 
             // Calculate and draw the pixel
+
+            /** @phpstan-ignore-next-line */
             $color = imagecolorallocate($image, $r, $g, $b);
+            // @phpstan-ignore-next-line
             imagesetpixel($image, $x, $height - $y, $color);
 
             // Raise the horizontal position
@@ -252,6 +261,7 @@ public static function imagecreatefrombmp($bmpFilename)
         unset($body);
 
         //    Return image-object
+        // @phpstan-ignore-next-line
         return $image;
     }
 }

src/PhpSpreadsheet/Shared/Drawing.php

@@ -1134,6 +1134,7 @@ public function concat(...$args)
             $this->checkMatrixDimensions($M);
             for ($i = 0; $i < $this->m; ++$i) {
                 for ($j = 0; $j < $this->n; ++$j) {
+                    // @phpstan-ignore-next-line
                     $this->A[$i][$j] = trim($this->A[$i][$j], '"') . trim($M->get($i, $j), '"');
                 }
             }

src/PhpSpreadsheet/Shared/JAMA/Matrix.php

@@ -251,6 +251,7 @@ public function getStream($blockIdOrPps)
      */
     private static function readInt1($fileHandle)
     {
+        // @phpstan-ignore-next-line
         [, $tmp] = unpack('c', fread($fileHandle, 1));
 
         return $tmp;
@@ -265,6 +266,7 @@ private static function readInt1($fileHandle)
      */
     private static function readInt2($fileHandle)
     {
+        // @phpstan-ignore-next-line
         [, $tmp] = unpack('v', fread($fileHandle, 2));
 
         return $tmp;
@@ -279,6 +281,7 @@ private static function readInt2($fileHandle)
      */
     private static function readInt4($fileHandle)
     {
+        // @phpstan-ignore-next-line
         [, $tmp] = unpack('V', fread($fileHandle, 4));
 
         return $tmp;