Merge pull request PHPOffice#4459 from oleibman/stan1004

More Phpstan Level 10 Prep - Readers and Styles

Author: oleibman

composer.lock

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

phpstan-baseline.neon

@@ -110,7 +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 */
+    /** @param array{0: 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
@@ -131,7 +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 */
+    /** @param array{0: string, 1: ?string, 2: numeric-string, 3: numeric-string} $matches */
     protected function setProperFraction(array $matches, Cell $cell): bool
     {
         // Convert value to number

src/PhpSpreadsheet/Cell/AdvancedValueBinder.php

@@ -497,10 +497,9 @@ public function getCalculatedValue(bool $resetLog = true): mixed
                                 if (isset($matches[3])) {
                                     $minCol = $matches[1];
                                     $minRow = (int) $matches[2];
-                                    // https://github.com/phpstan/phpstan/issues/11602
-                                    $maxCol = $matches[4]; // @phpstan-ignore-line
+                                    $maxCol = $matches[4];
                                     ++$maxCol;
-                                    $maxRow = (int) $matches[5]; // @phpstan-ignore-line
+                                    $maxRow = (int) $matches[5];
                                     for ($row = $minRow; $row <= $maxRow; ++$row) {
                                         for ($col = $minCol; $col !== $maxCol; ++$col) {
                                             if ("$col$row" !== $coordinate) {

src/PhpSpreadsheet/Cell/Cell.php

@@ -22,7 +22,7 @@ class ChartColor
     private ?int $brightness = null;
 
     /**
-     * @param string|string[] $value
+     * @param array{value: ?string, alpha: null|int|string, brightness?: null|int|string, type: ?string}|string  $value
      */
     public function __construct($value = '', ?int $alpha = null, ?string $type = null, ?int $brightness = null)
     {
@@ -114,6 +114,7 @@ public function setColorProperties(?string $color, null|float|int|string $alpha
         return $this;
     }
 
+    /** @param array{value: ?string, alpha: null|int|string, brightness?: null|int|string, type: ?string}  $color */
     public function setColorPropertiesArray(array $color): self
     {
         return $this->setColorProperties(

src/PhpSpreadsheet/Chart/ChartColor.php

@@ -177,6 +177,7 @@ public static function xmlToTenthOfPercent(string $value): float
         return ((float) $value) / self::PERCENTAGE_MULTIPLIER;
     }
 
+    /** @return array{type: ?string, value: ?string, alpha: ?int} */
     protected function setColorProperties(?string $color, null|float|int|string $alpha, ?string $colorType): array
     {
         return [
@@ -506,11 +507,14 @@ public function getSoftEdgesSize(): ?float
         return $this->softEdges['size'];
     }
 
+    /** @param null|array{value?: ?string, alpha?: null|int|string, brightness?: null|int|string, type?: ?string}|float|string  $value */
     public function setShadowProperty(string $propertyName, mixed $value): self
     {
         $this->activateObject();
         if ($propertyName === 'color' && is_array($value)) {
-            $this->shadowColor->setColorPropertiesArray($value);
+            /** @var array{value: ?string, alpha: null|int|string, brightness?: null|int|string, type: ?string} */
+            $valuex = $value;
+            $this->shadowColor->setColorPropertiesArray($valuex);
         } else {
             $this->shadowProperties[$propertyName] = $value;
         }

src/PhpSpreadsheet/Chart/Properties.php

@@ -557,6 +557,7 @@ class Html
     /** @var callable[] */
     protected array $endTagCallbacks;
 
+    /** @var mixed[] */
     private array $stack = [];
 
     public string $stringData = '';
@@ -711,7 +712,10 @@ private function rgbToColour(string $rgbValue): string
 
     public static function colourNameLookup(string $colorName): string
     {
-        return static::COLOUR_MAP[$colorName] ?? '';
+        /** @var string[] */
+        $temp = static::COLOUR_MAP;
+
+        return $temp[$colorName] ?? '';
     }
 
     protected function startFontTag(DOMElement $tag): void

src/PhpSpreadsheet/Helper/Html.php

@@ -241,6 +241,7 @@ public function titles(string $category, string $functionName, ?string $descript
             : $this->log(sprintf('Function: %s() - %s.', rtrim($functionName, '()'), rtrim($description, '.')));
     }
 
+    /** @param mixed[][] $matrix */
     public function displayGrid(array $matrix): void
     {
         $renderer = new TextGrid($matrix, $this->isCli());

src/PhpSpreadsheet/Helper/Sample.php

@@ -8,10 +8,13 @@ class TextGrid
 {
     private bool $isCli;
 
+    /** @var mixed[][] */
     protected array $matrix;
 
+    /** @var int[] */
     protected array $rows;
 
+    /** @var string[] */
     protected array $columns;
 
     private string $gridDisplay;
@@ -22,6 +25,7 @@ class TextGrid
 
     private bool $columnHeaders = true;
 
+    /** @param mixed[][] $matrix */
     public function __construct(array $matrix, bool $isCli = true, bool $rowDividers = false, bool $rowHeaders = true, bool $columnHeaders = true)
     {
         $this->rows = array_keys($matrix);
@@ -63,6 +67,7 @@ public function render(): string
         return $this->gridDisplay;
     }
 
+    /** @param int[] $columnWidths */
     private function renderRows(int $maxRowLength, array $columnWidths): void
     {
         foreach ($this->matrix as $row => $rowData) {
@@ -77,6 +82,10 @@ private function renderRows(int $maxRowLength, array $columnWidths): void
         }
     }
 
+    /**
+     * @param mixed[] $rowData
+     * @param int[] $columnWidths
+     */
     private function renderCells(array $rowData, array $columnWidths): void
     {
         foreach ($rowData as $column => $cell) {
@@ -87,6 +96,7 @@ private function renderCells(array $rowData, array $columnWidths): void
         }
     }
 
+    /** @param int[] $columnWidths */
     private function renderColumnHeader(int $maxRowLength, array &$columnWidths): void
     {
         if (!$this->columnHeaders) {
@@ -95,6 +105,7 @@ private function renderColumnHeader(int $maxRowLength, array &$columnWidths): vo
             return;
         }
         foreach ($this->columns as $column => $reference) {
+            /** @var string $reference */
             $columnWidths[$column] = max($columnWidths[$column], $this->strlen($reference));
         }
         if ($this->rowHeaders) {
@@ -109,13 +120,15 @@ private function renderColumnHeader(int $maxRowLength, array &$columnWidths): vo
             $this->gridDisplay .= str_repeat(' ', $maxRowLength + 2);
         }
         foreach ($this->columns as $column => $reference) {
+            /** @var scalar $reference */
             $this->gridDisplay .= '| ' . str_pad((string) $reference, $columnWidths[$column] + 1, ' ');
         }
         $this->gridDisplay .= '|' . PHP_EOL;
 
         $this->renderFooter($maxRowLength, $columnWidths);
     }
 
+    /** @param int[] $columnWidths */
     private function renderFooter(int $maxRowLength, array $columnWidths): void
     {
         if ($this->rowHeaders) {
@@ -128,6 +141,7 @@ private function renderFooter(int $maxRowLength, array $columnWidths): void
         $this->gridDisplay .= '+' . PHP_EOL;
     }
 
+    /** @return int[] */
     private function getColumnWidths(): array
     {
         $columnCount = count($this->matrix, COUNT_RECURSIVE) / count($this->matrix);
@@ -139,6 +153,7 @@ private function getColumnWidths(): array
         return $columnWidths;
     }
 
+    /** @param mixed[] $columnData */
     private function getColumnWidth(array $columnData): int
     {
         $columnWidth = 0;

src/PhpSpreadsheet/Helper/TextGrid.php

@@ -116,6 +116,8 @@ public static function load(string $filename, int $flags = 0, ?array $readers =
 
     /**
      * Identify file type using automatic IReader resolution.
+     *
+     * @param string[] $readers
      */
     public static function identify(string $filename, ?array $readers = null, bool $fullClassName = false): string
     {