Remove all mixed in return type where possible

phpstan.neon.dist

@@ -23,6 +23,7 @@ parameters:
     parallel:
         processTimeout: 300.0
     checkMissingIterableValueType: false
+    checkGenericClassInNonGenericObjectType: false
     ignoreErrors:
         # Accept a bit anything for assert methods
         - '~^Parameter \#2 .* of static method PHPUnit\\Framework\\Assert\:\:assert\w+\(\) expects .*, .* given\.$~'

src/PhpSpreadsheet/Calculation/Calculation.php

@@ -195,7 +195,7 @@ public static function getLocaleBoolean(string $index): string
      * Excel constant string translations to their PHP equivalents
      * Constant conversion from text name/value to actual (datatyped) value.
      *
-     * @var array<string, mixed>
+     * @var array<string, null|bool>
      */
     private static array $excelConstants = [
         'TRUE' => true,
@@ -208,7 +208,7 @@ public static function keyInExcelConstants(string $key): bool
         return array_key_exists($key, self::$excelConstants);
     }
 
-    public static function getExcelConstants(string $key): mixed
+    public static function getExcelConstants(string $key): bool|null
     {
         return self::$excelConstants[$key];
     }

src/PhpSpreadsheet/Calculation/Database/DatabaseAbstract.php

@@ -156,7 +156,7 @@ private static function executeQuery(array $database, string $query, array $crit
         return $database;
     }
 
