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.
PHPOffice · Mar 12, 2022 · 68158c8 · 68158c8
1 parent c0ea894
commit 68158c8
Show file tree

Hide file tree

Showing 46 changed files with 199 additions and 544 deletions.
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
diff --git a/src/PhpSpreadsheet/Calculation/Calculation.php b/src/PhpSpreadsheet/Calculation/Calculation.php
@@ -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 {

diff --git a/src/PhpSpreadsheet/Calculation/Engineering/BitWise.php b/src/PhpSpreadsheet/Calculation/Engineering/BitWise.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());

diff --git a/src/PhpSpreadsheet/Calculation/LookupRef/RowColumnInformation.php b/src/PhpSpreadsheet/Calculation/LookupRef/RowColumnInformation.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)
             );
         }

diff --git a/src/PhpSpreadsheet/Cell/Coordinate.php b/src/PhpSpreadsheet/Cell/Coordinate.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);

diff --git a/src/PhpSpreadsheet/Helper/Html.php b/src/PhpSpreadsheet/Helper/Html.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);
             }
         }

diff --git a/src/PhpSpreadsheet/Reader/Xls/MD5.php b/src/PhpSpreadsheet/Reader/Xls/MD5.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;

diff --git a/src/PhpSpreadsheet/Shared/Drawing.php b/src/PhpSpreadsheet/Shared/Drawing.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;
     }
 }
diff --git a/src/PhpSpreadsheet/Shared/JAMA/Matrix.php b/src/PhpSpreadsheet/Shared/JAMA/Matrix.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), '"');
                 }
             }

diff --git a/src/PhpSpreadsheet/Shared/OLE.php b/src/PhpSpreadsheet/Shared/OLE.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;

