Phpstan Tweaks

oleibman · oleibman · commit f1a61c4c6b78 · 2025-04-06T18:14:59.000-07:00
Phpstan level 10 reports an enormous number of errors. So does the excluded missingType.iterableValue. I do not plan to introduce either any time soon. But I will submit piecemeal changes from time to time. Changes will be mostly limited to phpdoc type declarations.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -87,7 +87,7 @@ jobs:
 
       # This is non-ideal because it only checks for the last commit of the PR, not all of them, but better than nothing
       - name: Check PHPDoc types
-        run: ./bin/check-phpdoc-types
+        run: ./bin/check-phpdoc-types.php
 
   php-cs-fixer:
     runs-on: ubuntu-latest
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -1,9 +1,8 @@
 <?php
 
 $finder = PhpCsFixer\Finder::create()
-    ->exclude('vendor')
+    ->exclude('vendor', 'docs', '.git', '.github')
     ->notPath('src/PhpSpreadsheet/Writer/ZipStream3.php')
-    ->name('/(\.php|^generate-document|^generate-locales|^check-phpdoc-types)$/')
     ->in(__DIR__);
 
 $config = new PhpCsFixer\Config();
diff --git a/.phpcs.xml.dist b/.phpcs.xml.dist
@@ -6,12 +6,7 @@
     <file>src</file>
     <file>tests</file>
     <file>infra</file>
-    <file>bin/generate-document</file>
-    <file>bin/generate-locales</file>
-    <file>bin/check-phpdoc-types</file>
-
-    <exclude-pattern>samples/Header.php</exclude-pattern>
-    <exclude-pattern>*/tests/Core/*/*Test\.(inc|css|js)$</exclude-pattern>
+    <file>bin</file>
 
     <arg name="report-width" value="200"/>
     <arg name="parallel" value="80"/>
diff --git a/bin/check-phpdoc-types.php b/bin/check-phpdoc-types.php
diff --git a/bin/generate-document.php b/bin/generate-document.php
@@ -4,7 +4,7 @@
 use PhpOffice\PhpSpreadsheet\Calculation\Calculation;
 use PhpOffice\PhpSpreadsheetInfra\DocumentGenerator;
 
-require_once 'vendor/autoload.php';
+require_once __DIR__ . '/..' . '/vendor/autoload.php';
 
 $phpSpreadsheetFunctions = Calculation::getFunctions();
 ksort($phpSpreadsheetFunctions);
diff --git a/bin/generate-locales.php b/bin/generate-locales.php
@@ -4,7 +4,7 @@
 use PhpOffice\PhpSpreadsheet\Calculation\Calculation;
 use PhpOffice\PhpSpreadsheetInfra\LocaleGenerator;
 
-require_once 'vendor/autoload.php';
+require_once __DIR__ . '/..' . '/vendor/autoload.php';
 
 $phpSpreadsheetFunctions = Calculation::getFunctions();
 
diff --git a/bin/pre-commit b/bin/pre-commit
@@ -24,7 +24,7 @@ if [ "$files" != "" ]; then
 fi
 
 # Check PHPDoc types
-./bin/check-phpdoc-types
+./bin/check-phpdoc-types.php
 if [ $? -ne 0 ]; then
     pass=false
 fi
diff --git a/infra/DocumentGenerator.php b/infra/DocumentGenerator.php
@@ -33,11 +33,19 @@ public static function generateFunctionListByCategory(array $phpSpreadsheetFunct
         return $result;
     }
 
+    /** @return array<string, string> */
     private static function getCategories(): array
     {
-        return (new ReflectionClass(Category::class))->getConstants();
+        /** @var array<string, string> */
+        $x = (new ReflectionClass(Category::class))->getConstants();
+
+        return $x;
     }
 
