Merge pull request #4463 from oleibman/stan1005

More Phpstan 10 Prep

Author: oleibman

phpstan-baseline.neon

@@ -1,2 +1,2 @@
 parameters:
-	ignoreErrors: []
+	ignoreErrors:

src/PhpSpreadsheet/Calculation/Calculation.php

@@ -18,7 +18,7 @@ class CaseConvert
      * @param mixed $mixedCaseValue The string value to convert to lower case
      *                              Or can be an array of values
      *
-     * @return array|string If an array of values is passed as the argument, then the returned result will also be an array
+     * @return array<mixed>|string If an array of values is passed as the argument, then the returned result will also be an array
      *            with the same dimensions
      */
     public static function lower(mixed $mixedCaseValue): array|string
@@ -44,7 +44,7 @@ public static function lower(mixed $mixedCaseValue): array|string
      * @param mixed $mixedCaseValue The string value to convert to upper case
      *                              Or can be an array of values
      *
-     * @return array|string If an array of values is passed as the argument, then the returned result will also be an array
+     * @return array<mixed>|string If an array of values is passed as the argument, then the returned result will also be an array
      *            with the same dimensions
      */
     public static function upper(mixed $mixedCaseValue): array|string
@@ -70,7 +70,7 @@ public static function upper(mixed $mixedCaseValue): array|string
      * @param mixed $mixedCaseValue The string value to convert to title case
      *                              Or can be an array of values
      *
-     * @return array|string If an array of values is passed as the argument, then the returned result will also be an array
+     * @return array<mixed>|string If an array of values is passed as the argument, then the returned result will also be an array
      *            with the same dimensions
      */
     public static function proper(mixed $mixedCaseValue): array|string

src/PhpSpreadsheet/Calculation/TextData/CaseConvert.php

@@ -17,7 +17,7 @@ class CharacterConvert
      * @param mixed $character Integer Value to convert to its character representation
      *                              Or can be an array of values
      *
-     * @return array|string The character string
+     * @return array<mixed>|string The character string
      *         If an array of values is passed as the argument, then the returned result will also be an array
      *            with the same dimensions
      */
@@ -48,7 +48,7 @@ public static function character(mixed $character): array|string
      * @param mixed $characters String character to convert to its ASCII value
      *                              Or can be an array of values
      *
-     * @return array|int|string A string if arguments are invalid
+     * @return array<mixed>|int|string A string if arguments are invalid
      *         If an array of values is passed as the argument, then the returned result will also be an array
      *            with the same dimensions
      */

src/PhpSpreadsheet/Calculation/TextData/CharacterConvert.php