diff --git a/src/PhpSpreadsheet/Shared/OLE/ChainedBlockStream.php b/src/PhpSpreadsheet/Shared/OLE/ChainedBlockStream.php
@@ -160,6 +160,7 @@ public function stream_seek($offset, $whence) // @codingStandardsIgnoreLine
             $this->pos = $offset;
         } elseif ($whence == SEEK_CUR && -$offset <= $this->pos) {
             $this->pos += $offset;
+        // @phpstan-ignore-next-line
         } elseif ($whence == SEEK_END && -$offset <= count($this->data)) {
             $this->pos = strlen($this->data) + $offset;
         } else {

diff --git a/src/PhpSpreadsheet/Shared/Trend/PolynomialBestFit.php b/src/PhpSpreadsheet/Shared/Trend/PolynomialBestFit.php
@@ -114,6 +114,7 @@ public function getSlope($dp = 0)
 
     public function getCoefficients($dp = 0)
     {
+        // @phpstan-ignore-next-line
         return array_merge([$this->getIntersect($dp)], $this->getSlope($dp));
     }
 

diff --git a/src/PhpSpreadsheet/Style/NumberFormat/DateFormatter.php b/src/PhpSpreadsheet/Style/NumberFormat/DateFormatter.php
@@ -85,6 +85,8 @@ public static function format($value, string $format): string
         $format = preg_replace_callback('/(?:^|")([^"]*)(?:$|")/', $callable, $format);
 
         // Only process the non-quoted blocks for date format characters
+
+        /** @phpstan-ignore-next-line */
         $blocks = explode('"', $format);
         foreach ($blocks as $key => &$block) {
             if ($key % 2 == 0) {

diff --git a/src/PhpSpreadsheet/Worksheet/AutoFilter/Column.php b/src/PhpSpreadsheet/Worksheet/AutoFilter/Column.php
@@ -243,7 +243,7 @@ public function setAttributes($attributes)
      * Set An AutoFilter Attribute.
      *
      * @param string $name Attribute Name
-     * @param string $value Attribute Value
+     * @param int|string $value Attribute Value
      *
      * @return $this
      */

diff --git a/src/PhpSpreadsheet/Worksheet/PageSetup.php b/src/PhpSpreadsheet/Worksheet/PageSetup.php
@@ -640,6 +640,7 @@ public function getPrintArea($index = 0)
         if ($index == 0) {
             return $this->printArea;
         }
+        /** @phpstan-ignore-next-line */
         $printAreas = explode(',', $this->printArea);
         if (isset($printAreas[$index - 1])) {
             return $printAreas[$index - 1];
@@ -663,6 +664,7 @@ public function isPrintAreaSet($index = 0)
         if ($index == 0) {
             return $this->printArea !== null;
         }
+        /** @phpstan-ignore-next-line */
         $printAreas = explode(',', $this->printArea);
 
         return isset($printAreas[$index - 1]);
@@ -683,6 +685,7 @@ public function clearPrintArea($index = 0)
         if ($index == 0) {
             $this->printArea = null;
         } else {
+            /** @phpstan-ignore-next-line */
             $printAreas = explode(',', $this->printArea);
             if (isset($printAreas[$index - 1])) {
                 unset($printAreas[$index - 1]);
@@ -731,6 +734,7 @@ public function setPrintArea($value, $index = 0, $method = self::SETPRINTRANGE_O
             if ($index == 0) {
                 $this->printArea = $value;
             } else {
+                /** @phpstan-ignore-next-line */
                 $printAreas = explode(',', $this->printArea);
                 if ($index < 0) {
                     $index = count($printAreas) - abs($index) + 1;
@@ -745,6 +749,7 @@ public function setPrintArea($value, $index = 0, $method = self::SETPRINTRANGE_O
             if ($index == 0) {
                 $this->printArea = $this->printArea ? ($this->printArea . ',' . $value) : $value;
             } else {
+                /** @phpstan-ignore-next-line */
                 $printAreas = explode(',', $this->printArea);
                 if ($index < 0) {
                     $index = abs($index) - 1;

diff --git a/src/PhpSpreadsheet/Worksheet/Worksheet.php b/src/PhpSpreadsheet/Worksheet/Worksheet.php
@@ -567,6 +567,7 @@ public function addChart(Chart $chart, $chartIndex = null)
             $this->chartCollection[] = $chart;
         } else {
             // Insert the chart at the requested index
+            // @phpstan-ignore-next-line
             array_splice($this->chartCollection, $chartIndex, 0, [$chart]);
         }
 
@@ -1224,6 +1225,7 @@ private function getWorksheetAndCoordinate(string $coordinate): array
                     throw new Exception('Sheet not found for named range: ' . $namedRange->getName());
                 }
 
+                /** @phpstan-ignore-next-line */
                 $cellCoordinate = ltrim(substr($namedRange->getValue(), strrpos($namedRange->getValue(), '!')), '!');
                 $finalCoordinate = str_replace('$', '', $cellCoordinate);
             }
@@ -2767,6 +2769,7 @@ public function namedRangeToArray(string $definedName, $nullValue = null, $calcu
     {
         $namedRange = $this->validateNamedRange($definedName);
         $workSheet = $namedRange->getWorksheet();
+        /** @phpstan-ignore-next-line */
         $cellRange = ltrim(substr($namedRange->getValue(), strrpos($namedRange->getValue(), '!')), '!');
         $cellRange = str_replace('$', '', $cellRange);
 

diff --git a/src/PhpSpreadsheet/Writer/Html.php b/src/PhpSpreadsheet/Writer/Html.php
@@ -697,10 +697,12 @@ private function writeImageInCell(Worksheet $worksheet, $coordinates)
                 $imageResource = $drawing->getImageResource();
                 if ($imageResource) {
                     ob_start(); //  Let's start output buffering.
+                    // @phpstan-ignore-next-line
                     imagepng($imageResource); //  This will normally output the image, but because of ob_start(), it won't.
                     $contents = ob_get_contents(); //  Instead, output above is saved to $contents
                     ob_end_clean(); //  End the output buffer.
 
+                    /** @phpstan-ignore-next-line */
                     $dataUri = 'data:image/jpeg;base64,' . base64_encode($contents);
 
                     //  Because of the nature of tables, width is more important than height.
@@ -748,7 +750,7 @@ private function writeChartInCell(Worksheet $worksheet, string $coordinates): st
                     if ($fp = fopen($chartFileName, 'rb', 0)) {
                         $picture = fread($fp, filesize($chartFileName));
                         fclose($fp);
-                        // base64 encode the binary data
+                        /** @phpstan-ignore-next-line */
                         $base64 = base64_encode($picture);
                         $imageData = 'data:' . $imageDetails['mime'] . ';base64,' . $base64;
 

diff --git a/src/PhpSpreadsheet/Writer/Xls.php b/src/PhpSpreadsheet/Writer/Xls.php
@@ -434,6 +434,7 @@ private function processDrawing(BstoreContainer &$bstoreContainer, Drawing $draw
             case 1: // GIF, not supported by BIFF8, we convert to PNG
                 $blipType = BSE::BLIPTYPE_PNG;
                 ob_start();
+                // @phpstan-ignore-next-line
                 imagepng(imagecreatefromgif($filename));
                 $blipData = ob_get_contents();
                 ob_end_clean();
@@ -452,6 +453,7 @@ private function processDrawing(BstoreContainer &$bstoreContainer, Drawing $draw
             case 6: // Windows DIB (BMP), we convert to PNG
                 $blipType = BSE::BLIPTYPE_PNG;
                 ob_start();
+                // @phpstan-ignore-next-line
                 imagepng(SharedDrawing::imagecreatefrombmp($filename));
                 $blipData = ob_get_contents();
                 ob_end_clean();

diff --git a/src/PhpSpreadsheet/Writer/Xls/Worksheet.php b/src/PhpSpreadsheet/Writer/Xls/Worksheet.php
@@ -989,6 +989,8 @@ public function writeUrlWeb($row1, $col1, $row2, $col2, $url): void
         $options = pack('V', 0x03);
 
         // Convert URL to a null terminated wchar string
+
+        /** @phpstan-ignore-next-line */
         $url = implode("\0", preg_split("''", $url, -1, PREG_SPLIT_NO_EMPTY));
         $url = $url . "\0\0\0";
 
@@ -2387,6 +2389,7 @@ public function processBitmapGd($image)
         $data = pack('Vvvvv', 0x000c, $width, $height, 0x01, 0x18);
         for ($j = $height; --$j;) {
             for ($i = 0; $i < $width; ++$i) {
+                /** @phpstan-ignore-next-line */
                 $color = imagecolorsforindex($image, imagecolorat($image, $i, $j));
                 foreach (['red', 'green', 'blue'] as $key) {
                     $color[$key] = $color[$key] + (int) round((255 - $color[$key]) * $color['alpha'] / 127);
@@ -2427,6 +2430,8 @@ public function processBitmap($bitmap)
         }
 
         // The first 2 bytes are used to identify the bitmap.
+
+        /** @phpstan-ignore-next-line */
         $identity = unpack('A2ident', $data);
         if ($identity['ident'] != 'BM') {
             throw new WriterException("$bitmap doesn't appear to be a valid bitmap image.\n");

diff --git a/src/PhpSpreadsheet/Writer/Xlsx.php b/src/PhpSpreadsheet/Writer/Xlsx.php
@@ -501,8 +501,10 @@ public function save($filename, int $flags = 0): void
                 $zipContent['xl/media/' . $this->getDrawingHashTable()->getByIndex($i)->getIndexedFilename()] = $imageContents;
             } elseif ($this->getDrawingHashTable()->getByIndex($i) instanceof MemoryDrawing) {
                 ob_start();
+                /** @var callable */
+                $callable = $this->getDrawingHashTable()->getByIndex($i)->getRenderingFunction();
                 call_user_func(
-                    $this->getDrawingHashTable()->getByIndex($i)->getRenderingFunction(),
+                    $callable,
                     $this->getDrawingHashTable()->getByIndex($i)->getImageResource()
                 );
                 $imageContents = ob_get_contents();

diff --git a/tests/PhpSpreadsheetTests/Calculation/Engine/RangeTest.php b/tests/PhpSpreadsheetTests/Calculation/Engine/RangeTest.php
@@ -9,6 +9,9 @@
 
 class RangeTest extends TestCase
 {
+    /** @var string */
+    private $incompleteMessage = 'Must be revisited';
+
     /**
      * @var Spreadsheet
      */
@@ -140,7 +143,9 @@ public function providerUTF8NamedRangeEvaluation(): array
      */
     public function testCompositeNamedRangeEvaluation(string $composite, int $expectedSum, int $expectedCount): void
     {
-        self::markTestSkipped('must be revisited.');
+        if ($this->incompleteMessage !== '') {
+            self::markTestIncomplete($this->incompleteMessage);
+        }
 
         $workSheet = $this->spreadSheet->getActiveSheet();
         $this->spreadSheet->addNamedRange(new NamedRange('COMPOSITE', $workSheet, $composite));

diff --git a/tests/PhpSpreadsheetTests/Collection/CellsTest.php b/tests/PhpSpreadsheetTests/Collection/CellsTest.php
@@ -20,7 +20,8 @@ public function testCollectionCell(): void
         // Assert empty state
         self::assertEquals([], $collection->getCoordinates(), 'cell list should be empty');
         self::assertEquals([], $collection->getSortedCoordinates(), 'sorted cell list should be empty');
-        self::assertNull($collection->get('B2'), 'getting non-existing cell must return null');
+        $getB2 = $collection->get('B2');
+        self::assertNull($getB2, 'getting non-existing cell must return null');
         self::assertFalse($collection->has('B2'), 'non-existing cell should be non-existent');
 
         // Add one cell
@@ -44,6 +45,7 @@ public function testCollectionCell(): void
         $collection2 = $collection->cloneCellCollection($sheet2);
         self::assertTrue($collection2->has('A1'));
         $copiedCell2 = $collection2->get('A1');
+        self::assertNotNull($copiedCell2);
         self::assertNotSame($cell2, $copiedCell2, 'copied cell should not be the same object any more');
         self::assertSame($collection2, $copiedCell2->getParent(), 'copied cell should be owned by the copied collection');
         self::assertSame('A1', $copiedCell2->getCoordinate(), 'copied cell should keep attributes');

diff --git a/tests/PhpSpreadsheetTests/Functional/ColumnWidthTest.php b/tests/PhpSpreadsheetTests/Functional/ColumnWidthTest.php
@@ -17,7 +17,7 @@ public function providerFormats(): array
     /**
      * @dataProvider providerFormats
      */
-    public function testReadColumnWidth($format): void
+    public function testReadColumnWidth(string $format): void
     {
         // create new sheet with column width
         $spreadsheet = new Spreadsheet();

diff --git a/tests/PhpSpreadsheetTests/Functional/CommentsTest.php b/tests/PhpSpreadsheetTests/Functional/CommentsTest.php
@@ -22,7 +22,7 @@ public function providerFormats(): array
      *
      * @dataProvider providerFormats
      */
-    public function testComments($format): void
+    public function testComments(string $format): void
     {
         $spreadsheet = new Spreadsheet();