Upgrade Phpstan

A very rough month for Dependabot's attempt to upgrade Phpstan. Many changes involving regular expressions, most with non-trivial workarounds. I have also filed one bug report.
oleibman · Sep 1, 2024 · b9a9d5d · b9a9d5d
1 parent f7c183b
commit b9a9d5d
Show file tree

Hide file tree

Showing 20 changed files with 85 additions and 55 deletions.
diff --git a/composer.lock b/composer.lock
diff --git a/src/PhpSpreadsheet/Calculation/Calculation.php b/src/PhpSpreadsheet/Calculation/Calculation.php
@@ -4180,8 +4180,10 @@ private function internalParseFormula(string $formula, ?Cell $cell = null): bool
                             }
                         }
                     } elseif ($expectedArgumentCount != '*') {
-                        preg_match('/(\d*)([-+,])(\d*)/', $expectedArgumentCount, $argMatch);
-                        switch ($argMatch[2] ?? '') {
+                        if (1 !== preg_match('/(\d*)([-+,])(\d*)/', $expectedArgumentCount, $argMatch)) {
+                            $argMatch = ['', '', '', ''];
+                        }
+                        switch ($argMatch[2]) {
                             case '+':
                                 if ($argumentCount < $argMatch[1]) {
                                     $argumentCountError = true;
@@ -4254,7 +4256,7 @@ private function internalParseFormula(string $formula, ?Cell $cell = null): bool
                 // do we now have a function/variable/number?
                 $expectingOperator = true;
                 $expectingOperand = false;
-                $val = $match[1];
+                $val = $match[1] ?? '';
                 $length = strlen($val);
 
                 if (preg_match('/^' . self::CALCULATION_REGEXP_FUNCTION . '$/miu', $val, $matches)) {
@@ -4310,7 +4312,7 @@ private function internalParseFormula(string $formula, ?Cell $cell = null): bool
                                 $rangeStartCellRef = $output[count($output) - 2]['value'] ?? '';
                             }
                             preg_match('/^' . self::CALCULATION_REGEXP_CELLREF . '$/miu', $rangeStartCellRef, $rangeStartMatches);
-                            if ($rangeStartMatches[2] !== $matches[2]) {
+                            if (isset($rangeStartMatches[2]) && $rangeStartMatches[2] !== $matches[2]) {
                                 return $this->raiseFormulaError('3D Range references are not yet supported');
                             }
                         }
@@ -4400,7 +4402,7 @@ private function internalParseFormula(string $formula, ?Cell $cell = null): bool
                                 $valx = $val;
                                 $endRowColRef = ($refSheet !== null) ? $refSheet->getHighestDataColumn($valx) : AddressRange::MAX_COLUMN; //    Max 16,384 columns for Excel2007
                                 $val = "{$rangeWS2}{$endRowColRef}{$val}";
-                            } elseif (ctype_alpha($val) && strlen($val ?? '') <= 3) {
+                            } elseif (ctype_alpha($val) && is_string($val) && strlen($val) <= 3) {
                                 //    Column range
                                 $stackItemType = 'Column Reference';
                                 $endRowColRef = ($refSheet !== null) ? $refSheet->getHighestDataRow($val) : AddressRange::MAX_ROW; //    Max 1,048,576 rows for Excel2007
@@ -4565,6 +4567,12 @@ private static function dataTestReference(array &$operandData): mixed
         return $operand;
     }
 
+    private static int $matchIndex8 = 8;
+
+    private static int $matchIndex9 = 9;
+
+    private static int $matchIndex10 = 10;
+
     /**
      * @return array<int, mixed>|false
      */
@@ -4928,12 +4936,17 @@ private function processTokenStack(mixed $tokens, ?string $cellID = null, ?Cell
             } elseif (preg_match('/^' . self::CALCULATION_REGEXP_CELLREF . '$/i', $token ?? '', $matches)) {
                 $cellRef = null;
 
-                if (isset($matches[8])) {
+                /* Phpstan says matches[8/9/10] is never set,
+                   and code coverage report seems to confirm.
+                   Appease PhpStan for now;
+                   probably delete this block later.
+                */
+                if (isset($matches[self::$matchIndex8])) {
                     if ($cell === null) {
                         // We can't access the range, so return a REF error
                         $cellValue = ExcelError::REF();
                     } else {
-                        $cellRef = $matches[6] . $matches[7] . ':' . $matches[9] . $matches[10];
+                        $cellRef = $matches[6] . $matches[7] . ':' . $matches[self::$matchIndex9] . $matches[self::$matchIndex10];
                         if ($matches[2] > '') {
                             $matches[2] = trim($matches[2], "\"'");
                             if ((str_contains($matches[2], '[')) || (str_contains($matches[2], ']'))) {

diff --git a/src/PhpSpreadsheet/Calculation/Functions.php b/src/PhpSpreadsheet/Calculation/Functions.php
@@ -164,8 +164,10 @@ public static function ifCondition(mixed $condition): string
 
             return str_replace('""""', '""', '=' . $condition);
         }
-        preg_match('/(=|<[>=]?|>=?)(.*)/', $condition, $matches);
-        [, $operator, $operand] = $matches;
+        $operator = $operand = '';
+        if (1 === preg_match('/(=|<[>=]?|>=?)(.*)/', $condition, $matches)) {
+            [, $operator, $operand] = $matches;
+        }
 
         $operand = self::operandSpecialHandling($operand);
         if (is_numeric(trim($operand, '"'))) {

diff --git a/src/PhpSpreadsheet/Calculation/Information/Value.php b/src/PhpSpreadsheet/Calculation/Information/Value.php
@@ -210,10 +210,11 @@ public static function isFormula(mixed $cellReference = '', ?Cell $cell = null):
 
         $fullCellReference = Functions::trimTrailingRange($fullCellReference);
 
-        preg_match('/^' . Calculation::CALCULATION_REGEXP_CELLREF . '$/i', $fullCellReference, $matches);
-
-        $fullCellReference = $matches[6] . $matches[7];
-        $worksheetName = str_replace("''", "'", trim($matches[2], "'"));
+        $worksheetName = '';
+        if (1 == preg_match('/^' . Calculation::CALCULATION_REGEXP_CELLREF . '$/i', $fullCellReference, $matches)) {
+            $fullCellReference = $matches[6] . $matches[7];
+            $worksheetName = str_replace("''", "'", trim($matches[2], "'"));
+        }
 
         $worksheet = (!empty($worksheetName))
             ? $cell->getWorksheet()->getParentOrThrow()->getSheetByName($worksheetName)

diff --git a/src/PhpSpreadsheet/Calculation/LookupRef/Formula.php b/src/PhpSpreadsheet/Calculation/LookupRef/Formula.php
@@ -20,13 +20,14 @@ public static function text(mixed $cellReference = '', ?Cell $cell = null): stri
             return ExcelError::REF();
         }
 
-        preg_match('/^' . Calculation::CALCULATION_REGEXP_CELLREF . '$/i', $cellReference, $matches);
-
-        $cellReference = $matches[6] . $matches[7];
-        $worksheetName = trim($matches[3], "'");
-        $worksheet = (!empty($worksheetName))
-            ? $cell->getWorksheet()->getParentOrThrow()->getSheetByName($worksheetName)
-            : $cell->getWorksheet();
+        $worksheet = null;
+        if (1 === preg_match('/^' . Calculation::CALCULATION_REGEXP_CELLREF . '$/i', $cellReference, $matches)) {
+            $cellReference = $matches[6] . $matches[7];
+            $worksheetName = trim($matches[3], "'");
+            $worksheet = (!empty($worksheetName))
+                ? $cell->getWorksheet()->getParentOrThrow()->getSheetByName($worksheetName)
+                : $cell->getWorksheet();
+        }
 
         if (
             $worksheet === null

diff --git a/src/PhpSpreadsheet/Cell/AddressHelper.php b/src/PhpSpreadsheet/Cell/AddressHelper.php
@@ -136,9 +136,7 @@ public static function convertToR1C1(
         ?int $currentRowNumber = null,
         ?int $currentColumnNumber = null
     ): string {
-        $validityCheck = preg_match(Coordinate::A1_COORDINATE_REGEX, $address, $cellReference);
-
-        if ($validityCheck === 0) {
+        if (1 !== preg_match(Coordinate::A1_COORDINATE_REGEX, $address, $cellReference)) {
             throw new Exception('Invalid A1-format Cell Reference');
         }
 

diff --git a/src/PhpSpreadsheet/Cell/Cell.php b/src/PhpSpreadsheet/Cell/Cell.php
@@ -481,9 +481,10 @@ public function getCalculatedValue(bool $resetLog = true): mixed
                                 if (isset($matches[3])) {
                                     $minCol = $matches[1];
                                     $minRow = (int) $matches[2];
-                                    $maxCol = $matches[4];
+                                    // https://github.com/phpstan/phpstan/issues/11602
+                                    $maxCol = $matches[4]; // @phpstan-ignore-line
                                     ++$maxCol;
-                                    $maxRow = (int) $matches[5];
+                                    $maxRow = (int) $matches[5]; // @phpstan-ignore-line
                                     for ($row = $minRow; $row <= $maxRow; ++$row) {
                                         for ($col = $minCol; $col !== $maxCol; ++$col) {
                                             if ("$col$row" !== $coordinate) {

diff --git a/src/PhpSpreadsheet/Cell/Coordinate.php b/src/PhpSpreadsheet/Cell/Coordinate.php
@@ -271,8 +271,7 @@ public static function getRangeBoundaries(string $range): array
     private static function validateReferenceAndGetData($reference): array
     {
         $data = [];
-        preg_match(self::FULL_REFERENCE_REGEX, $reference, $matches);
-        if (count($matches) === 0) {
+        if (1 !== preg_match(self::FULL_REFERENCE_REGEX, $reference, $matches)) {
             return ['type' => 'invalid'];
         }
 

diff --git a/src/PhpSpreadsheet/Helper/Size.php b/src/PhpSpreadsheet/Helper/Size.php
@@ -8,16 +8,16 @@ class Size implements Stringable
 {
     const REGEXP_SIZE_VALIDATION = '/^(?P<size>\d*\.?\d+)(?P<unit>pt|px|em)?$/i';
 
-    protected bool $valid;
+    protected bool $valid = false;
 
     protected string $size = '';
 
     protected string $unit = '';
 
     public function __construct(string $size)
     {
-        $this->valid = (bool) preg_match(self::REGEXP_SIZE_VALIDATION, $size, $matches);
-        if ($this->valid) {
+        if (1 === preg_match(self::REGEXP_SIZE_VALIDATION, $size, $matches)) {
+            $this->valid = true;
             $this->size = $matches['size'];
             $this->unit = $matches['unit'] ?? 'pt';
         }

diff --git a/src/PhpSpreadsheet/Reader/Xlsx.php b/src/PhpSpreadsheet/Reader/Xlsx.php
@@ -2346,8 +2346,9 @@ private function processIgnoredErrors(SimpleXMLElement $xml, Worksheet $sheet):
                     $firstRow = $matches[2];
                     $firstCol = $matches[1];
                     if (array_key_exists(3, $matches)) {
-                        $lastCol = $matches[4];
-                        $lastRow = $matches[5];
+                        // https://github.com/phpstan/phpstan/issues/11602
+                        $lastCol = $matches[4]; // @phpstan-ignore-line
+                        $lastRow = $matches[5]; // @phpstan-ignore-line
                     } else {
                         $lastCol = $firstCol;
                         $lastRow = $firstRow;

diff --git a/src/PhpSpreadsheet/ReferenceHelper.php b/src/PhpSpreadsheet/ReferenceHelper.php
@@ -759,7 +759,7 @@ private function updateCellReferencesAllWorksheets(string $formula, int $numberO
             $column = $columns[$splitCount][0];
             $row = $rows[$splitCount][0];
 
-            if (!empty($column) && $column[0] !== '$') {
+            if ($column[0] !== '$') {
                 $column = ((Coordinate::columnIndexFromString($column) + $numberOfColumns) % AddressRange::MAX_COLUMN_INT) ?: AddressRange::MAX_COLUMN_INT;
                 $column = Coordinate::stringFromColumnIndex($column);
                 $rowOffset -= ($columnLength - strlen($column));

diff --git a/src/PhpSpreadsheet/Style/NumberFormat/FractionFormatter.php b/src/PhpSpreadsheet/Style/NumberFormat/FractionFormatter.php
@@ -25,9 +25,9 @@ public static function format(mixed $value, string $format): string
         $decimalDivisor = 10 ** $decimalLength;
 
         preg_match('/(#?.*\?)\/(\?+|\d+)/', $format, $matches);
-        $formatIntegerPart = $matches[1];
+        $formatIntegerPart = $matches[1] ?? '0';
 
-        if (is_numeric($matches[2])) {
+        if (isset($matches[2]) && is_numeric($matches[2])) {
             $fractionDivisor = 100 / (int) $matches[2];
         } else {
             /** @var float $fractionDivisor */

diff --git a/src/PhpSpreadsheet/Style/NumberFormat/Wizard/NumberBase.php b/src/PhpSpreadsheet/Style/NumberFormat/Wizard/NumberBase.php
@@ -60,7 +60,7 @@ private function validateLocale(string $locale): string
 
         ['language' => $language, 'script' => $script, 'country' => $country] = $matches;
         // Set case and separator to match standardised locale case
-        $language = strtolower($language ?? '');
+        $language = strtolower($language);
         $script = ($script === null) ? null : ucfirst(strtolower($script));
         $country = ($country === null) ? null : strtoupper($country);
 

diff --git a/src/PhpSpreadsheet/Writer/BaseWriter.php b/src/PhpSpreadsheet/Writer/BaseWriter.php
@@ -100,7 +100,7 @@ protected function processFlags(int $flags): void
      */
     public function openFileHandle($filename): void
     {
-        if (is_resource($filename)) {
+        if (!is_string($filename)) {
             $this->fileHandle = $filename;
             $this->shouldCloseFile = false;
 

diff --git a/src/PhpSpreadsheet/Writer/Ods/Content.php b/src/PhpSpreadsheet/Writer/Ods/Content.php
@@ -238,10 +238,11 @@ private function writeCells(XMLWriter $objWriter, RowCellIterator $cells): void
                             $matrixColSpan = 1;
                             if (isset($matches[3])) {
                                 $minRow = (int) $matches[2];
-                                $maxRow = (int) $matches[5];
+                                // https://github.com/phpstan/phpstan/issues/11602
+                                $maxRow = (int) $matches[5]; // @phpstan-ignore-line
                                 $matrixRowSpan = $maxRow - $minRow + 1;
                                 $minCol = Coordinate::columnIndexFromString($matches[1]);
-                                $maxCol = Coordinate::columnIndexFromString($matches[4]);
+                                $maxCol = Coordinate::columnIndexFromString($matches[4]); // @phpstan-ignore-line
                                 $matrixColSpan = $maxCol - $minCol + 1;
                             }
                             $objWriter->writeAttribute('table:number-matrix-columns-spanned', "$matrixColSpan");

diff --git a/src/PhpSpreadsheet/Writer/Ods/Formula.php b/src/PhpSpreadsheet/Writer/Ods/Formula.php
@@ -102,9 +102,9 @@ private function convertCellReferences(string $formula, string $worksheetName):
             }
             $newRange .= '.';
 
-            if (!empty($column)) {
-                $newRange .= $column;
-            }
+            //if (!empty($column)) { // phpstan says always true
+            $newRange .= $column;
+            //}
             if (!empty($row)) {
                 $newRange .= $row;
             }

diff --git a/src/PhpSpreadsheet/Writer/Ods/NamedExpressions.php b/src/PhpSpreadsheet/Writer/Ods/NamedExpressions.php
@@ -118,9 +118,9 @@ private function convertAddress(DefinedName $definedName, string $address): stri
                 $newRange = "'" . str_replace("'", "''", $worksheet) . "'.";
             }
 
-            if (!empty($column)) {
-                $newRange .= $column;
-            }
+            //if (!empty($column)) { // phpstan says always true
+            $newRange .= $column;
+            //}
             if (!empty($row)) {
                 $newRange .= $row;
             }

diff --git a/src/PhpSpreadsheet/Writer/Xls/Parser.php b/src/PhpSpreadsheet/Writer/Xls/Parser.php
@@ -894,7 +894,11 @@ private function cellToPackedRowcol(string $cell): array
      */
     private function rangeToPackedRange(string $range): array
     {
-        preg_match('/(\$)?(\d+)\:(\$)?(\d+)/', $range, $match);
+        if (preg_match('/(\$)?(\d+)\:(\$)?(\d+)/', $range, $match) !== 1) {
+            // @codeCoverageIgnoreStart
+            throw new WriterException('Regexp failure in rangeToPackedRange');
+            // @codeCoverageIgnoreEnd
+        }
         // return absolute rows if there is a $ in the ref
         $row1_rel = empty($match[1]) ? 1 : 0;
         $row1 = $match[2];
@@ -933,7 +937,11 @@ private function rangeToPackedRange(string $range): array
      */
     private function cellToRowcol(string $cell): array
     {
-        preg_match('/(\$)?([A-I]?[A-Z])(\$)?(\d+)/', $cell, $match);
+        if (preg_match('/(\$)?([A-I]?[A-Z])(\$)?(\d+)/', $cell, $match) !== 1) {
+            // @codeCoverageIgnoreStart
+            throw new WriterException('Regexp failure in cellToRowcol');
+            // @codeCoverageIgnoreEnd
+        }
         // return absolute column if there is a $ in the ref
         $col_rel = empty($match[1]) ? 1 : 0;
         $col_ref = $match[2];

diff --git a/src/PhpSpreadsheet/Writer/Xlsx/Drawing.php b/src/PhpSpreadsheet/Writer/Xlsx/Drawing.php
@@ -501,7 +501,11 @@ public function writeVMLHeaderFooterImages(\PhpOffice\PhpSpreadsheet\Worksheet\W
     private function writeVMLHeaderFooterImage(XMLWriter $objWriter, string $reference, HeaderFooterDrawing $image): void
     {
         // Calculate object id
-        preg_match('{(\d+)}', md5($reference), $m);
+        if (preg_match('{(\d+)}', md5($reference), $m) !== 1) {
+            // @codeCoverageIgnoreStart
+            throw new WriterException('Regexp failure in writeVMLHeaderFooterImage');
+            // @codeCoverageIgnoreEnd
+        }
         $id = 1500 + ((int) substr($m[1], 0, 2) * 1);
 
         // Calculate offset

diff --git a/src/PhpSpreadsheet/Writer/Xlsx/Worksheet.php b/src/PhpSpreadsheet/Writer/Xlsx/Worksheet.php
@@ -1542,10 +1542,11 @@ private function parseRef(string $coordinate, string $ref): string
             return $coordinate;
         }
         $minRow = (int) $matches[2];
-        $maxRow = (int) $matches[5];
+        // https://github.com/phpstan/phpstan/issues/11602
+        $maxRow = (int) $matches[5]; // @phpstan-ignore-line
         $rows = $maxRow - $minRow + 1;
         $minCol = Coordinate::columnIndexFromString($matches[1]);
-        $maxCol = Coordinate::columnIndexFromString($matches[4]);
+        $maxCol = Coordinate::columnIndexFromString($matches[4]); // @phpstan-ignore-line
         $cols = $maxCol - $minCol + 1;
         $firstCellArray = Coordinate::indexesFromString($coordinate);
         $lastRow = $firstCellArray[1] + $rows - 1;