Merge pull request #4447 from oleibman/stan1002

Phpstan 10 and IterableValue Prep Part 2

Author: oleibman

infra/DocumentGenerator.php

@@ -10,9 +10,9 @@
 class DocumentGenerator
 {
     /**
-     * @param array[] $phpSpreadsheetFunctions
+     * @param array<string, array{category: string, functionCall: string|string[], argumentCount: string, passCellReference?: bool, passByReference?: bool[], custom?: bool}> $phpSpreadsheetFunctions
      */
-    public static function generateFunctionListByCategory(array $phpSpreadsheetFunctions): string
+    public static function generateFunctionListByCategory($phpSpreadsheetFunctions): string
     {
         $result = "# Function list by category\n";
         foreach (self::getCategories() as $categoryConstant => $category) {
@@ -60,7 +60,7 @@ private static function tableRow(array $lengths, ?array $values = null): string
         return rtrim($result, ' ');
     }
 
-    /** @param array<int,string>|scalar $functionCall */
+    /** @param scalar|string|string[] $functionCall */
     private static function getPhpSpreadsheetFunctionText(mixed $functionCall): string
     {
         if (is_string($functionCall)) {
@@ -79,15 +79,14 @@ private static function getPhpSpreadsheetFunctionText(mixed $functionCall): stri
     }
 
     /**
-     * @param array<string, array<string, int|string>> $phpSpreadsheetFunctions
+     * @param array<string, array{category: string, functionCall: string|string[], argumentCount: string, passCellReference?: bool, passByReference?: bool[], custom?: bool}> $phpSpreadsheetFunctions
      */
     public static function generateFunctionListByName(array $phpSpreadsheetFunctions): string
     {
         $categoryConstants = array_flip(self::getCategories());
         $result = "# Function list by name\n";
         $lastAlphabet = null;
         foreach ($phpSpreadsheetFunctions as $excelFunction => $functionInfo) {
-            /** @var string $excelFunction */
             $lengths = [25, 31, 37];
             if ($lastAlphabet !== $excelFunction[0]) {
                 $lastAlphabet = $excelFunction[0];

infra/LocaleGenerator.php

@@ -30,7 +30,7 @@ class LocaleGenerator
 
     protected string $translationBaseFolder;
 
-    /** @var string[] */
+    /** @var array<string, array{category: string, functionCall: string|string[], argumentCount: string, passCellReference?: bool, passByReference?: bool[], custom?: bool}> */
     protected array $phpSpreadsheetFunctions;
 
     protected Spreadsheet $translationSpreadsheet;
@@ -42,19 +42,19 @@ class LocaleGenerator
     /** @var string[] */
     protected array $localeLanguageMap = [];
 
-    /** @var array<string, int> */
+    /** @var int[] */
     protected array $errorCodeMap = [];
 
     private Worksheet $functionNameTranslations;
 
     /** @var string[] */
     protected array $functionNameLanguageMap = [];
 
-    /** @var array<string, int|string> */
+    /** @var array<int|string> */
     protected array $functionNameMap = [];
 
     /**
-     * @param string[] $phpSpreadsheetFunctions
+     * @param array<string, array{category: string, functionCall: string|string[], argumentCount: string, passCellReference?: bool, passByReference?: bool[], custom?: bool}> $phpSpreadsheetFunctions
      */
     public function __construct(
         string $translationBaseFolder,

phpstan.neon.dist

@@ -21,9 +21,11 @@ parameters:
         - src/PhpSpreadsheet/Collection/Memory/SimpleCache3.php
         - src/PhpSpreadsheet/Writer/ZipStream2.php
         - src/PhpSpreadsheet/Writer/ZipStream3.php
+        #- tests/PhpSpreadsheetTests/Writer/Xlsx/ArrayFunctions2Test.php
     parallel:
         processTimeout: 300.0
     ignoreErrors:
         # Accept a bit anything for assert methods
         - '~^Parameter \#2 .* of static method PHPUnit\\Framework\\Assert\:\:assert\w+\(\) expects .*, .* given\.$~'
+        #- '~Method .*rovider.* return type has no value type specified in iterable type array\.$~'
         - identifier: missingType.iterableValue

samples/Basic/05_Feature_demo.php

@@ -1,8 +1,9 @@
 <?php
 
 require __DIR__ . '/../Header.php';
-/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
+/** @var PhpOffice\PhpSpreadsheet\Spreadsheet */
 $spreadsheet = require __DIR__ . '/../templates/sampleSpreadsheet.php';
 
 // Save
+/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
 $helper->write($spreadsheet, __FILE__);

samples/Basic/05_UnexpectedCharacters.php

@@ -1,8 +1,9 @@
 <?php
 
 require __DIR__ . '/../Header.php';
-/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
+/** @var PhpOffice\PhpSpreadsheet\Spreadsheet */
 $spreadsheet = require __DIR__ . '/../templates/sampleSpreadsheet2.php';
 
 // Save
+/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
 $helper->write($spreadsheet, __FILE__);

samples/Basic/06_Largescale.php

@@ -1,8 +1,9 @@
 <?php
 
 require __DIR__ . '/../Header.php';
-/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
+/** @var PhpOffice\PhpSpreadsheet\Spreadsheet */
 $spreadsheet = require __DIR__ . '/../templates/largeSpreadsheet.php';
 
 // Save
+/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
 $helper->write($spreadsheet, __FILE__);

samples/Basic/07_Reader.php

@@ -4,10 +4,11 @@
 use PhpOffice\PhpSpreadsheet\Writer\Xlsx;
 
 require __DIR__ . '/../Header.php';
-/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
 
 // Create temporary file that will be read
+/** @var PhpOffice\PhpSpreadsheet\Spreadsheet */
 $sampleSpreadsheet = require __DIR__ . '/../templates/sampleSpreadsheet.php';
+/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
 $filename = $helper->getTemporaryFilename();
 $writer = new Xlsx($sampleSpreadsheet);
 $writer->save($filename);

samples/Basic1/14_Xls.php

@@ -3,9 +3,10 @@
 use PhpOffice\PhpSpreadsheet\IOFactory;
 
 require __DIR__ . '/../Header.php';
-/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
+/** @var PhpOffice\PhpSpreadsheet\Spreadsheet */
 $spreadsheet = require __DIR__ . '/../templates/sampleSpreadsheet.php';
 
+/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
 $filename = $helper->getFilename(__FILE__, 'xls');
 $writer = IOFactory::createWriter($spreadsheet, 'Xls');
 

samples/Basic1/16_Csv.php

@@ -4,9 +4,10 @@
 use PhpOffice\PhpSpreadsheet\Writer\Csv as CsvWriter;
 
 require __DIR__ . '/../Header.php';
-/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
+/** @var PhpOffice\PhpSpreadsheet\Spreadsheet */
 $spreadsheet = require __DIR__ . '/../templates/sampleSpreadsheet.php';
 
+/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
 $helper->log('Write to CSV format');
 $writer = new CsvWriter($spreadsheet);
 $writer->setDelimiter(',')

samples/Basic1/17_Html.php

@@ -1,8 +1,9 @@
 <?php
 
 require __DIR__ . '/../Header.php';
-/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
+/** @var PhpOffice\PhpSpreadsheet\Spreadsheet */
 $spreadsheet = require __DIR__ . '/../templates/sampleSpreadsheet.php';
 $spreadsheet->getProperties()->setTitle('Non-embedded images');
 
+/** @var PhpOffice\PhpSpreadsheet\Helper\Sample $helper */
 $helper->write($spreadsheet, __FILE__, ['Html']);