Merge branch 'master' into issue4182

Author: oleibman

CHANGELOG.md

@@ -28,7 +28,7 @@ and this project adheres to [Semantic Versioning](https://semver.org).
 - Xls Writer Condtional Rules Applied to Whole Rows or Columns. [Issue #3185](https://github.com/PHPOffice/PhpSpreadsheet/issues/3185) [PR #4152](https://github.com/PHPOffice/PhpSpreadsheet/pull/4152)
 - Xlsx Writer Duplicate ContentTypes Entry for Background Image. [Issue #4179](https://github.com/PHPOffice/PhpSpreadsheet/issues/4179) [PR #4180](https://github.com/PHPOffice/PhpSpreadsheet/pull/4180)
 - Check strictNullComparison outside of loops. [PR #3347](https://github.com/PHPOffice/PhpSpreadsheet/pull/3347)
-- SUMIFS Does Not Require _xlfn. [Issue #4182](https://github.com/PHPOffice/PhpSpreadsheet/issues/4182) [PR #4186](https://github.com/PHPOffice/PhpSpreadsheet/pull/4186)
+- SUMIFS Does Not Require xlfn. [Issue #4182](https://github.com/PHPOffice/PhpSpreadsheet/issues/4182) [PR #4186](https://github.com/PHPOffice/PhpSpreadsheet/pull/4186)
 
 ## 2024-09-29 - 3.3.0 (no 3.0.\*, 3.1.\*, 3.2.\*)
 

composer.lock

@@ -1113,19 +1113,19 @@ Flags that are available that can be passed to the Reader in this way include:
 
  - $reader::LOAD_WITH_CHARTS
  - $reader::READ_DATA_ONLY
- - $reader::IGNORE_EMPTY_CELLS 
- - $reader::SKIP_EMPTY_CELLS (synonym for IGNORE_EMPTY_CELLS)
-
-| Readers  | LOAD_WITH_CHARTS | READ_DATA_ONLY | IGNORE_EMPTY_CELLS |
-|----------|------------------|----------------|--------------------|
-| Xlsx     | YES              | YES            | YES                |
-| Xls      | NO               | YES            | YES                |
-| Xml      | NO               | NO             | NO                 |
-| Ods      | NO               | YES            | NO                 |
-| Gnumeric | NO               | YES            | NO                 |
-| Html     | N/A              | N/A            | N/A                |
-| Slk      | N/A              | NO             | NO                 |
-| Csv      | N/A              | NO             | NO                 |
+ - $reader::IGNORE_EMPTY_CELLS
+ - $reader::IGNORE_ROWS_WITH_NO_CELLS
+
+| Readers  | LOAD_WITH_CHARTS | READ_DATA_ONLY | IGNORE_EMPTY_CELLS | IGNORE_ROWS_WITH_NO_CELLS |
+|----------|------------------|----------------|--------------------|---------------------------|
+| Xlsx     | YES              | YES            | YES                | YES                       |
+| Xls      | NO               | YES            | YES                | NO                        |
+| Xml      | NO               | NO             | NO                 | NO                        |
+| Ods      | NO               | YES            | NO                 | NO                        |
+| Gnumeric | NO               | YES            | NO                 | NO                        |
+| Html     | N/A              | N/A            | N/A                | N/A                       |
+| Slk      | N/A              | NO             | NO                 | NO                        |
+| Csv      | N/A              | NO             | NO                 | NO                        |
 
 Likewise, when saving a file using a Writer, loaded charts will not be saved unless you explicitly tell the Writer to include them:
 
@@ -1162,5 +1162,5 @@ Two or more flags can be passed together using PHP's `|` operator.
 
 ```php
 $reader = \PhpOffice\PhpSpreadsheet\IOFactory::createReaderForFile("myExampleFile.xlsx");
-$reader->load("spreadsheetWithCharts.xlsx", $reader::READ_DATA_ONLY | $reader::SKIP_EMPTY_CELLS);
+$reader->load("spreadsheetWithCharts.xlsx", $reader::READ_DATA_ONLY | $reader::IGNORE_EMPTY_CELLS);
 ```

docs/topics/reading-and-writing-to-file.md

@@ -19,7 +19,7 @@ abstract class BaseReader implements IReader
 
     /**
      * Read empty cells?
-     * Identifies whether the Reader should read data values for cells all cells, or should ignore cells containing
+     * Identifies whether the Reader should read data values for all cells, or should ignore cells containing
      *         null value or empty string.
      */
     protected bool $readEmptyCells = true;
@@ -166,7 +166,7 @@ protected function processFlags(int $flags): void
         if (((bool) ($flags & self::READ_DATA_ONLY)) === true) {
             $this->setReadDataOnly(true);
         }
-        if (((bool) ($flags & self::SKIP_EMPTY_CELLS) || (bool) ($flags & self::IGNORE_EMPTY_CELLS)) === true) {
+        if (((bool) ($flags & self::IGNORE_EMPTY_CELLS)) === true) {
             $this->setReadEmptyCells(false);
         }
         if (((bool) ($flags & self::IGNORE_ROWS_WITH_NO_CELLS)) === true) {

src/PhpSpreadsheet/Reader/BaseReader.php

@@ -6,13 +6,36 @@
 
 interface IReader
 {
+    /**
+     * Flag used to load the charts.
+     *
+     * This flag is supported only for some formats.
+     */
     public const LOAD_WITH_CHARTS = 1;
 
+    /**
+     * Flag used to read data only, not style or structure information.
+     */
     public const READ_DATA_ONLY = 2;
 
-    public const SKIP_EMPTY_CELLS = 4;
+    /**
+     * @deprecated 3.4.0 use IGNORE_EMPTY_CELLS instead.
+     */
+    public const SKIP_EMPTY_CELLS = self::IGNORE_EMPTY_CELLS;
+
+    /**
+     * Flag used to ignore empty cells when reading.
+     *
+     * The ignored cells will not be instantiated.
+     */
     public const IGNORE_EMPTY_CELLS = 4;
 
+    /**
+     * Flag used to ignore rows without cells.
+     *
+     * This flag is supported only for some formats.
+     * This can heavily improve performance for some files.
+     */
     public const IGNORE_ROWS_WITH_NO_CELLS = 8;
 
     public function __construct();
@@ -119,7 +142,7 @@ public function setReadFilter(IReadFilter $readFilter): self;
      * @param int $flags Flags that can change the behaviour of the Writer:
      *            self::LOAD_WITH_CHARTS    Load any charts that are defined (if the Reader supports Charts)
      *            self::READ_DATA_ONLY      Read only data, not style or structure information, from the file
-     *            self::SKIP_EMPTY_CELLS    Don't read empty cells (cells that contain a null value,
+     *            self::IGNORE_EMPTY_CELLS  Don't read empty cells (cells that contain a null value,
      *                                      empty string, or a string containing only whitespace characters)
      */
     public function load(string $filename, int $flags = 0): Spreadsheet;

src/PhpSpreadsheet/Reader/IReader.php

@@ -2784,23 +2784,30 @@ public function fromArray(array $source, mixed $nullValue = null, string $startC
         [$startColumn, $startRow] = Coordinate::coordinateFromString($startCell);
 
         // Loop through $source
-        foreach ($source as $rowData) {
-            $currentColumn = $startColumn;
-            foreach ($rowData as $cellValue) {
-                if ($strictNullComparison) {
+        if ($strictNullComparison) {
+            foreach ($source as $rowData) {
+                $currentColumn = $startColumn;
+                foreach ($rowData as $cellValue) {
                     if ($cellValue !== $nullValue) {
                         // Set cell value
                         $this->getCell($currentColumn . $startRow)->setValue($cellValue);
                     }
-                } else {
+                    ++$currentColumn;
+                }
+                ++$startRow;
+            }
+        } else {
+            foreach ($source as $rowData) {
+                $currentColumn = $startColumn;
+                foreach ($rowData as $cellValue) {
                     if ($cellValue != $nullValue) {
                         // Set cell value
                         $this->getCell($currentColumn . $startRow)->setValue($cellValue);
                     }
+                    ++$currentColumn;
                 }
-                ++$currentColumn;
+                ++$startRow;
             }
-            ++$startRow;
         }
 
         return $this;

src/PhpSpreadsheet/Worksheet/Worksheet.php

@@ -30,8 +30,8 @@ public function processCondition(mixed $condition, string $cellRange): void
         $this->condition = $condition;
         $this->cellRange = $cellRange;
 
-        if (is_int($condition) || is_float($condition)) {
-            $this->size = ($condition <= 65535 ? 3 : 0x0000);
+        if (is_int($condition) && $condition >= 0 && $condition <= 65535) {
+            $this->size = 3;
             $this->tokens = pack('Cv', 0x1E, $condition);
         } else {
             try {

src/PhpSpreadsheet/Writer/Xls/ConditionalHelper.php

@@ -489,6 +489,31 @@ public function close(): void
         $this->storeEof();
     }
 
+    public const MAX_XLS_COLUMN = 256;
+    public const MAX_XLS_COLUMN_STRING = 'IV';
+    public const MAX_XLS_ROW = 65536;
+
+    private static function limitRange(string $exploded): string
+    {
+        $retVal = '';
+        $ranges = Coordinate::getRangeBoundaries($exploded);
+        $firstCol = Coordinate::columnIndexFromString($ranges[0][0]);
+        $firstRow = (int) $ranges[0][1];
+        if ($firstCol <= self::MAX_XLS_COLUMN && $firstRow <= self::MAX_XLS_ROW) {
+            $retVal = $exploded;
+            if (str_contains($exploded, ':')) {
+                $lastCol = Coordinate::columnIndexFromString($ranges[1][0]);
+                $ranges[1][1] = min(self::MAX_XLS_ROW, (int) $ranges[1][1]);
+                if ($lastCol > self::MAX_XLS_COLUMN) {
+                    $ranges[1][0] = self::MAX_XLS_COLUMN_STRING;
+                }
+                $retVal = "{$ranges[0][0]}{$ranges[0][1]}:{$ranges[1][0]}{$ranges[1][1]}";
+            }
+        }
+
+        return $retVal;
+    }
+
     private function writeConditionalFormatting(): void
     {
         $conditionalFormulaHelper = new ConditionalHelper($this->parser);
@@ -497,7 +522,10 @@ private function writeConditionalFormatting(): void
         foreach ($this->phpSheet->getConditionalStylesCollection() as $key => $value) {
             $keyExplode = explode(',', Coordinate::resolveUnionAndIntersection($key));
             foreach ($keyExplode as $exploded) {
-                $arrConditionalStyles[$exploded] = $value;
+                $range = self::limitRange($exploded);
+                if ($range !== '') {
+                    $arrConditionalStyles[$range] = $value;
+                }
             }
         }
         if (!empty($arrConditionalStyles)) {

src/PhpSpreadsheet/Writer/Xls/Worksheet.php

@@ -196,7 +196,7 @@ public function writeContentTypes(Spreadsheet $spreadsheet, bool $includeCharts
             $bgImage = $spreadsheet->getSheet($i)->getBackgroundImage();
             $mimeType = $spreadsheet->getSheet($i)->getBackgroundMime();
             $extension = $spreadsheet->getSheet($i)->getBackgroundExtension();
-            if ($bgImage !== '' && !isset($aMediaContentTypes[$mimeType])) {
+            if ($bgImage !== '' && !isset($aMediaContentTypes[$extension])) {
                 $this->writeDefaultContentType($objWriter, $extension, $mimeType);
             }
         }

src/PhpSpreadsheet/Writer/Xlsx/ContentTypes.php

@@ -0,0 +1,86 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpOffice\PhpSpreadsheetTests\Writer\Xls;
+
+use PhpOffice\PhpSpreadsheet\Spreadsheet;
+use PhpOffice\PhpSpreadsheet\Style\Color;
+use PhpOffice\PhpSpreadsheet\Style\Conditional;
+use PhpOffice\PhpSpreadsheet\Style\Style;
+use PhpOffice\PhpSpreadsheetTests\Functional\AbstractFunctional;
+
+class ConditionalLimitsTest extends AbstractFunctional
+{
+    public function testLimits(): void
+    {
+        $spreadsheet = new Spreadsheet();
+        $sheet = $spreadsheet->getActiveSheet();
+        $sheet->fromArray(
+            [
+                ['Cell', 0, null, null, 'Col Rng', -2, -1],
+                [null, null, null, null, null, 0, 1],
+                ['Cell Rng', -2, -1, 0, null, 2, 3],
+                [null, 1, 2, 3, null, 4, -1],
+                [],
+                ['Row Rng'],
+                [-2, -1, 0],
+                [1, 2, 3],
+            ],
+            strictNullComparison: true
+        );
+        $redStyle = new Style(false, true);
+        $redStyle->getFont()->setColor(new Color(Color::COLOR_RED));
+
+        $condition1 = new Conditional();
+        $condition1->setConditionType(Conditional::CONDITION_CELLIS)
+            ->setOperatorType(Conditional::OPERATOR_BETWEEN)
+            ->addCondition(-1)
+            ->addCondition(1)
+            ->setStyle($redStyle);
+        $conditionalStyles = [$condition1];
+        $cellRange = 'B1';
+        $sheet->getStyle($cellRange)->setConditionalStyles($conditionalStyles);
+
+        $condition2 = new Conditional();
+        $condition2->setConditionType(Conditional::CONDITION_CELLIS)
+            ->setOperatorType(Conditional::OPERATOR_BETWEEN)
+            ->addCondition(-1.5)
+            ->addCondition(1.5)
+            ->setStyle($redStyle);
+        $conditionalStyles = [$condition2];
+        $cellRange = 'F:G';
+        $sheet->getStyle($cellRange)->setConditionalStyles($conditionalStyles);
+
+        $condition3 = new Conditional();
+        $condition3->setConditionType(Conditional::CONDITION_CELLIS)
+            ->setOperatorType(Conditional::OPERATOR_BETWEEN)
+            ->addCondition(-1)
+            ->addCondition(70000)
+            ->setStyle($redStyle);
+        $conditionalStyles = [$condition3];
+        $cellRange = '7:8';
+        $sheet->getStyle($cellRange)->setConditionalStyles($conditionalStyles);
+
+        $cellRange = 'B3:D4';
+        $sheet->getStyle($cellRange)->setConditionalStyles($conditionalStyles);
+        $sheet->setSelectedCells('A1');
+        $keys = array_keys($sheet->getConditionalStylesCollection());
+        self::assertSame(['B1', 'F1:G1048576', 'A7:XFD8', 'B3:D4'], $keys);
+
+        $robj = $this->writeAndReload($spreadsheet, 'Xls');
+        $spreadsheet->disconnectWorksheets();
+        $sheet0 = $robj->getActiveSheet();
+        $conditionals = $sheet0->getConditionalStylesCollection();
+        self::assertSame(['B1', 'F1:G65536', 'A7:IV8', 'B3:D4'], array_keys($conditionals));
+        $b1 = $conditionals['B1'][0];
+        self::assertSame([-1, 1], $b1->getConditions());
+        $b1 = $conditionals['F1:G65536'][0];
+        self::assertSame([-1.5, 1.5], $b1->getConditions());
+        $b1 = $conditionals['A7:IV8'][0];
+        self::assertSame([-1, 70000], $b1->getConditions());
+        $b1 = $conditionals['B3:D4'][0];
+        self::assertSame([-1, 70000], $b1->getConditions());
+        $robj->disconnectWorksheets();
+    }
+}