+    /**
+     * @param int[] $lengths
+     * @param null|array<int, int|string> $values
+     */
     private static function tableRow(array $lengths, ?array $values = null): string
     {
         $result = '';
@@ -46,7 +54,7 @@ private static function tableRow(array $lengths, ?array $values = null): string
             if ($i > 0) {
                 $result .= '|' . $pad;
             }
-            $result .= str_pad($value ?? '', $length, $pad);
+            $result .= str_pad("$value", $length ?? 0, $pad);
         }
 
         return rtrim($result, ' ');
@@ -71,7 +79,7 @@ private static function getPhpSpreadsheetFunctionText(mixed $functionCall): stri
     }
 
     /**
-     * @param array[] $phpSpreadsheetFunctions
+     * @param array<string, array<string, int|string>> $phpSpreadsheetFunctions
      */
     public static function generateFunctionListByName(array $phpSpreadsheetFunctions): string
     {
diff --git a/infra/LocaleGenerator.php b/infra/LocaleGenerator.php
@@ -30,6 +30,7 @@ class LocaleGenerator
 
     protected string $translationBaseFolder;
 
+    /** @var string[] */
     protected array $phpSpreadsheetFunctions;
 
     protected Spreadsheet $translationSpreadsheet;
@@ -38,16 +39,23 @@ class LocaleGenerator
 
     protected Worksheet $localeTranslations;
 
+    /** @var string[] */
     protected array $localeLanguageMap = [];
 
+    /** @var array<string, int> */
     protected array $errorCodeMap = [];
 
     private Worksheet $functionNameTranslations;
 
+    /** @var string[] */
     protected array $functionNameLanguageMap = [];
 
+    /** @var array<string, int|string> */
     protected array $functionNameMap = [];
 
+    /**
+     * @param string[] $phpSpreadsheetFunctions
+     */
     public function __construct(
         string $translationBaseFolder,
         string $translationSpreadsheetName,
@@ -268,6 +276,7 @@ protected function getTranslationSheet(string $sheetName): Worksheet
         return $worksheet;
     }
 
+    /** @return string[] */
     protected function mapLanguageColumns(Worksheet $translationWorksheet): array
     {
         $sheetName = $translationWorksheet->getTitle();
@@ -282,7 +291,7 @@ protected function mapLanguageColumns(Worksheet $translationWorksheet): array
             $cells->setIterateOnlyExistingCells(true);
             foreach ($cells as $cell) {
                 if ($this->localeCanBeSupported($translationWorksheet, $cell)) {
-                    $languageNameMap[$cell->getColumn()] = $cell->getValue();
+                    $languageNameMap[$cell->getColumn()] = $cell->getValueString();
                     $this->log($cell->getColumn() . ' -> ' . $cell->getValueString());
                 }
             }
diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -13,9 +13,7 @@ parameters:
         - src/
         - tests/
         - infra/
-        - bin/generate-document
-        - bin/generate-locales
-        - bin/check-phpdoc-types
+        - bin/
     excludePaths:
         - src/PhpSpreadsheet/Chart/Renderer/JpGraph.php
         - src/PhpSpreadsheet/Chart/Renderer/JpGraphRendererBase.php
diff --git a/samples/Basic3/39_Dropdown.php b/samples/Basic3/39_Dropdown.php
@@ -22,6 +22,7 @@
     ->setKeywords('Office PhpSpreadsheet php')
     ->setCategory('Test result file');
 
+/** @return array<int, string> */
 function transpose(string $value): array
 {
     return [$value];
diff --git a/samples/Chart33a/33_Chart_create_line_dateaxis.php b/samples/Chart33a/33_Chart_create_line_dateaxis.php
@@ -338,6 +338,7 @@
 $helper->write($spreadsheet, __FILE__, ['Xlsx'], true, resetActiveSheet: false);
 $spreadsheet->disconnectWorksheets();
 
+/** return array{'min': float|int, 'max': float|int} */
 function dateRange(int $nrows, Spreadsheet $wrkbk): array
 {
     $dataSheet = $wrkbk->getSheetByNameOrThrow('Data');
diff --git a/samples/DefinedNames/CrossWorksheetNamedFormula.php b/samples/DefinedNames/CrossWorksheetNamedFormula.php
@@ -40,6 +40,7 @@
 $worksheet = $spreadsheet->addSheet(new Worksheet($spreadsheet));
 setYearlyData($worksheet, '2020', [], 'GROWTH');
 
+/** @param array<int, array<int, int>> $yearlyData */
 function setYearlyData(Worksheet $worksheet, string $year, array $yearlyData, ?string $title = null): void
 {
     // Set up some basic data
diff --git a/samples/Pdf/Mpdf2.php b/samples/Pdf/Mpdf2.php
@@ -16,7 +16,7 @@ class Mpdf2 extends Mpdf
      *     be used by Mpdf (which would instead use a default substitution).
      * Other configuration options may be specified here.
      *
-     * @param array $config Configuration array
+     * @param array<string, mixed> $config Configuration array
      */
     protected function createExternalWriterInstance($config): \Mpdf\Mpdf
     {
diff --git a/samples/Reader/10_Simple_file_reader_using_a_configurable_read_filter.php b/samples/Reader/10_Simple_file_reader_using_a_configurable_read_filter.php
@@ -13,6 +13,7 @@
 
 class MyReadFilter implements IReadFilter
 {
+    /** @param array<int, string> $columns */
     public function __construct(
         private int $startRow,
         private int $endRow,
diff --git a/src/PhpSpreadsheet/Cell/AdvancedValueBinder.php b/src/PhpSpreadsheet/Cell/AdvancedValueBinder.php
@@ -110,6 +110,7 @@ public function bindValue(Cell $cell, mixed $value = null): bool
         return parent::bindValue($cell, $value);
     }
 
+    /** @param array{0: non-falsy-string, 1: ?string, 2: numeric-string, 3: numeric-string, 4: numeric-string} $matches */
     protected function setImproperFraction(array $matches, Cell $cell): bool
     {
         // Convert value to number
@@ -130,6 +131,7 @@ protected function setImproperFraction(array $matches, Cell $cell): bool
         return true;
     }
 
+    /** @param array{0: non-falsy-string, 1: ?string, 2: numeric-string, 3: numeric-string} $matches */
     protected function setProperFraction(array $matches, Cell $cell): bool
     {
         // Convert value to number
diff --git a/src/PhpSpreadsheet/Theme.php b/src/PhpSpreadsheet/Theme.php
@@ -135,6 +135,7 @@ class Theme
         'Geor' => 'Sylfaen',
     ];
 
+    /** @return string[] */
     public function getThemeColors(): array
     {
         return $this->themeColors;
@@ -152,6 +153,7 @@ public function getThemeColorName(): string
         return $this->themeColorName;
     }
 
+    /** @param null|string[] $themeColors */
     public function setThemeColorName(string $name, ?array $themeColors = null): self
     {
         $this->themeColorName = $name;
@@ -182,11 +184,13 @@ public function getMajorFontComplexScript(): string
         return $this->majorFontComplexScript;
     }
 
+    /** @return string[] */
     public function getMajorFontSubstitutions(): array
     {
         return $this->majorFontSubstitutions;
     }
 
+    /** @param null|string[] $substitutions */
     public function setMajorFontValues(?string $latin, ?string $eastAsian, ?string $complexScript, ?array $substitutions): self
     {
         if (!empty($latin)) {
@@ -220,11 +224,13 @@ public function getMinorFontComplexScript(): string
         return $this->minorFontComplexScript;
     }
 
+    /** @return string[] */
     public function getMinorFontSubstitutions(): array
     {
         return $this->minorFontSubstitutions;
     }
 
+    /** @param null|string[] $substitutions */
     public function setMinorFontValues(?string $latin, ?string $eastAsian, ?string $complexScript, ?array $substitutions): self
     {
         if (!empty($latin)) {
diff --git a/src/PhpSpreadsheet/Worksheet/Worksheet.php b/src/PhpSpreadsheet/Worksheet/Worksheet.php
@@ -158,6 +158,8 @@ class Worksheet
 
     /**
      * Conditional styles. Indexed by cell coordinate, e.g. 'A1'.
+     *
+     * @var Conditional[][]
      */
     private array $conditionalStylesCollection = [];
 
@@ -1558,6 +1560,8 @@ public function removeConditionalStyles(string $coordinate): static
 
     /**
      * Get collection of conditional styles.
+     *
+     * @return Conditional[][]
      */
     public function getConditionalStylesCollection(): array
     {
diff --git a/src/PhpSpreadsheet/Writer/Html.php b/src/PhpSpreadsheet/Writer/Html.php
@@ -488,7 +488,7 @@ public function generateSheetData(): string
             foreach ($condStylesCollection as $condStyles) {
                 foreach ($condStyles as $key => $cs) {
                     if ($cs->getConditionType() === Conditional::CONDITION_COLORSCALE) {
-                        $cs->getColorScale()->setScaleArray();
+                        $cs->getColorScale()?->setScaleArray();
                     }
                 }
             }
diff --git a/tests/PhpSpreadsheetTests/Reader/Xlsx/Issue4049Test.php b/tests/PhpSpreadsheetTests/Reader/Xlsx/Issue4049Test.php
@@ -26,12 +26,14 @@ public function testColorScale(): void
         $colorScale = $cond1[0]->getColorScale();
         self::assertNotNull($colorScale);
         $min = $colorScale->getMinimumConditionalFormatValueObject();
+        self::assertNotNull($min);
         self::assertSame('formula', $min->getType());
         self::assertSame('25', $min->getCellFormula());
 
         self::assertNull($colorScale->getMidpointConditionalFormatValueObject());
 
         $max = $colorScale->getMaximumConditionalFormatValueObject();
+        self::assertNotNull($max);
         self::assertSame('max', $max->getType());
         self::assertNull($max->getValue());
 

Original file line number	Diff line number	Diff line change
`@@ -33,11 +33,19 @@ public static function generateFunctionListByCategory(array $phpSpreadsheetFunct`
`33`	`33`	`return $result;`
`34`	`34`	`}`
`35`	`35`
	`36`	`+ /** @return array<string, string> */`
`36`	`37`	`private static function getCategories(): array`
`37`	`38`	`{`
`38`		`- return (new ReflectionClass(Category::class))->getConstants();`
	`39`	`+ /** @var array<string, string> */`
	`40`	`+ $x = (new ReflectionClass(Category::class))->getConstants();`
	`41`	`+`
	`42`	`+ return $x;`
`39`	`43`	`}`
`40`	`44`
	`45`	`+ /**`
	`46`	`+ * @param int[] $lengths`
	`47`	`+ * @param null\|array<int, int\|string> $values`
	`48`	`+ */`
`41`	`49`	`private static function tableRow(array $lengths, ?array $values = null): string`
`42`	`50`	`{`
`43`	`51`	`$result = '';`
`@@ -46,7 +54,7 @@ private static function tableRow(array $lengths, ?array $values = null): string`
`46`	`54`	`if ($i > 0) {`
`47`	`55`	`$result .= '\|' . $pad;`
`48`	`56`	`}`
`49`		`- $result .= str_pad($value ?? '', $length, $pad);`
	`57`	`+ $result .= str_pad("$value", $length ?? 0, $pad);`
`50`	`58`	`}`
`51`	`59`
`52`	`60`	`return rtrim($result, ' ');`
`@@ -71,7 +79,7 @@ private static function getPhpSpreadsheetFunctionText(mixed $functionCall): stri`
`71`	`79`	`}`
`72`	`80`
`73`	`81`	`/**`
`74`		`- * @param array[] $phpSpreadsheetFunctions`
	`82`	`+ * @param array<string, array<string, int\|string>> $phpSpreadsheetFunctions`
`75`	`83`	`*/`
`76`	`84`	`public static function generateFunctionListByName(array $phpSpreadsheetFunctions): string`
`77`	`85`	`{`