Merge pull request #4482 from oleibman/stan1009

Phpstan Level 10 (Final)

Author: oleibman

phpstan-baseline.neon

@@ -1,2 +1,49 @@
 parameters:
 	ignoreErrors:
+		-
+			message: '#^Parameter \#1 \$array of function array_multisort expects array, mixed given\.$#'
+			identifier: argument.type
+			count: 1
+			path: src/PhpSpreadsheet/Calculation/LookupRef/Sort.php
+
+		-
+			message: '#^Cannot call method getAllSpContainers\(\) on mixed\.$#'
+			identifier: method.nonObject
+			count: 1
+			path: src/PhpSpreadsheet/Reader/Xls/LoadSpreadsheet.php
+
+		-
+			message: '#^Cannot call method getBSECollection\(\) on mixed\.$#'
+			identifier: method.nonObject
+			count: 1
+			path: src/PhpSpreadsheet/Reader/Xls/LoadSpreadsheet.php
+
+		-
+			message: '#^Cannot call method getBstoreContainer\(\) on mixed\.$#'
+			identifier: method.nonObject
+			count: 1
+			path: src/PhpSpreadsheet/Reader/Xls/LoadSpreadsheet.php
+
+		-
+			message: '#^Cannot call method getSpgrContainer\(\) on mixed\.$#'
+			identifier: method.nonObject
+			count: 1
+			path: src/PhpSpreadsheet/Reader/Xls/LoadSpreadsheet.php
+
+		-
+			message: '#^Cannot access offset 0 on mixed\.$#'
+			identifier: offsetAccess.nonOffsetAccessible
+			count: 1
+			path: src/PhpSpreadsheet/ReferenceHelper.php
+
+		-
+			message: '#^Parameter \#1 \$string of function trim expects string, mixed given\.$#'
+			identifier: argument.type
+			count: 1
+			path: src/PhpSpreadsheet/ReferenceHelper.php
+
+		-
+			message: '#^Cannot call method setParent\(\) on mixed\.$#'
+			identifier: method.nonObject
+			count: 1
+			path: src/PhpSpreadsheet/Worksheet/AutoFilter.php

phpstan.neon.dist

@@ -7,7 +7,7 @@ includes:
     - vendor/phpstan/phpstan-deprecation-rules/rules.neon
 
 parameters:
-    level: 9
+    level: 10
     paths:
         - samples/
         - src/
@@ -21,13 +21,13 @@ parameters:
         - src/PhpSpreadsheet/Collection/Memory/SimpleCache3.php
         - src/PhpSpreadsheet/Writer/ZipStream2.php
         - src/PhpSpreadsheet/Writer/ZipStream3.php
-        #- tests/PhpSpreadsheetTests/Writer/Xlsx/ArrayFunctions2Test.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\.$~'
-        #- '~Method .*rovider.* should return array but returns mixed\.$~'
-        #- '~.* has parameter \$expectedResult with no value type specified in iterable type array\.$~'
-        - identifier: missingType.iterableValue
+        - '~Method .*rovider.* return type has no value type specified in iterable type array\.$~'
+        - '~Method .*rovider.* should return array but returns mixed\.$~'
+        - '~.* has parameter \$expectedResult with no value type specified in iterable type array\.$~'
+        #- identifier: missingType.iterableValue

src/PhpSpreadsheet/Calculation/Statistical/Averages.php

@@ -156,6 +156,7 @@ public static function median(mixed ...$args): float|string
 
         $returnValue = ExcelError::NAN();
 
+        /** @var array<float|int> */
         $aArgs = self::filterArguments($aArgs);
         $valueCount = count($aArgs);
         if ($valueCount > 0) {
@@ -199,6 +200,11 @@ public static function mode(mixed ...$args): float|string
         return $returnValue;
     }
 