-    private static function processCondition(string $criterion, array $fields, array $dataValues, string $conditions): mixed
+    private static function processCondition(string $criterion, array $fields, array $dataValues, string $conditions): string
     {
         $key = array_search($criterion, $fields, true);
 

src/PhpSpreadsheet/Calculation/DateTimeExcel/Current.php

@@ -2,6 +2,7 @@
 
 namespace PhpOffice\PhpSpreadsheet\Calculation\DateTimeExcel;
 
+use DateTime;
 use DateTimeImmutable;
 use PhpOffice\PhpSpreadsheet\Calculation\Information\ExcelError;
 
@@ -21,10 +22,10 @@ class Current
      * Excel Function:
      *        TODAY()
      *
-     * @return mixed Excel date/time serial value, PHP date/time serial value or PHP date/time object,
+     * @return DateTime|float|int|string Excel date/time serial value, PHP date/time serial value or PHP date/time object,
      *                        depending on the value of the ReturnDateType flag
      */
-    public static function today(): mixed
+    public static function today(): DateTime|float|int|string
     {
         $dti = new DateTimeImmutable();
         $dateArray = Helpers::dateParse($dti->format('c'));
@@ -46,10 +47,10 @@ public static function today(): mixed
      * Excel Function:
      *        NOW()
      *
-     * @return mixed Excel date/time serial value, PHP date/time serial value or PHP date/time object,
+     * @return DateTime|float|int|string Excel date/time serial value, PHP date/time serial value or PHP date/time object,
      *                        depending on the value of the ReturnDateType flag
      */
-    public static function now(): mixed
+    public static function now(): DateTime|float|int|string
     {
         $dti = new DateTimeImmutable();
         $dateArray = Helpers::dateParse($dti->format('c'));

src/PhpSpreadsheet/Calculation/DateTimeExcel/Date.php

@@ -2,6 +2,7 @@
 
 namespace PhpOffice\PhpSpreadsheet\Calculation\DateTimeExcel;
 
+use DateTime;
 use PhpOffice\PhpSpreadsheet\Calculation\ArrayEnabled;
 use PhpOffice\PhpSpreadsheet\Calculation\Exception;
 use PhpOffice\PhpSpreadsheet\Calculation\Information\ExcelError;
@@ -58,12 +59,12 @@ class Date
      *                                example, DATE(2008,1,-15) returns the serial number representing
      *                                December 16, 2007.
      *
-     * @return mixed Excel date/time serial value, PHP date/time serial value or PHP date/time object,
+     * @return array|DateTime|float|int|string Excel date/time serial value, PHP date/time serial value or PHP date/time object,
      *                        depending on the value of the ReturnDateType flag
      *         If an array of numbers is passed as the argument, then the returned result will also be an array
      *            with the same dimensions
      */
-    public static function fromYMD(array|float|int|string $year, array|float|int|string $month, array|float|int|string $day): mixed
+    public static function fromYMD(array|float|int|string $year, array|float|int|string $month, array|float|int|string $day): float|int|DateTime|string|array
     {
         if (is_array($year) || is_array($month) || is_array($day)) {
             return self::evaluateArrayArguments([self::class, __FUNCTION__], $year, $month, $day);

src/PhpSpreadsheet/Calculation/DateTimeExcel/DateValue.php

@@ -2,6 +2,7 @@
 
 namespace PhpOffice\PhpSpreadsheet\Calculation\DateTimeExcel;
 
+use DateTime;
 use DateTimeImmutable;
 use PhpOffice\PhpSpreadsheet\Calculation\ArrayEnabled;
 use PhpOffice\PhpSpreadsheet\Calculation\Information\ExcelError;
@@ -34,12 +35,12 @@ class DateValue
      *                                    #VALUE! error value if date_text is out of this range.
      *                         Or can be an array of date values
      *
-     * @return mixed Excel date/time serial value, PHP date/time serial value or PHP date/time object,
+     * @return array|DateTime|float|int|string Excel date/time serial value, PHP date/time serial value or PHP date/time object,
      *                        depending on the value of the ReturnDateType flag
      *         If an array of numbers is passed as the argument, then the returned result will also be an array
      *            with the same dimensions
      */
-    public static function fromString(null|array|string|int|bool|float $dateValue): mixed
+    public static function fromString(null|array|string|int|bool|float $dateValue): array|string|float|int|DateTime
     {
         if (is_array($dateValue)) {
             return self::evaluateSingleArgumentArray([self::class, __FUNCTION__], $dateValue);
@@ -131,10 +132,10 @@ private static function setUpArray(string $dateValue, DateTimeImmutable $dti): a
     /**
      * Final results.
      *
-     * @return mixed Excel date/time serial value, PHP date/time serial value or PHP date/time object,
+     * @return DateTime|float|int|string Excel date/time serial value, PHP date/time serial value or PHP date/time object,
      *                        depending on the value of the ReturnDateType flag
      */
-    private static function finalResults(array $PHPDateArray, DateTimeImmutable $dti, int $baseYear): mixed
+    private static function finalResults(array $PHPDateArray, DateTimeImmutable $dti, int $baseYear): string|float|int|DateTime
     {
         $retValue = ExcelError::Value();
         if (Helpers::dateParseSucceeded($PHPDateArray)) {

src/PhpSpreadsheet/Calculation/DateTimeExcel/Helpers.php

@@ -58,12 +58,13 @@ public static function getDateValue(mixed $dateValue, bool $allowBool = true): f
     /**
      * getTimeValue.
      *
-     * @return mixed Excel date/time serial value, or string if error
+     * @return float|string Excel date/time serial value, or string if error
      */
-    public static function getTimeValue(string $timeValue): mixed
+    public static function getTimeValue(string $timeValue): string|float
     {
         $saveReturnDateType = Functions::getReturnDateType();
         Functions::setReturnDateType(Functions::RETURNDATE_EXCEL);
+        /** @var float|string $timeValue */
         $timeValue = TimeValue::fromString($timeValue);
         Functions::setReturnDateType($saveReturnDateType);
 
@@ -238,6 +239,8 @@ public static function validateNumericNull(mixed $number): int|float
 
     /**
      * Many functions accept null/false/true argument treated as 0/0/1.
+     *
+     * @phpstan-assert float $number
      */
     public static function validateNotNegative(mixed $number): float
     {

src/PhpSpreadsheet/Calculation/DateTimeExcel/Month.php

@@ -73,12 +73,12 @@ public static function adjust(mixed $dateValue, array|string|bool|float|int $adj
      *                                        a negative value yields a past date.
      *                         Or can be an array of adjustment values
      *
-     * @return array|mixed Excel date/time serial value, PHP date/time serial value or PHP date/time object,
+     * @return array|DateTime|float|int|string Excel date/time serial value, PHP date/time serial value or PHP date/time object,
      *                        depending on the value of the ReturnDateType flag
      *         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 lastDay(mixed $dateValue, array|float|int|bool|string $adjustmentMonths): mixed
+    public static function lastDay(mixed $dateValue, array|float|int|bool|string $adjustmentMonths): array|string|DateTime|float|int
     {
         if (is_array($dateValue) || is_array($adjustmentMonths)) {
             return self::evaluateArrayArguments([self::class, __FUNCTION__], $dateValue, $adjustmentMonths);

src/PhpSpreadsheet/Calculation/DateTimeExcel/WorkDay.php

@@ -31,12 +31,12 @@ class WorkDay
      *                         Or can be an array of int values
      * @param null|mixed $dateArgs An array of dates (such as holidays) to exclude from the calculation
      *
-     * @return array|mixed Excel date/time serial value, PHP date/time serial value or PHP date/time object,
+     * @return array|DateTime|float|int|string Excel date/time serial value, PHP date/time serial value or PHP date/time object,
      *                        depending on the value of the ReturnDateType flag
      *         If an array of values is passed for the $startDate or $endDays,arguments, then the returned result
      *            will also be an array with matching dimensions
      */
-    public static function date(mixed $startDate, array|int|string $endDays, mixed ...$dateArgs): mixed
+    public static function date(mixed $startDate, array|int|string $endDays, mixed ...$dateArgs): array|float|int|DateTime|string
     {
         if (is_array($startDate) || is_array($endDays)) {
             return self::evaluateArrayArgumentsSubset(

src/PhpSpreadsheet/Calculation/Functions.php

@@ -277,7 +277,7 @@ public static function flattenArrayIndexed($array): array
      *
      * @param mixed $value Array or scalar value
      */
-    public static function flattenSingleValue(mixed $value = ''): mixed
+    public static function flattenSingleValue(mixed $value): mixed
     {
         while (is_array($value)) {
             $value = array_shift($value);

src/PhpSpreadsheet/Calculation/LookupRef/Hyperlink.php

@@ -18,9 +18,9 @@ class Hyperlink
      * @param mixed $displayName Expect string. Value to return when testValue is an error condition
      * @param ?Cell $cell The cell to set the hyperlink in
      *
-     * @return mixed The value of $displayName (or $linkURL if $displayName was blank)
+     * @return string The value of $displayName (or $linkURL if $displayName was blank)
      */
-    public static function set(mixed $linkURL = '', mixed $displayName = null, ?Cell $cell = null): mixed
+    public static function set(mixed $linkURL = '', mixed $displayName = null, ?Cell $cell = null): string
     {
         $linkURL = ($linkURL === null) ? '' : Functions::flattenSingleValue($linkURL);
         $displayName = ($displayName === null) ? '' : Functions::flattenSingleValue($displayName);

src/PhpSpreadsheet/Calculation/Statistical/MaxMinBase.php

@@ -4,7 +4,7 @@
 
 abstract class MaxMinBase
 {
-    protected static function datatypeAdjustmentAllowStrings(mixed $value): mixed
+    protected static function datatypeAdjustmentAllowStrings(int|float|string|bool $value): int|float
     {
         if (is_bool($value)) {
             return (int) $value;

src/PhpSpreadsheet/Calculation/Statistical/VarianceBase.php

@@ -6,7 +6,7 @@
 
 abstract class VarianceBase
 {
-    protected static function datatypeAdjustmentAllowStrings(mixed $value): mixed
+    protected static function datatypeAdjustmentAllowStrings(int|float|string|bool $value): int|float
     {
         if (is_bool($value)) {
             return (int) $value;

src/PhpSpreadsheet/Calculation/TextData/Format.php

@@ -126,6 +126,7 @@ public static function TEXTFORMAT(mixed $value, mixed $format): array|string
         $format = Helpers::extractString($format);
 
         if (!is_numeric($value) && Date::isDateTimeFormatCode($format)) {
+            // @phpstan-ignore-next-line
             $value = DateTimeExcel\DateValue::fromString($value) + DateTimeExcel\TimeValue::fromString($value);
         }
 

src/PhpSpreadsheet/Cell/AddressRange.php

@@ -2,6 +2,9 @@
 
 namespace PhpOffice\PhpSpreadsheet\Cell;
 
+/**
+ * @template T
+ */
 interface AddressRange
 {
     public const MAX_ROW = 1048576;
@@ -10,8 +13,14 @@ interface AddressRange
 
     public const MAX_COLUMN_INT = 16384;
 
+    /**
+     * @return T
+     */
     public function from(): mixed;
 
+    /**
+     * @return T
+     */
     public function to(): mixed;
 
     public function __toString(): string;

src/PhpSpreadsheet/Cell/CellRange.php

@@ -6,6 +6,9 @@
 use PhpOffice\PhpSpreadsheet\Worksheet\Worksheet;
 use Stringable;
 
+/**
+ * @implements AddressRange<CellAddress>
+ */
 class CellRange implements AddressRange, Stringable
 {
     protected CellAddress $from;

src/PhpSpreadsheet/Cell/ColumnRange.php

@@ -5,6 +5,9 @@
 use PhpOffice\PhpSpreadsheet\Worksheet\Worksheet;
 use Stringable;
 
+/**
+ * @implements AddressRange<string>
+ */
 class ColumnRange implements AddressRange, Stringable
 {
     protected ?Worksheet $worksheet;

src/PhpSpreadsheet/Cell/RowRange.php

@@ -5,6 +5,9 @@
 use PhpOffice\PhpSpreadsheet\Worksheet\Worksheet;
 use Stringable;
 
+/**
+ * @implements AddressRange<int>
+ */
 class RowRange implements AddressRange, Stringable
 {
     protected ?Worksheet $worksheet;

src/PhpSpreadsheet/Shared/StringHelper.php

@@ -636,9 +636,9 @@ public static function SYLKtoUTF8(string $textValue): string
      * Retrieve any leading numeric part of a string, or return the full string if no leading numeric
      * (handles basic integer or float, but not exponent or non decimal).
      *
-     * @return mixed string or only the leading numeric part of the string
+     * @return float|string string or only the leading numeric part of the string
      */
-    public static function testStringAsNumeric(string $textValue): mixed
+    public static function testStringAsNumeric(string $textValue): float|string
     {
         if (is_numeric($textValue)) {
             return $textValue;

src/PhpSpreadsheet/Style/ConditionalFormatting/ConditionalFormatValueObject.php

@@ -8,9 +8,9 @@ class ConditionalFormatValueObject
 
     private null|float|int|string $value;
 
-    private mixed $cellFormula;
+    private ?string $cellFormula;
 
-    public function __construct(string $type, null|float|int|string $value = null, mixed $cellFormula = null)
+    public function __construct(string $type, null|float|int|string $value = null, ?string $cellFormula = null)
     {
         $this->type = $type;
         $this->value = $value;
@@ -41,12 +41,12 @@ public function setValue(null|float|int|string $value): self
         return $this;
     }
 
-    public function getCellFormula(): mixed
+    public function getCellFormula(): ?string
     {
         return $this->cellFormula;
     }
 
-    public function setCellFormula(mixed $cellFormula): self
+    public function setCellFormula(?string $cellFormula): self
     {
         $this->cellFormula = $cellFormula;
 

src/PhpSpreadsheet/Style/ConditionalFormatting/ConditionalFormattingRuleExtension.php

@@ -162,12 +162,12 @@ private static function parseExtDataBarElementChildrenFromXml(ConditionalDataBar
         }
     }
 
-    public function getId(): mixed
+    public function getId(): string
     {
         return $this->id;
     }
 
-    public function setId(mixed $id): self
+    public function setId(string $id): self
     {
         $this->id = $id;
 

src/PhpSpreadsheet/Writer/Xls/Parser.php

@@ -1246,9 +1246,9 @@ private function parenthesizedExpression(): array
      * It parses a term. It assumes the following rule:
      * Term -> Fact [("*" | "/") Fact].
      *
-     * @return mixed The parsed ptg'd tree on success
+     * @return array The parsed ptg'd tree on success
      */
-    private function term(): mixed
+    private function term(): array
     {
         $result = $this->fact();
         while (
@@ -1277,9 +1277,9 @@ private function term(): mixed
      *       | Number
      *       | Function.
      *
-     * @return mixed The parsed ptg'd tree on success
+     * @return array The parsed ptg'd tree on success
      */
-    private function fact(): mixed
+    private function fact(): array
     {
         $currentToken = $this->currentToken;
         if ($currentToken === '(') {
@@ -1376,9 +1376,9 @@ private function fact(): mixed
      * It parses a function call. It assumes the following rule:
      * Func -> ( Expr [,Expr]* ).
      *
-     * @return mixed The parsed ptg'd tree on success
+     * @return array The parsed ptg'd tree on success
      */
-    private function func(): mixed
+    private function func(): array
     {
         $num_args = 0; // number of arguments received
         $function = strtoupper($this->currentToken);