Merge branch 'master' into atsign

Author: oleibman

CHANGELOG.md

@@ -10,10 +10,12 @@ and this project adheres to [Semantic Versioning](https://semver.org).
 ### Added
 
 - Xlsx Reader Optionally Ignore Rows With No Cells. [Issue #3982](https://github.com/PHPOffice/PhpSpreadsheet/issues/3982) [PR #4035](https://github.com/PHPOffice/PhpSpreadsheet/pull/4035)
+- Option for CSV output file to have varying numbers of columns for each row. [Issue #1415](https://github.com/PHPOffice/PhpSpreadsheet/issues/1415) [PR #4076](https://github.com/PHPOffice/PhpSpreadsheet/pull/4076)
 
 ### Changed
 
 - On read, Xlsx Reader had been breaking up union ranges into separate individual ranges. It will now try to preserve range as it was read in. [PR #4042](https://github.com/PHPOffice/PhpSpreadsheet/pull/4042)
+- Xlsx/Xls spreadsheet calculation and formatting of dates will use base date of spreadsheet even when spreadsheets with different base dates are simultaneously open. [Issue #1036](https://github.com/PHPOffice/PhpSpreadsheet/issues/1036) [Issue #1635](https://github.com/PHPOffice/PhpSpreadsheet/issues/1635) [PR #4071](https://github.com/PHPOffice/PhpSpreadsheet/pull/4071) 
 
 ### Deprecated
 
@@ -32,7 +34,10 @@ and this project adheres to [Semantic Versioning](https://semver.org).
 - Mpdf and Tcpdf Borders on Merged Cells. [Issue #3557](https://github.com/PHPOffice/PhpSpreadsheet/issues/3557) [PR #4047](https://github.com/PHPOffice/PhpSpreadsheet/pull/4047)
 - Xls Conditional Format Improvements. [PR #4030](https://github.com/PHPOffice/PhpSpreadsheet/pull/4030) [PR #4033](https://github.com/PHPOffice/PhpSpreadsheet/pull/4033)
 - Conditional Range Unions and Intersections [Issue #4039](https://github.com/PHPOffice/PhpSpreadsheet/issues/4039) [PR #4042](https://github.com/PHPOffice/PhpSpreadsheet/pull/4042)
-- Csv Reader allow use of html mimetype. [Issue #4036](https://github.com/PHPOffice/PhpSpreadsheet/issues/4036) [PR #4049](https://github.com/PHPOffice/PhpSpreadsheet/pull/4040)
+- Csv Reader allow use of html mimetype. [Issue #4036](https://github.com/PHPOffice/PhpSpreadsheet/issues/4036) [PR #4040](https://github.com/PHPOffice/PhpSpreadsheet/pull/4040)
+- Problem rendering line chart with missing plot label. [PR #4074](https://github.com/PHPOffice/PhpSpreadsheet/pull/4074)
+- More RTL in Xlsx/Html Comments [Issue #4004](https://github.com/PHPOffice/PhpSpreadsheet/issues/4004) [PR #4065](https://github.com/PHPOffice/PhpSpreadsheet/pull/4065)
+- Empty String in sharedStrings. [Issue #4063](https://github.com/PHPOffice/PhpSpreadsheet/issues/4063) [PR #4064](https://github.com/PHPOffice/PhpSpreadsheet/pull/4064)
 
 ## 2024-05-11 - 2.1.0
 

docs/topics/Looping the Loop.md

@@ -308,6 +308,28 @@ But a peak memory usage of 49,152KB compared with the 57,344KB used by `toArray(
 Like `toArray()`, `rangeToArray()` is easy to use, but it has the same limitations for flexibility. It provides the same limited control over how the data from each cell is returned in the array as `toArray()`.
 The same additional arguments that can be provided for the `toArray()` method can also be provided to `rangeToArray()`.
 
+
+## Using `rangeToArrayYieldRows()`
+
+Since v2.1.0 the worksheet method `rangeToArrayYieldRows()` is available.
+It allows you to iterate over all sheet's rows with little memory consumption,
+while obtaining each row as an array:
+
+```php
+$rowGenerator = $sheet->rangeToArrayYieldRows(
+    'A1:' . $sheet->getHighestDataColumn() . $sheet->getHighestDataRow(),
+    null,
+    false,
+    false
+);
+foreach ($rowGenerator as $row) {
+    echo $row[0] . ' | ' . $row[1] . "\n";
+}
+```
+
+See `samples/Reader2/23_iterateRowsYield.php`.
+
+
 ## Using Iterators
 
 You don't need to build an array from the worksheet to loop through the rows and columns and do whatever processing you need; you can loop through the rows and columns in the Worksheet directly and more efficiently using PhpSpreadsheet's built-in iterators.

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

@@ -679,6 +679,18 @@ $writer->setOutputEncoding('SJIS-WIN');
 $writer->save("05featuredemo.csv");
 ```
 
+#### Writing CSV files with varying numbers of columns
+
+A CSV file can have a different number of columns in each row. This
+differs from the default behavior when saving as a .csv in Excel, but
+can be enabled in PhpSpreadsheet by using the following code:
+
+``` php
+$writer = new \PhpOffice\PhpSpreadsheet\Writer\Csv($spreadsheet);
+$writer->setVariableColumns(true);
+$writer->save("05featuredemo.csv");
+```
+
 #### Decimal and thousands separators
 
 If the worksheet you are exporting contains numbers with decimal or

samples/Reader2/23_iterateRowsYield.php

@@ -0,0 +1,25 @@
+<?php
+
+/**
+ * Use rangeToArrayYieldRows() to efficiently iterate over all rows.
+ */
+
+require __DIR__ . '/../Header.php';
+
+$inputFileName = __DIR__ . '/../Reader/sampleData/example1.xls';
+
+$spreadsheet = PhpOffice\PhpSpreadsheet\IOFactory::load(
+    $inputFileName,
+    PhpOffice\PhpSpreadsheet\Reader\IReader::READ_DATA_ONLY
+);
+$sheet = $spreadsheet->getSheet(0);
+
+$rowGenerator = $sheet->rangeToArrayYieldRows(
+    $spreadsheet->getActiveSheet()->calculateWorksheetDataDimension(),
+    null,
+    false,
+    false
+);
+foreach ($rowGenerator as $row) {
+    echo '| ' . $row[0] . ' | ' . $row[1] . "|\n";
+}

src/PhpSpreadsheet/Calculation/Calculation.php

@@ -122,7 +122,7 @@ class Calculation
      */
     private Logger $debugLog;
 
-    private bool $suppressFormulaErrorsNew = false;
+    private bool $suppressFormulaErrors = false;
 
     /**
      * Error message for any error that was raised/thrown by the calculation engine.
@@ -5382,7 +5382,7 @@ protected function raiseFormulaError(string $errorMessage, int $code = 0, ?Throw
     {
         $this->formulaError = $errorMessage;
         $this->cyclicReferenceStack->clear();
-        $suppress = $this->suppressFormulaErrors ?? $this->suppressFormulaErrorsNew;
+        $suppress = $this->suppressFormulaErrors;
         if (!$suppress) {
             throw new Exception($errorMessage, $code, $exception);
         }
@@ -5666,12 +5666,12 @@ private function evaluateDefinedName(Cell $cell, DefinedName $namedRange, Worksh
 
     public function setSuppressFormulaErrors(bool $suppressFormulaErrors): void
     {
-        $this->suppressFormulaErrorsNew = $suppressFormulaErrors;
+        $this->suppressFormulaErrors = $suppressFormulaErrors;
     }
 
     public function getSuppressFormulaErrors(): bool
     {
-        return $this->suppressFormulaErrorsNew;
+        return $this->suppressFormulaErrors;
     }
 
     public static function boolToString(mixed $operand1): mixed

src/PhpSpreadsheet/Cell/AdvancedValueBinder.php

@@ -4,7 +4,6 @@
 
 use PhpOffice\PhpSpreadsheet\Calculation\Calculation;
 use PhpOffice\PhpSpreadsheet\Calculation\Engine\FormattedNumber;
-use PhpOffice\PhpSpreadsheet\RichText\RichText;
 use PhpOffice\PhpSpreadsheet\Shared\Date;
 use PhpOffice\PhpSpreadsheet\Shared\StringHelper;
 use PhpOffice\PhpSpreadsheet\Style\NumberFormat;
@@ -30,7 +29,7 @@ public function bindValue(Cell $cell, mixed $value = null): bool
         $dataType = parent::dataTypeForValue($value);
 
         // Style logic - strings
-        if ($dataType === DataType::TYPE_STRING && !$value instanceof RichText) {
+        if ($dataType === DataType::TYPE_STRING && is_string($value)) {
             //    Test for booleans using locale-setting
             if (StringHelper::strToUpper($value) === Calculation::getTRUE()) {
                 $cell->setValueExplicit(true, DataType::TYPE_BOOL);
@@ -54,17 +53,17 @@ public function bindValue(Cell $cell, mixed $value = null): bool
             $thousandsSeparator = preg_quote(StringHelper::getThousandsSeparator(), '/');
 
             // Check for percentage
-            if (preg_match('/^\-?\d*' . $decimalSeparator . '?\d*\s?\%$/', preg_replace('/(\d)' . $thousandsSeparator . '(\d)/u', '$1$2', $value))) {
-                return $this->setPercentage(preg_replace('/(\d)' . $thousandsSeparator . '(\d)/u', '$1$2', $value), $cell);
+            if (preg_match('/^\-?\d*' . $decimalSeparator . '?\d*\s?\%$/', (string) preg_replace('/(\d)' . $thousandsSeparator . '(\d)/u', '$1$2', $value))) {
+                return $this->setPercentage((string) preg_replace('/(\d)' . $thousandsSeparator . '(\d)/u', '$1$2', $value), $cell);
             }
 
             // Check for currency
-            if (preg_match(FormattedNumber::currencyMatcherRegexp(), preg_replace('/(\d)' . $thousandsSeparator . '(\d)/u', '$1$2', $value), $matches, PREG_UNMATCHED_AS_NULL)) {
+            if (preg_match(FormattedNumber::currencyMatcherRegexp(), (string) preg_replace('/(\d)' . $thousandsSeparator . '(\d)/u', '$1$2', $value), $matches, PREG_UNMATCHED_AS_NULL)) {
                 // Convert value to number
                 $sign = ($matches['PrefixedSign'] ?? $matches['PrefixedSign2'] ?? $matches['PostfixedSign']) ?? null;
                 $currencyCode = $matches['PrefixedCurrency'] ?? $matches['PostfixedCurrency'];
                 /** @var string */
-                $temp = str_replace([$decimalSeparatorNoPreg, $currencyCode, ' ', '-'], ['.', '', '', ''], preg_replace('/(\d)' . $thousandsSeparator . '(\d)/u', '$1$2', $value));
+                $temp = str_replace([$decimalSeparatorNoPreg, $currencyCode, ' ', '-'], ['.', '', '', ''], (string) preg_replace('/(\d)' . $thousandsSeparator . '(\d)/u', '$1$2', $value));
                 $value = (float) ($sign . trim($temp));
 
                 return $this->setCurrency($value, $cell, $currencyCode ?? '');

src/PhpSpreadsheet/Cell/Cell.php

@@ -189,14 +189,21 @@ public function getValueString(): string
      */
     public function getFormattedValue(): string
     {
-        return (string) NumberFormat::toFormattedString(
+        $currentCalendar = SharedDate::getExcelCalendar();
+        SharedDate::setExcelCalendar($this->getWorksheet()->getParent()?->getExcelCalendar());
+        $formattedValue = (string) NumberFormat::toFormattedString(
             $this->getCalculatedValue(),
             (string) $this->getStyle()->getNumberFormat()->getFormatCode(true)
         );
+        SharedDate::setExcelCalendar($currentCalendar);
+
+        return $formattedValue;
     }
 
     protected static function updateIfCellIsTableHeader(?Worksheet $workSheet, self $cell, mixed $oldValue, mixed $newValue): void
     {
+        $oldValue = (is_scalar($oldValue) || $oldValue instanceof Stringable) ? ((string) $oldValue) : null;
+        $newValue = (is_scalar($newValue) || $newValue instanceof Stringable) ? ((string) $newValue) : null;
         if (StringHelper::strToLower($oldValue ?? '') === StringHelper::strToLower($newValue ?? '') || $workSheet === null) {
             return;
         }
@@ -264,7 +271,10 @@ public function setValueExplicit(mixed $value, string $dataType = DataType::TYPE
                 // Synonym for string
             case DataType::TYPE_INLINE:
                 // Rich text
-                $this->value = DataType::checkString($value);
+                if ($value !== null && !is_scalar($value) && !($value instanceof Stringable)) {
+                    throw new SpreadsheetException('Invalid unstringable value for datatype Inline/String/String2');
+                }
+                $this->value = DataType::checkString(($value instanceof RichText) ? $value : ((string) $value));
 
                 break;
             case DataType::TYPE_NUMERIC:
@@ -385,6 +395,8 @@ public function getCalculatedValue(bool $resetLog = true): mixed
 
         if ($this->dataType === DataType::TYPE_FORMULA) {
             try {
+                $currentCalendar = SharedDate::getExcelCalendar();
+                SharedDate::setExcelCalendar($this->getWorksheet()->getParent()?->getExcelCalendar());
                 $index = $this->getWorksheet()->getParentOrThrow()->getActiveSheetIndex();
                 $selected = $this->getWorksheet()->getSelectedCells();
                 $thisworksheet = $this->getWorksheet();
@@ -509,6 +521,7 @@ public function getCalculatedValue(bool $resetLog = true): mixed
                     $this->dataType = $originalDataType;
                 }
             } catch (SpreadsheetException $ex) {
+                SharedDate::setExcelCalendar($currentCalendar);
                 if (($ex->getMessage() === 'Unable to access External Workbook') && ($this->calculatedValue !== null)) {
                     return $this->calculatedValue; // Fallback for calculations referencing external files.
                 } elseif (preg_match('/[Uu]ndefined (name|offset: 2|array key 2)/', $ex->getMessage()) === 1) {
@@ -521,6 +534,7 @@ public function getCalculatedValue(bool $resetLog = true): mixed
                     $ex
                 );
             }
+            SharedDate::setExcelCalendar($currentCalendar);
 
             if ($result === '#Not Yet Implemented') {
                 return $this->calculatedValue; // Fallback if calculation engine does not support the formula.
@@ -924,7 +938,9 @@ public function getFormulaAttributes(): mixed
      */
     public function __toString(): string
     {
-        return (string) $this->getValue();
+        $retVal = $this->value;
+
+        return ($retVal === null || is_scalar($retVal) || $retVal instanceof Stringable) ? ((string) $retVal) : '';
     }
 
     public function getIgnoredErrors(): IgnoredErrors

src/PhpSpreadsheet/Cell/DataType.php

@@ -4,6 +4,7 @@
 
 use PhpOffice\PhpSpreadsheet\RichText\RichText;
 use PhpOffice\PhpSpreadsheet\Shared\StringHelper;
+use Stringable;
 
 class DataType
 {
@@ -78,7 +79,7 @@ public static function checkString(null|RichText|string $textValue): RichText|st
      */
     public static function checkErrorCode(mixed $value): string
     {
-        $value = (string) $value;
+        $value = (is_scalar($value) || $value instanceof Stringable) ? ((string) $value) : '#NULL!';
 
         if (!isset(self::$errorCodes[$value])) {
             $value = '#NULL!';

src/PhpSpreadsheet/Cell/DataValidator.php

@@ -46,7 +46,7 @@ public function isValid(Cell $cell): bool
                 $returnValue = $this->numericOperator($dataValidation, (float) $cellValue);
             }
         } elseif ($type === DataValidation::TYPE_TEXTLENGTH) {
-            $returnValue = $this->numericOperator($dataValidation, mb_strlen((string) $cellValue));
+            $returnValue = $this->numericOperator($dataValidation, mb_strlen($cell->getValueString()));
         }
 
         return $returnValue;
@@ -86,14 +86,14 @@ private function numericOperator(DataValidation $dataValidation, int|float $cell
      */
     private function isValueInList(Cell $cell): bool
     {
-        $cellValue = $cell->getValue();
+        $cellValueString = $cell->getValueString();
         $dataValidation = $cell->getDataValidation();
 
         $formula1 = $dataValidation->getFormula1();
         if (!empty($formula1)) {
             // inline values list
             if ($formula1[0] === '"') {
-                return in_array(strtolower($cellValue), explode(',', strtolower(trim($formula1, '"'))), true);
+                return in_array(strtolower($cellValueString), explode(',', strtolower(trim($formula1, '"'))), true);
             } elseif (strpos($formula1, ':') > 0) {
                 // values list cells
                 $matchFormula = '=MATCH(' . $cell->getCoordinate() . ', ' . $formula1 . ', 0)';

src/PhpSpreadsheet/Cell/DefaultValueBinder.php

@@ -46,19 +46,33 @@ public static function dataTypeForValue(mixed $value): string
         // Match the value against a few data types
         if ($value === null) {
             return DataType::TYPE_NULL;
-        } elseif (is_float($value) || is_int($value)) {
+        }
+        if (is_float($value) || is_int($value)) {
             return DataType::TYPE_NUMERIC;
-        } elseif (is_bool($value)) {
+        }
+        if (is_bool($value)) {
             return DataType::TYPE_BOOL;
-        } elseif ($value === '') {
+        }
+        if ($value === '') {
             return DataType::TYPE_STRING;
-        } elseif ($value instanceof RichText) {
+        }
+        if ($value instanceof RichText) {
             return DataType::TYPE_INLINE;
-        } elseif (is_string($value) && strlen($value) > 1 && $value[0] === '=') {
+        }
+        if ($value instanceof Stringable) {
+            $value = (string) $value;
+        }
+        if (!is_string($value)) {
+            $gettype = is_object($value) ? get_class($value) : gettype($value);
+
+            throw new SpreadsheetException("unusable type $gettype");
+        }
+        if (strlen($value) > 1 && $value[0] === '=') {
             return DataType::TYPE_FORMULA;
-        } elseif (preg_match('/^[\+\-]?(\d+\\.?\d*|\d*\\.?\d+)([Ee][\-\+]?[0-2]?\d{1,3})?$/', $value)) {
+        }
+        if (preg_match('/^[\+\-]?(\d+\\.?\d*|\d*\\.?\d+)([Ee][\-\+]?[0-2]?\d{1,3})?$/', $value)) {
             $tValue = ltrim($value, '+-');
-            if (is_string($value) && strlen($tValue) > 1 && $tValue[0] === '0' && $tValue[1] !== '.') {
+            if (strlen($tValue) > 1 && $tValue[0] === '0' && $tValue[1] !== '.') {
                 return DataType::TYPE_STRING;
             } elseif ((!str_contains($value, '.')) && ($value > PHP_INT_MAX)) {
                 return DataType::TYPE_STRING;
@@ -67,11 +81,10 @@ public static function dataTypeForValue(mixed $value): string
             }
 
             return DataType::TYPE_NUMERIC;
-        } elseif (is_string($value)) {
-            $errorCodes = DataType::getErrorCodes();
-            if (isset($errorCodes[$value])) {
-                return DataType::TYPE_ERROR;
-            }
+        }
+        $errorCodes = DataType::getErrorCodes();
+        if (isset($errorCodes[$value])) {
+            return DataType::TYPE_ERROR;
         }
 
         return DataType::TYPE_STRING;