+    /**
+     * @param mixed[] $args
+     *
+     * @return mixed[]
+     */
     protected static function filterArguments(array $args): array
     {
         return array_filter(
@@ -213,6 +219,8 @@ function ($value): bool {
     /**
      * Special variant of array_count_values that isn't limited to strings and integers,
      * but can work with floating point numbers as values.
+     *
+     * @param mixed[] $data
      */
     private static function modeCalc(array $data): float|string
     {
@@ -222,9 +230,11 @@ private static function modeCalc(array $data): float|string
         $maxfreqkey = '';
         $maxfreqdatum = '';
         foreach ($data as $datum) {
+            /** @var float|string $datum */
             $found = false;
             ++$index;
             foreach ($frequencyArray as $key => $value) {
+                /** @var string[] $value */
                 if ((string) $value['value'] == (string) $datum) {
                     ++$frequencyArray[$key]['frequency'];
                     $freq = $frequencyArray[$key]['frequency'];

src/PhpSpreadsheet/Calculation/Statistical/Conditional.php

@@ -26,7 +26,7 @@ class Conditional
      *        AVERAGEIF(range,condition[, average_range])
      *
      * @param mixed $range Data values, expect array
-     * @param null|array|string $condition the criteria that defines which cells will be checked
+     * @param null|mixed[]|string $condition the criteria that defines which cells will be checked
      * @param mixed $averageRange Data values
      */
     public static function AVERAGEIF(mixed $range, null|array|string $condition, mixed $averageRange = []): null|int|float|string
@@ -84,7 +84,7 @@ public static function AVERAGEIFS(mixed ...$args): null|int|float|string
      *        COUNTIF(range,condition)
      *
      * @param mixed $range Data values, expect array
-     * @param null|array|string $condition the criteria that defines which cells will be counted
+     * @param null|mixed[]|string $condition the criteria that defines which cells will be counted
      */
     public static function COUNTIF(mixed $range, null|array|string $condition): string|int
     {
@@ -234,15 +234,23 @@ public static function SUMIFS(mixed ...$args): null|float|string
         return DSum::evaluate($database, self::VALUE_COLUMN_NAME, $conditions);
     }
 
-    /** @param array $args */
+    /**
+     * @param mixed[] $args
+     *
+     * @return mixed[][]
+     */
     private static function buildConditionSet(...$args): array
     {
         $conditions = self::buildConditions(1, ...$args);
 
         return array_map(null, ...$conditions);
     }
 
-    /** @param array $args */
+    /**
+     * @param mixed[] $args
+     *
+     * @return mixed[][]
+     */
     private static function buildConditionSetForValueRange(...$args): array
     {
         $conditions = self::buildConditions(2, ...$args);
@@ -257,7 +265,11 @@ private static function buildConditionSetForValueRange(...$args): array
         return array_map(null, ...$conditions);
     }
 
-    /** @param array $args */
+    /**
+     * @param mixed[] $args
+     *
+     * @return mixed[][]
+     */
     private static function buildConditions(int $startOffset, ...$args): array
     {
         $conditions = [];
@@ -272,15 +284,23 @@ private static function buildConditions(int $startOffset, ...$args): array
         return $conditions;
     }
 
-    /** @param array $args */
+    /**
+     * @param mixed[] $args
+     *
+     * @return mixed[]
+     */
     private static function buildDatabase(...$args): array
     {
         $database = [];
 
         return self::buildDataSet(0, $database, ...$args);
     }
 
-    /** @param array $args */
+    /**
+     * @param mixed[] $args
+     *
+     * @return mixed[]
+     */
     private static function buildDatabaseWithValueRange(...$args): array
     {
         $database = [];
@@ -292,7 +312,12 @@ private static function buildDatabaseWithValueRange(...$args): array
         return self::buildDataSet(1, $database, ...$args);
     }
 
-    /** @param array $args */
+    /**
+     * @param mixed[][] $database
+     * @param mixed[] $args
+     *
+     * @return mixed[]
+     */
     private static function buildDataSet(int $startOffset, array $database, ...$args): array
     {
         $pairCount = 1;
@@ -308,6 +333,12 @@ private static function buildDataSet(int $startOffset, array $database, ...$args
         return array_map(null, ...$database);
     }
 
+    /**
+     * @param mixed[] $range
+     * @param mixed[] $valueRange
+     *
+     * @return mixed[]
+     */
     private static function databaseFromRangeAndValue(array $range, array $valueRange = []): array
     {
         $range = Functions::flattenArray($range);

src/PhpSpreadsheet/Calculation/Statistical/Confidence.php

@@ -23,7 +23,7 @@ class Confidence
      * @param mixed $size As an integer
      *                      Or can be an array of values
      *
-     * @return array|float|string If an array of numbers is passed as an argument, then the returned result will also be an array
+     * @return array<mixed>|float|string If an array of numbers is passed as an argument, then the returned result will also be an array
      *            with the same dimensions
      */
     public static function CONFIDENCE(mixed $alpha, mixed $stdDev, mixed $size)

src/PhpSpreadsheet/Calculation/Statistical/Deviations.php

@@ -55,7 +55,7 @@ public static function sumSquares(mixed ...$args): string|float
      * kurtosis indicates a relatively peaked distribution. Negative kurtosis indicates a
      * relatively flat distribution.
      *
-     * @param array ...$args Data Series
+     * @param mixed[] ...$args Data Series
      */
     public static function kurtosis(...$args): string|int|float
     {
@@ -98,7 +98,7 @@ public static function kurtosis(...$args): string|int|float
      * asymmetric tail extending toward more positive values. Negative skewness indicates a
      * distribution with an asymmetric tail extending toward more negative values.
      *
-     * @param array ...$args Data Series
+     * @param mixed[] ...$args Data Series
      *
      * @return float|int|string The result, or a string containing an error
      */

src/PhpSpreadsheet/Calculation/Statistical/Distributions/Beta.php

@@ -33,7 +33,7 @@ class Beta
      * @param mixed $rMax as an float
      *                      Or can be an array of values
      *
-     * @return array|float|string If an array of numbers is passed as an argument, then the returned result will also be an array
+     * @return array<mixed>|float|string If an array of numbers is passed as an argument, then the returned result will also be an array
      *            with the same dimensions
      */
     public static function distribution(mixed $value, mixed $alpha, mixed $beta, mixed $rMin = 0.0, mixed $rMax = 1.0): array|string|float
@@ -86,7 +86,7 @@ public static function distribution(mixed $value, mixed $alpha, mixed $beta, mix
      * @param mixed $rMax Maximum value as a float
      *                      Or can be an array of values
      *
-     * @return array|float|string If an array of numbers is passed as an argument, then the returned result will also be an array
+     * @return array<mixed>|float|string If an array of numbers is passed as an argument, then the returned result will also be an array
      *            with the same dimensions
      */
     public static function inverse(mixed $probability, mixed $alpha, mixed $beta, mixed $rMin = 0.0, mixed $rMax = 1.0): array|string|float

src/PhpSpreadsheet/Calculation/Statistical/Distributions/Binomial.php

@@ -30,7 +30,7 @@ class Binomial
      * @param mixed $cumulative Boolean value indicating if we want the cdf (true) or the pdf (false)
      *                      Or can be an array of values
      *
-     * @return array|float|string If an array of numbers is passed as an argument, then the returned result will also be an array
+     * @return array<mixed>|float|string If an array of numbers is passed as an argument, then the returned result will also be an array
      *            with the same dimensions
      */
     public static function distribution(mixed $value, mixed $trials, mixed $probability, mixed $cumulative)
@@ -78,7 +78,7 @@ public static function distribution(mixed $value, mixed $trials, mixed $probabil
      *                           If null, then this will indicate the same as the number of Successes
      *                      Or can be an array of values
      *
-     * @return array|float|int|string If an array of numbers is passed as an argument, then the returned result will also be an array
+     * @return array<mixed>|float|int|string If an array of numbers is passed as an argument, then the returned result will also be an array
      *            with the same dimensions
      */
     public static function range(mixed $trials, mixed $probability, mixed $successes, mixed $limit = null): array|string|float|int
@@ -132,7 +132,7 @@ public static function range(mixed $trials, mixed $probability, mixed $successes
      * @param mixed $probability Probability of success on each trial as a float
      *                      Or can be an array of values
      *
-     * @return array|float|string The result, or a string containing an error
+     * @return array<mixed>|float|string The result, or a string containing an error
      *         If an array of numbers is passed as an argument, then the returned result will also be an array
      *            with the same dimensions
      *
@@ -181,7 +181,7 @@ public static function negative(mixed $failures, mixed $successes, mixed $probab
      * @param mixed $alpha criterion value as a float
      *                      Or can be an array of values
      *
-     * @return array|int|string If an array of numbers is passed as an argument, then the returned result will also be an array
+     * @return array<mixed>|int|string If an array of numbers is passed as an argument, then the returned result will also be an array
      *            with the same dimensions
      */
     public static function inverse(mixed $trials, mixed $probability, mixed $alpha): array|string|int

src/PhpSpreadsheet/Calculation/Statistical/Distributions/ChiSquared.php

@@ -23,7 +23,7 @@ class ChiSquared
      * @param mixed $degrees Integer degrees of freedom
      *                      Or can be an array of values
      *
-     * @return array|float|int|string If an array of numbers is passed as an argument, then the returned result will also be an array
+     * @return array<mixed>|float|int|string If an array of numbers is passed as an argument, then the returned result will also be an array
      *            with the same dimensions
      */
     public static function distributionRightTail(mixed $value, mixed $degrees): array|string|int|float
@@ -65,7 +65,7 @@ public static function distributionRightTail(mixed $value, mixed $degrees): arra
      * @param mixed $cumulative Boolean value indicating if we want the cdf (true) or the pdf (false)
      *                      Or can be an array of values
      *
-     * @return array|float|int|string If an array of numbers is passed as an argument, then the returned result will also be an array
+     * @return array<mixed>|float|int|string If an array of numbers is passed as an argument, then the returned result will also be an array
      *            with the same dimensions
      */
     public static function distributionLeftTail(mixed $value, mixed $degrees, mixed $cumulative): array|string|int|float
@@ -113,7 +113,7 @@ public static function distributionLeftTail(mixed $value, mixed $degrees, mixed
      * @param mixed $degrees Integer degrees of freedom
      *                      Or can be an array of values
      *
-     * @return array|float|string If an array of numbers is passed as an argument, then the returned result will also be an array
+     * @return array<mixed>|float|string If an array of numbers is passed as an argument, then the returned result will also be an array
      *            with the same dimensions
      */
     public static function inverseRightTail(mixed $probability, mixed $degrees)
@@ -133,7 +133,7 @@ public static function inverseRightTail(mixed $probability, mixed $degrees)
             return ExcelError::NAN();
         }
 
-        $callback = fn ($value): float => 1 - (Gamma::incompleteGamma($degrees / 2, $value / 2)
+        $callback = fn (float $value): float => 1 - (Gamma::incompleteGamma($degrees / 2, $value / 2)
                     / Gamma::gammaValue($degrees / 2));
 
         $newtonRaphson = new NewtonRaphson($callback);
@@ -151,7 +151,7 @@ public static function inverseRightTail(mixed $probability, mixed $degrees)
      * @param mixed $degrees Integer degrees of freedom
      *                      Or can be an array of values
      *
-     * @return array|float|string If an array of numbers is passed as an argument, then the returned result will also be an array
+     * @return array<mixed>|float|string If an array of numbers is passed as an argument, then the returned result will also be an array
      *            with the same dimensions
      */
     public static function inverseLeftTail(mixed $probability, mixed $degrees): array|string|float
@@ -181,13 +181,15 @@ public static function inverseLeftTail(mixed $probability, mixed $degrees): arra
      *      (of observed and expected frequencies), are likely to be simply due to sampling error,
      *      or if they are likely to be real.
      *
-     * @param array $actual an array of observed frequencies
-     * @param array $expected an array of expected frequencies
+     * @param float[] $actual an array of observed frequencies
+     * @param float[] $expected an array of expected frequencies
      */
     public static function test($actual, $expected): float|string
     {
         $rows = count($actual);
+        /** @var float[] */
         $actual = Functions::flattenArray($actual);
+        /** @var float[] */
         $expected = Functions::flattenArray($expected);
         $columns = intdiv(count($actual), $rows);
 

src/PhpSpreadsheet/Calculation/Statistical/Distributions/Exponential.php

@@ -24,7 +24,7 @@ class Exponential
      * @param mixed $cumulative Boolean value indicating if we want the cdf (true) or the pdf (false)
      *                      Or can be an array of values
      *
-     * @return array|float|string If an array of numbers is passed as an argument, then the returned result will also be an array
+     * @return array<mixed>|float|string If an array of numbers is passed as an argument, then the returned result will also be an array
      *            with the same dimensions
      */
     public static function distribution(mixed $value, mixed $lambda, mixed $cumulative): array|string|float