Merge branch 'master' into customfunc

Author: oleibman

CHANGELOG.md

@@ -10,14 +10,15 @@ and this project adheres to [Semantic Versioning](https://semver.org).
 ### Added
 
 - Add ability to add custom functions to Calculation. [PR #4390](https://github.com/PHPOffice/PhpSpreadsheet/pull/4390)
+- Add FormulaRange to IgnoredErrors. [PR #4393](https://github.com/PHPOffice/PhpSpreadsheet/pull/4393)
 
 ### Removed
 
 - Nothing yet.
 
 ### Changed
 
-- Nothing yet.
+- Phpstan Version 2. [PR #4384](https://github.com/PHPOffice/PhpSpreadsheet/pull/4384)
 
 ### Moved
 
@@ -29,7 +30,7 @@ and this project adheres to [Semantic Versioning](https://semver.org).
 
 ### Fixed
 
-- Nothing yet.
+- BIN2DEC, OCT2DEC, and HEX2DEC return numbers rather than strings. [Issue #4383](https://github.com/PHPOffice/PhpSpreadsheet/issues/4383) [PR #4389](https://github.com/PHPOffice/PhpSpreadsheet/pull/4389)
 
 ## 2025-03-02 - 4.1.0
 

docs/topics/reading-files.md

@@ -851,7 +851,7 @@ for a working example of this code.
 ### listWorksheetInfo
 
 The `listWorksheetInfo()` method returns a nested array, with each entry
-listing the name and dimensions for a worksheet:
+listing the name, dimensions and state for a worksheet:
 
 ```php
 $reader = \PhpOffice\PhpSpreadsheet\IOFactory::createReader($inputFileType);
@@ -865,7 +865,8 @@ foreach ($worksheetData as $worksheet) {
     echo 'Rows: ', $worksheet['totalRows'],
          ' Columns: ', $worksheet['totalColumns'], '<br />';
     echo 'Cell Range: A1:',
-    $worksheet['lastColumnLetter'], $worksheet['totalRows'];
+         $worksheet['lastColumnLetter'], $worksheet['totalRows'], '<br />';
+    echo 'Sheet state: ', $worksheet['sheetState'];
     echo '</li>';
 }
 echo '</ol>';

src/PhpSpreadsheet/Calculation/Engineering/ConvertBinary.php

@@ -23,7 +23,7 @@ class ConvertBinary extends ConvertBase
      *                                10 characters (10 bits), BIN2DEC returns the #NUM! error value.
      *                      Or can be an array of values
      *
-     * @return array|string Result, or an error
+     * @return array|float|int|string Result, or an error
      *         If an array of numbers is passed as an argument, then the returned result will also be an array
      *            with the same dimensions
      */
@@ -44,10 +44,10 @@ public static function toDecimal($value)
             //    Two's Complement
             $value = substr($value, -9);
 
-            return '-' . (512 - bindec($value));
+            return -(512 - bindec($value));
         }
 
-        return (string) bindec($value);
+        return bindec($value);
     }
 
     /**

src/PhpSpreadsheet/Calculation/Engineering/ConvertHex.php

@@ -74,7 +74,7 @@ public static function toBinary($value, $places = null): array|string
      *                          #NUM! error value.
      *                      Or can be an array of values
      *
-     * @return array|string Result, or an error
+     * @return array|float|int|string Result, or an error
      *         If an array of numbers is passed as an argument, then the returned result will also be an array
      *            with the same dimensions
      */
@@ -104,10 +104,10 @@ public static function toDecimal($value)
                 $binX[$i] = ($binX[$i] == '1' ? '0' : '1');
             }
 
-            return (string) ((bindec($binX) + 1) * -1);
+            return (bindec($binX) + 1) * -1;
         }
 
-        return (string) bindec($binX);
+        return bindec($binX);
     }
 
     /**

src/PhpSpreadsheet/Calculation/Engineering/ConvertOctal.php

@@ -78,7 +78,7 @@ public static function toBinary($value, $places = null): array|string
      *                          #NUM! error value.
      *                      Or can be an array of values
      *
-     * @return array|string Result, or an error
+     * @return array|float|int|string Result, or an error
      *         If an array of numbers is passed as an argument, then the returned result will also be an array
      *            with the same dimensions
      */
@@ -104,10 +104,10 @@ public static function toDecimal($value)
                 $binX[$i] = ($binX[$i] == '1' ? '0' : '1');
             }
 
-            return (string) ((bindec($binX) + 1) * -1);
+            return (bindec($binX) + 1) * -1;
         }
 
-        return (string) bindec($binX);
+        return bindec($binX);
     }
 
     /**

src/PhpSpreadsheet/Cell/IgnoredErrors.php

@@ -8,6 +8,8 @@ class IgnoredErrors
 
     private bool $formula = false;
 
+    private bool $formulaRange = false;
+
     private bool $twoDigitTextYear = false;
 
     private bool $evalError = false;
@@ -36,6 +38,18 @@ public function getFormula(): bool
         return $this->formula;
     }
 
+    public function setFormulaRange(bool $value): self
+    {
+        $this->formulaRange = $value;
+
+        return $this;
+    }
+
+    public function getFormulaRange(): bool
+    {
+        return $this->formulaRange;
+    }
+
     public function setTwoDigitTextYear(bool $value): self
     {
         $this->twoDigitTextYear = $value;

src/PhpSpreadsheet/Reader/Xlsx.php

@@ -2374,6 +2374,7 @@ private function processIgnoredErrors(SimpleXMLElement $xml, Worksheet $sheet):
         $sqref = (string) ($attributes['sqref'] ?? '');
         $numberStoredAsText = (string) ($attributes['numberStoredAsText'] ?? '');
         $formula = (string) ($attributes['formula'] ?? '');
+        $formulaRange = (string) ($attributes['formulaRange'] ?? '');
         $twoDigitTextYear = (string) ($attributes['twoDigitTextYear'] ?? '');
         $evalError = (string) ($attributes['evalError'] ?? '');
         if (!empty($sqref)) {
@@ -2403,6 +2404,9 @@ private function processIgnoredErrors(SimpleXMLElement $xml, Worksheet $sheet):
                             if ($formula === '1') {
                                 $sheet->getCell("$col$row")->getIgnoredErrors()->setFormula(true);
                             }
+                            if ($formulaRange === '1') {
+                                $sheet->getCell("$col$row")->getIgnoredErrors()->setFormulaRange(true);
+                            }
                             if ($twoDigitTextYear === '1') {
                                 $sheet->getCell("$col$row")->getIgnoredErrors()->setTwoDigitTextYear(true);
                             }

src/PhpSpreadsheet/Writer/Xlsx/Worksheet.php

@@ -27,6 +27,8 @@ class Worksheet extends WriterPart
 
     private string $formula = '';
 
+    private string $formulaRange = '';
+
     private string $twoDigitTextYear = '';
 
     private string $evalError = '';
@@ -50,6 +52,7 @@ public function writeWorksheet(PhpspreadsheetWorksheet $worksheet, array $string
         $worksheet->calculateArrays($this->getParentWriter()->getPreCalculateFormulas());
         $this->numberStoredAsText = '';
         $this->formula = '';
+        $this->formulaRange = '';
         $this->twoDigitTextYear = '';
         $this->evalError = '';
         // Create XML writer
@@ -180,6 +183,7 @@ private function writeIgnoredErrors(XMLWriter $objWriter): void
         $started = false;
         $this->writeIgnoredError($objWriter, $started, 'numberStoredAsText', $this->numberStoredAsText);
         $this->writeIgnoredError($objWriter, $started, 'formula', $this->formula);
+        $this->writeIgnoredError($objWriter, $started, 'formulaRange', $this->formulaRange);
         $this->writeIgnoredError($objWriter, $started, 'twoDigitTextYear', $this->twoDigitTextYear);
         $this->writeIgnoredError($objWriter, $started, 'evalError', $this->evalError);
         if ($started) {
@@ -1392,6 +1396,9 @@ private function writeSheetData(XMLWriter $objWriter, PhpspreadsheetWorksheet $w
                             if ($worksheet->getCell($coord)->getIgnoredErrors()->getFormula()) {
                                 $this->formula .= " $coord";
                             }
+                            if ($worksheet->getCell($coord)->getIgnoredErrors()->getFormulaRange()) {
+                                $this->formulaRange .= " $coord";
+                            }
                             if ($worksheet->getCell($coord)->getIgnoredErrors()->getTwoDigitTextYear()) {
                                 $this->twoDigitTextYear .= " $coord";
                             }

tests/PhpSpreadsheetTests/Calculation/Functions/Engineering/Bin2DecTest.php

@@ -11,6 +11,7 @@
 use PhpOffice\PhpSpreadsheet\Calculation\Information\ExcelError;
 use PhpOffice\PhpSpreadsheet\Spreadsheet;
 use PhpOffice\PhpSpreadsheetTests\Calculation\Functions\FormulaArguments;
+use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\TestCase;
 
 class Bin2DecTest extends TestCase
@@ -27,19 +28,14 @@ protected function tearDown(): void
         Functions::setCompatibilityMode($this->compatibilityMode);
     }
 
-    #[\PHPUnit\Framework\Attributes\DataProvider('providerBIN2DEC')]
-    public function testDirectCallToBIN2DEC(string $expectedResult, bool|int|string $arg1): void
+    #[DataProvider('providerBIN2DEC')]
+    public function testDirectCallToBIN2DEC(float|int|string $expectedResult, bool|int|string $arg1): void
     {
         $result = ConvertBinary::toDecimal($arg1);
         self::assertSame($expectedResult, $result);
     }
 
-    private function trimIfQuoted(string $value): string
-    {
-        return trim($value, '"');
-    }
-
-    #[\PHPUnit\Framework\Attributes\DataProvider('providerBIN2DEC')]
+    #[DataProvider('providerBIN2DEC')]
     public function testBIN2DECAsFormula(mixed $expectedResult, mixed ...$args): void
     {
         $arguments = new FormulaArguments(...$args);
@@ -48,11 +44,11 @@ public function testBIN2DECAsFormula(mixed $expectedResult, mixed ...$args): voi
         $formula = "=BIN2DEC({$arguments})";
 
         /** @var float|int|string */
-        $result = $calculation->_calculateFormulaValue($formula);
-        self::assertSame($expectedResult, $this->trimIfQuoted((string) $result));
+        $result = $calculation->calculateFormula($formula);
+        self::assertSame($expectedResult, $result);
     }
 
-    #[\PHPUnit\Framework\Attributes\DataProvider('providerBIN2DEC')]
+    #[DataProvider('providerBIN2DEC')]
     public function testBIN2DECInWorksheet(mixed $expectedResult, mixed ...$args): void
     {
         $arguments = new FormulaArguments(...$args);
@@ -75,7 +71,7 @@ public static function providerBIN2DEC(): array
         return require 'tests/data/Calculation/Engineering/BIN2DEC.php';
     }
 
-    #[\PHPUnit\Framework\Attributes\DataProvider('providerUnhappyBIN2DEC')]
+    #[DataProvider('providerUnhappyBIN2DEC')]
     public function testBIN2DECUnhappyPath(string $expectedException, mixed ...$args): void
     {
         $arguments = new FormulaArguments(...$args);
@@ -101,10 +97,12 @@ public static function providerUnhappyBIN2DEC(): array
         ];
     }
 
-    #[\PHPUnit\Framework\Attributes\DataProvider('providerBIN2DECOds')]
-    public function testBIN2DECOds(string $expectedResult, bool $arg1): void
+    #[DataProvider('providerBIN2DECOds')]
+    public function testBIN2DECOds(float|int|string $expectedResult, bool $arg1): void
     {
-        Functions::setCompatibilityMode(Functions::COMPATIBILITY_OPENOFFICE);
+        Functions::setCompatibilityMode(
+            Functions::COMPATIBILITY_OPENOFFICE
+        );
 
         $result = ConvertBinary::toDecimal($arg1);
         self::assertSame($expectedResult, $result);
@@ -120,29 +118,35 @@ public function testBIN2DECFractional(): void
         $calculation = Calculation::getInstance();
         $formula = '=BIN2DEC(101.1)';
 
-        Functions::setCompatibilityMode(Functions::COMPATIBILITY_GNUMERIC);
+        Functions::setCompatibilityMode(
+            Functions::COMPATIBILITY_GNUMERIC
+        );
         /** @var float|int|string */
-        $result = $calculation->_calculateFormulaValue($formula);
-        self::assertSame('5', $this->trimIfQuoted((string) $result), 'Gnumeric');
+        $result = $calculation->calculateFormula($formula);
+        self::assertSame(5, $result, 'Gnumeric');
 
-        Functions::setCompatibilityMode(Functions::COMPATIBILITY_OPENOFFICE);
+        Functions::setCompatibilityMode(
+            Functions::COMPATIBILITY_OPENOFFICE
+        );
         /** @var float|int|string */
-        $result = $calculation->_calculateFormulaValue($formula);
-        self::assertSame(ExcelError::NAN(), $this->trimIfQuoted((string) $result), 'OpenOffice');
+        $result = $calculation->calculateFormula($formula);
+        self::assertSame(ExcelError::NAN(), $result, 'OpenOffice');
 
-        Functions::setCompatibilityMode(Functions::COMPATIBILITY_EXCEL);
+        Functions::setCompatibilityMode(
+            Functions::COMPATIBILITY_EXCEL
+        );
         /** @var float|int|string */
-        $result = $calculation->_calculateFormulaValue($formula);
-        self::assertSame(ExcelError::NAN(), $this->trimIfQuoted((string) $result), 'Excel');
+        $result = $calculation->calculateFormula($formula);
+        self::assertSame(ExcelError::NAN(), $result, 'Excel');
     }
 
-    #[\PHPUnit\Framework\Attributes\DataProvider('providerBin2DecArray')]
+    #[DataProvider('providerBin2DecArray')]
     public function testBin2DecArray(array $expectedResult, string $value): void
     {
         $calculation = Calculation::getInstance();
 
         $formula = "=BIN2DEC({$value})";
-        $result = $calculation->_calculateFormulaValue($formula);
+        $result = $calculation->calculateFormula($formula);
         self::assertEquals($expectedResult, $result);
     }