@@ -17,7 +17,7 @@ class Concatenate
     /**
      * This implements the CONCAT function, *not* CONCATENATE.
      *
-     * @param array $args
+     * @param mixed[] $args
      */
     public static function CONCATENATE(...$args): string
     {
@@ -47,7 +47,9 @@ public static function CONCATENATE(...$args): string
     /**
      * This implements the CONCATENATE function.
      *
-     * @param array $args data to be concatenated
+     * @param mixed[] $args data to be concatenated
+     *
+     * @return array<string>|string
      */
     public static function actualCONCATENATE(...$args): array|string
     {
@@ -65,6 +67,12 @@ public static function actualCONCATENATE(...$args): array|string
         return $result;
     }
 
+    /**
+     * @param array<string>|string $operand1
+     * @param null|array<mixed>|bool|float|int|string $operand2
+     *
+     * @return array<string>|string
+     */
     private static function concatenate2Args(array|string $operand1, null|array|bool|float|int|string $operand2): array|string
     {
         if (is_array($operand1) || is_array($operand2)) {
@@ -74,9 +82,11 @@ private static function concatenate2Args(array|string $operand1, null|array|bool
             $errorFound = false;
             for ($row = 0; $row < $rows && !$errorFound; ++$row) {
                 for ($column = 0; $column < $columns; ++$column) {
+                    /** @var string[][] $operand2 */
                     if (ErrorValue::isError($operand2[$row][$column])) {
                         return $operand2[$row][$column];
                     }
+                    /** @var string[][] $operand1 */
                     $operand1[$row][$column]
                         = StringHelper::convertToString($operand1[$row][$column], convertBool: true)
                         . StringHelper::convertToString($operand2[$row][$column], convertBool: true);
@@ -96,6 +106,7 @@ private static function concatenate2Args(array|string $operand1, null|array|bool
                 $operand1 = ExcelError::CALC();
             }
         }
+        /** @var array<string>|string $operand1 */
 
         return $operand1;
     }
@@ -109,7 +120,7 @@ private static function concatenate2Args(array|string $operand1, null|array|bool
      *                         Or can be an array of values
      * @param mixed $args The values to join
      *
-     * @return array|string The joined string
+     * @return array<mixed>|string The joined string
      *         If an array of values is passed for the $delimiter or $ignoreEmpty arguments, then the returned result
      *            will also be an array with matching dimensions
      */
@@ -127,7 +138,7 @@ public static function TEXTJOIN($delimiter = '', $ignoreEmpty = true, mixed ...$
 
         $delimiter ??= '';
         $ignoreEmpty ??= true;
-        /** @var array */
+        /** @var mixed[] */
         $aArgs = Functions::flattenArray($args);
         $returnValue = self::evaluateTextJoinArray($ignoreEmpty, $aArgs);
 
@@ -139,6 +150,7 @@ public static function TEXTJOIN($delimiter = '', $ignoreEmpty = true, mixed ...$
         return $returnValue;
     }
 
+    /** @param mixed[] $aArgs */
     private static function evaluateTextJoinArray(bool $ignoreEmpty, array &$aArgs): ?string
     {
         foreach ($aArgs as $key => &$arg) {
@@ -167,7 +179,7 @@ private static function evaluateTextJoinArray(bool $ignoreEmpty, array &$aArgs):
      * @param mixed $repeatCount The number of times the string value should be repeated
      *                         Or can be an array of values
      *
-     * @return array|string The repeated string
+     * @return array<mixed>|string The repeated string
      *         If an array of values is passed for the $stringValue or $repeatCount arguments, then the returned result
      *            will also be an array with matching dimensions
      */

src/PhpSpreadsheet/Calculation/TextData/Concatenate.php

@@ -20,7 +20,7 @@ class Extract
      * @param mixed $chars The number of characters to extract (as an integer)
      *                         Or can be an array of values
      *
-     * @return array|string The joined string
+     * @return array<mixed>|string The joined string
      *         If an array of values is passed for the $value or $chars arguments, then the returned result
      *            will also be an array with matching dimensions
      */
@@ -50,7 +50,7 @@ public static function left(mixed $value, mixed $chars = 1): array|string
      * @param mixed $chars The number of characters to extract (as an integer)
      *                         Or can be an array of values
      *
-     * @return array|string The joined string
+     * @return array<mixed>|string The joined string
      *         If an array of values is passed for the $value, $start or $chars arguments, then the returned result
      *            will also be an array with matching dimensions
      */
@@ -79,7 +79,7 @@ public static function mid(mixed $value, mixed $start, mixed $chars): array|stri
      * @param mixed $chars The number of characters to extract (as an integer)
      *                         Or can be an array of values
      *
-     * @return array|string The joined string
+     * @return array<mixed>|string The joined string
      *         If an array of values is passed for the $value or $chars arguments, then the returned result
      *            will also be an array with matching dimensions
      */
@@ -104,7 +104,7 @@ public static function right(mixed $value, mixed $chars = 1): array|string
      *
      * @param mixed $text the text that you're searching
      *                    Or can be an array of values
-     * @param null|array|string $delimiter the text that marks the point before which you want to extract
+     * @param null|array<string>|string $delimiter the text that marks the point before which you want to extract
      *                                 Multiple delimiters can be passed as an array of string values
      * @param mixed $instance The instance of the delimiter after which you want to extract the text.
      *                            By default, this is the first instance (1).
@@ -118,11 +118,11 @@ public static function right(mixed $value, mixed $chars = 1): array|string
      *                          0 - Don't match the delimiter against the end of the text.
      *                          1 - Match the delimiter against the end of the text.
      *                        Or can be an array of values
-     * @param mixed $ifNotFound value to return if no match is found
+     * @param array<string>|bool|float|int|string $ifNotFound value to return if no match is found
      *                             The default is a #N/A Error
      *                          Or can be an array of values
      *
-     * @return array|string the string extracted from text before the delimiter; or the $ifNotFound value
+     * @return array<mixed>|string the string extracted from text before the delimiter; or the $ifNotFound value
      *         If an array of values is passed for any of the arguments, then the returned result
      *            will also be an array with matching dimensions
      */
@@ -168,7 +168,7 @@ public static function before(mixed $text, $delimiter, mixed $instance = 1, mixe
      * TEXTAFTER.
      *
      * @param mixed $text the text that you're searching
-     * @param null|array|string $delimiter the text that marks the point before which you want to extract
+     * @param null|array<string>|string $delimiter the text that marks the point before which you want to extract
      *                                 Multiple delimiters can be passed as an array of string values
      * @param mixed $instance The instance of the delimiter after which you want to extract the text.
      *                          By default, this is the first instance (1).
@@ -182,11 +182,11 @@ public static function before(mixed $text, $delimiter, mixed $instance = 1, mixe
      *                          0 - Don't match the delimiter against the end of the text.
      *                          1 - Match the delimiter against the end of the text.
      *                        Or can be an array of values
-     * @param mixed $ifNotFound value to return if no match is found
+     * @param array<string>|scalar $ifNotFound value to return if no match is found
      *                             The default is a #N/A Error
      *                          Or can be an array of values
      *
-     * @return array|string the string extracted from text before the delimiter; or the $ifNotFound value
+     * @return array<mixed>|string the string extracted from text before the delimiter; or the $ifNotFound value
      *         If an array of values is passed for any of the arguments, then the returned result
      *            will also be an array with matching dimensions
      */
@@ -228,6 +228,12 @@ public static function after(mixed $text, $delimiter, mixed $instance = 1, mixed
         return implode('', $split);
     }
 
+    /**
+     * @param null|array<string>|string $delimiter
+     * @param array<string>|scalar $ifNotFound
+     *
+     * @return array<string>|string
+     */
     private static function validateTextBeforeAfter(string $text, null|array|string $delimiter, int $instance, int $matchMode, int $matchEnd, mixed $ifNotFound): array|string
     {
         $flags = self::matchFlags($matchMode);
@@ -256,7 +262,7 @@ private static function validateTextBeforeAfter(string $text, null|array|string
     }
 
     /**
-     * @param null|array|string $delimiter the text that marks the point before which you want to extract
+     * @param null|array<string>|string $delimiter the text that marks the point before which you want to extract
      *                                 Multiple delimiters can be passed as an array of string values
      */
     private static function buildDelimiter($delimiter): string

src/PhpSpreadsheet/Calculation/TextData/Extract.php

@@ -34,7 +34,7 @@ class Format
      *                            If you omit decimals, it is assumed to be 2
      *                         Or can be an array of values
      *
-     * @return array|string If an array of values is passed for either of the arguments, then the returned result
+     * @return array<mixed>|string If an array of values is passed for either of the arguments, then the returned result
      *            will also be an array with matching dimensions
      */
     public static function DOLLAR(mixed $value = 0, mixed $decimals = 2)
@@ -76,7 +76,7 @@ public static function DOLLAR(mixed $value = 0, mixed $decimals = 2)
      * @param mixed $noCommas Boolean value indicating whether the value should have thousands separators or not
      *                         Or can be an array of values
      *
-     * @return array|string If an array of values is passed for either of the arguments, then the returned result
+     * @return array<mixed>|string If an array of values is passed for either of the arguments, then the returned result
      *            will also be an array with matching dimensions
      */
     public static function FIXEDFORMAT(mixed $value, mixed $decimals = 2, mixed $noCommas = false): array|string
@@ -116,7 +116,7 @@ public static function FIXEDFORMAT(mixed $value, mixed $decimals = 2, mixed $noC
      * @param mixed $format A string with the Format mask that should be used
      *                         Or can be an array of values
      *
-     * @return array|string If an array of values is passed for either of the arguments, then the returned result
+     * @return array<mixed>|string If an array of values is passed for either of the arguments, then the returned result
      *            will also be an array with matching dimensions
      */
     public static function TEXTFORMAT(mixed $value, mixed $format): array|string
@@ -176,7 +176,7 @@ private static function convertValue(mixed $value, bool $spacesMeanZero = false)
      * @param mixed $value Value to check
      *                         Or can be an array of values
      *
-     * @return array|DateTimeInterface|float|int|string A string if arguments are invalid
+     * @return array<mixed>|DateTimeInterface|float|int|string A string if arguments are invalid
      *         If an array of values is passed for the argument, then the returned result
      *            will also be an array with matching dimensions
      */
@@ -236,7 +236,7 @@ public static function VALUE(mixed $value = '')
      * @param mixed $value The value to format
      *                         Or can be an array of values
      *
-     * @return array|string If an array of values is passed for either of the arguments, then the returned result
+     * @return array<mixed>|string If an array of values is passed for either of the arguments, then the returned result
      *            will also be an array with matching dimensions
      */
     public static function valueToText(mixed $value, mixed $format = false): array|string
@@ -279,6 +279,8 @@ private static function getGroupSeparator(mixed $groupSeparator): string
      *                         Or can be an array of values
      * @param mixed $groupSeparator A string with the group/thousands separator to use, defaults to locale defined value
      *                         Or can be an array of values
+     *
+     * @return array<mixed>|float|string
      */
     public static function NUMBERVALUE(mixed $value = '', mixed $decimalSeparator = null, mixed $groupSeparator = null): array|string|float
     {
@@ -294,7 +296,7 @@ public static function NUMBERVALUE(mixed $value = '', mixed $decimalSeparator =
             return $e->getMessage();
         }
 
-        /** @var null|array|scalar $value */
+        /** @var null|array<scalar>|scalar $value */
         if (!is_array($value) && !is_numeric($value)) {
             $value = StringHelper::convertToString($value);
             $decimalPositions = Preg::matchAllWithOffsets('/' . preg_quote($decimalSeparator, '/') . '/', $value, $matches);

src/PhpSpreadsheet/Calculation/TextData/Format.php

@@ -25,7 +25,7 @@ class Replace
      * @param mixed $newText String to replace in the defined position
      *                         Or can be an array of values
      *
-     * @return array|string If an array of values is passed for either of the arguments, then the returned result
+     * @return array<mixed>|string If an array of values is passed for either of the arguments, then the returned result
      *            will also be an array with matching dimensions
      */
     public static function replace(mixed $oldText, mixed $start, mixed $chars, mixed $newText): array|string
@@ -65,7 +65,7 @@ public static function replace(mixed $oldText, mixed $start, mixed $chars, mixed
      * @param mixed $instance Integer instance Number for the occurrence of frmText to change
      *                         Or can be an array of values
      *
-     * @return array|string If an array of values is passed for either of the arguments, then the returned result
+     * @return array<mixed>|string If an array of values is passed for either of the arguments, then the returned result
      *            will also be an array with matching dimensions
      */
     public static function substitute(mixed $text = '', mixed $fromText = '', mixed $toText = '', mixed $instance = null): array|string

src/PhpSpreadsheet/Calculation/TextData/Replace.php

@@ -21,7 +21,7 @@ class Search
      * @param mixed $offset Integer offset within $haystack to start searching from
      *                         Or can be an array of values
      *
-     * @return array|int|string The offset where the first occurrence of needle was found in the haystack
+     * @return array<mixed>|int|string The offset where the first occurrence of needle was found in the haystack
      *         If an array of values is passed for the $value or $chars arguments, then the returned result
      *            will also be an array with matching dimensions
      */
@@ -63,7 +63,7 @@ public static function sensitive(mixed $needle, mixed $haystack, mixed $offset =
      * @param mixed $offset Integer offset within $haystack to start searching from
      *                         Or can be an array of values
      *
-     * @return array|int|string The offset where the first occurrence of needle was found in the haystack
+     * @return array<mixed>|int|string The offset where the first occurrence of needle was found in the haystack
      *         If an array of values is passed for the $value or $chars arguments, then the returned result
      *            will also be an array with matching dimensions
      */