Merge branch 'master' into atsign

CHANGELOG.md

@@ -27,6 +27,8 @@ and this project adheres to [Semantic Versioning](https://semver.org).
 
 - Html Reader Preserve Unicode Whitespace. [Issue #1284](https://github.com/PHPOffice/PhpSpreadsheet/issues/1284) [PR #4106](https://github.com/PHPOffice/PhpSpreadsheet/pull/4106)
 - RATE Function Floating Point Number of Periods. [PR #4107](https://github.com/PHPOffice/PhpSpreadsheet/pull/4107)
+- Parameter Name Change Xlsx Writer Workbook. [Issue #4108](https://github.com/PHPOffice/PhpSpreadsheet/issues/4108) [PR #4111](https://github.com/PHPOffice/PhpSpreadsheet/pull/4111)
+- New Algorithm for TRUNC, ROUNDUP, ROUNDDOWN. [Issue #4113](https://github.com/PHPOffice/PhpSpreadsheet/issues/4113) [PR #4115](https://github.com/PHPOffice/PhpSpreadsheet/pull/4115)
 
 ## 2024-07-29 - 2.2.1
 

src/PhpSpreadsheet/Calculation/Calculation.php

@@ -75,8 +75,6 @@ class Calculation
 
     /**
      * Instance of this class.
-     *
-     * @var ?Calculation
      */
     private static ?Calculation $instance = null;
 
@@ -3316,10 +3314,8 @@ private static function translateFormula(array $from, array $to, string $formula
         return $formula;
     }
 
-    /** @var ?array */
     private static ?array $functionReplaceFromExcel;
 
-    /** @var ?array */
     private static ?array $functionReplaceToLocale;
 
     /**
@@ -3365,10 +3361,8 @@ public function translateFormulaToLocale(string $formula): string
         );
     }
 
-    /** @var ?array */
     private static ?array $functionReplaceFromLocale;
 
-    /** @var ?array */
     private static ?array $functionReplaceToExcel;
 
     /**

src/PhpSpreadsheet/Calculation/MathTrig/Round.php

@@ -10,8 +10,6 @@ class Round
 {
     use ArrayEnabled;
 
-    private const ROUNDING_ADJUSTMENT = (PHP_VERSION_ID < 80400) ? 0 : 1e-14;
-
     /**
      * ROUND.
      *
@@ -69,11 +67,22 @@ public static function up($number, $digits): array|string|float
             return 0.0;
         }
 
+        $digitsPlus1 = $digits + 1;
         if ($number < 0.0) {
-            return round($number - 0.5 * 0.1 ** $digits + self::ROUNDING_ADJUSTMENT, $digits, PHP_ROUND_HALF_DOWN);
+            if ($digitsPlus1 < 0) {
+                return round($number - 0.5 * 0.1 ** $digits, $digits, PHP_ROUND_HALF_DOWN);
+            }
+            $result = sprintf("%.{$digitsPlus1}F", $number - 0.5 * 0.1 ** $digits);
+
+            return round((float) $result, $digits, PHP_ROUND_HALF_DOWN);
+        }
+
+        if ($digitsPlus1 < 0) {
+            return round($number + 0.5 * 0.1 ** $digits, $digits, PHP_ROUND_HALF_DOWN);
         }
+        $result = sprintf("%.{$digitsPlus1}F", $number + 0.5 * 0.1 ** $digits);
 
-        return round($number + 0.5 * 0.1 ** $digits - self::ROUNDING_ADJUSTMENT, $digits, PHP_ROUND_HALF_DOWN);
+        return round((float) $result, $digits, PHP_ROUND_HALF_DOWN);
     }
 
     /**
@@ -105,11 +114,23 @@ public static function down($number, $digits): array|string|float
             return 0.0;
         }
 
+        $digitsPlus1 = $digits + 1;
         if ($number < 0.0) {
-            return round($number + 0.5 * 0.1 ** $digits - self::ROUNDING_ADJUSTMENT, $digits, PHP_ROUND_HALF_UP);
+            if ($digitsPlus1 < 0) {
+                return round($number + 0.5 * 0.1 ** $digits, $digits, PHP_ROUND_HALF_UP);
+            }
+            $result = sprintf("%.{$digitsPlus1}F", $number + 0.5 * 0.1 ** $digits);
+
+            return round((float) $result, $digits, PHP_ROUND_HALF_UP);
+        }
+
+        if ($digitsPlus1 < 0) {
+            return round($number - 0.5 * 0.1 ** $digits, $digits, PHP_ROUND_HALF_UP);
         }
 
-        return round($number - 0.5 * 0.1 ** $digits + self::ROUNDING_ADJUSTMENT, $digits, PHP_ROUND_HALF_UP);
+        $result = sprintf("%.{$digitsPlus1}F", $number - 0.5 * 0.1 ** $digits);
+
+        return round((float) $result, $digits, PHP_ROUND_HALF_UP);
     }
 
     /**

src/PhpSpreadsheet/Calculation/MathTrig/Trunc.php

@@ -13,6 +13,11 @@ class Trunc
      * TRUNC.
      *
      * Truncates value to the number of fractional digits by number_digits.
+     * This will probably not be the precise result in the unlikely
+     * event that the number of digits to the left of the decimal
+     * plus the number of digits to the right exceeds PHP_FLOAT_DIG
+     * (or possibly that value minus 1).
+     * Excel is unlikely to do any better.
      *
      * @param array|float $value Or can be an array of values
      * @param array|int $digits Or can be an array of values
@@ -34,15 +39,27 @@ public static function evaluate(array|float|string|null $value = 0, array|int|st
             return $e->getMessage();
         }
 
-        $digits = floor($digits);
+        if ($value == 0) {
+            return $value;
+        }
 
-        // Truncate
-        $adjust = 10 ** $digits;
+        if ($value >= 0) {
+            $minusSign = '';
+        } else {
+            $minusSign = '-';
+            $value = -$value;
+        }
+        $digits = (int) floor($digits);
+        if ($digits < 0) {
+            $result = (float) (substr(sprintf('%.0F', $value), 0, $digits) . str_repeat('0', -$digits));
 
-        if (($digits > 0) && (rtrim((string) (int) ((abs($value) - abs((int) $value)) * $adjust), '0') < $adjust / 10)) {
-            return $value;
+            return ($minusSign === '') ? $result : -$result;
         }
+        $decimals = (floor($value) == (int) $value) ? (PHP_FLOAT_DIG - strlen((string) (int) $value)) : $digits;
+        $resultString = ($decimals < 0) ? sprintf('%F', $value) : sprintf('%.' . $decimals . 'F', $value);
+        $regExp = '/([.]\\d{' . $digits . '})\\d+$/';
+        $result = $minusSign . (preg_replace($regExp, '$1', $resultString) ?? $resultString);
 
-        return ((int) ($value * $adjust)) / $adjust;
+        return (float) $result;
     }
 }

src/PhpSpreadsheet/Cell/Cell.php

@@ -50,8 +50,6 @@ class Cell implements Stringable
 
     /**
      * The collection of cells that this cell belongs to (i.e. The Cell Collection for the parent Worksheet).
-     *
-     * @var ?Cells
      */
     private ?Cells $parent;
 

src/PhpSpreadsheet/Chart/Properties.php

@@ -105,7 +105,6 @@ abstract class Properties
 
     protected bool $objectState = false; // used only for minor gridlines
 
-    /** @var ?float */
     protected ?float $glowSize = null;
 
     protected ChartColor $glowColor;

src/PhpSpreadsheet/Helper/Html.php

@@ -533,13 +533,10 @@ class Html
         'yellowgreen' => '9acd32',
     ];
 
-    /** @var ?string */
     private ?string $face = null;
 
-    /** @var ?string */
     private ?string $size = null;
 
-    /** @var ?string */
     private ?string $color = null;
 
     private bool $bold = false;

src/PhpSpreadsheet/Reader/Csv/Delimiter.php

@@ -17,7 +17,6 @@ class Delimiter
 
     protected int $numberLines = 0;
 
-    /** @var ?string */
     protected ?string $delimiter = null;
 
     /**

src/PhpSpreadsheet/Reader/Xls.php

@@ -350,8 +350,6 @@ class Xls extends BaseReader
 
     /**
      * The current RC4 decryption object.
-     *
-     * @var ?Xls\RC4
      */
     private ?Xls\RC4 $rc4Key = null;
 

src/PhpSpreadsheet/Reader/Xlsx/Styles.php

@@ -19,8 +19,6 @@ class Styles extends BaseParserClass
 {
     /**
      * Theme instance.
-     *
-     * @var ?Theme
      */
     private ?Theme $theme = null;
 

src/PhpSpreadsheet/ReferenceHelper.php

@@ -24,8 +24,6 @@ class ReferenceHelper
 
     /**
      * Instance of this class.
-     *
-     * @var ?ReferenceHelper
      */
     private static ?ReferenceHelper $instance = null;
 

src/PhpSpreadsheet/RichText/Run.php

@@ -9,8 +9,6 @@ class Run extends TextElement implements ITextElement
 {
     /**
      * Font.
-     *
-     * @var ?Font
      */
     private ?Font $font;
 

src/PhpSpreadsheet/Settings.php

@@ -27,8 +27,6 @@ class Settings
 
     /**
      * The cache implementation to be used for cell collection.
-     *
-     * @var ?CacheInterface
      */
     private static ?CacheInterface $cache = null;
 

src/PhpSpreadsheet/Shared/Escher.php

@@ -6,15 +6,11 @@ class Escher
 {
     /**
      * Drawing Group Container.
-     *
-     * @var ?Escher\DggContainer
      */
     private ?Escher\DggContainer $dggContainer = null;
 
     /**
      * Drawing Container.
-     *
-     * @var ?Escher\DgContainer
      */
     private ?Escher\DgContainer $dgContainer = null;
 

src/PhpSpreadsheet/Shared/Escher/DggContainer.php

@@ -21,8 +21,6 @@ class DggContainer
 
     /**
      * BLIP Store Container.
-     *
-     * @var ?DggContainer\BstoreContainer
      */
     private ?DggContainer\BstoreContainer $bstoreContainer = null;
 

src/PhpSpreadsheet/Shared/Escher/DggContainer/BstoreContainer/BSE.php

@@ -25,8 +25,6 @@ class BSE
 
     /**
      * The BLIP (Big Large Image or Picture).
-     *
-     * @var ?BSE\Blip
      */
     private ?BSE\Blip $blip = null;
 

src/PhpSpreadsheet/Style/ConditionalFormatting/Wizard/WizardAbstract.php

@@ -9,9 +9,6 @@
 
 abstract class WizardAbstract
 {
-    /**
-     * @var ?Style
-     */
     protected ?Style $style = null;
 
     protected string $expression;

src/PhpSpreadsheet/Style/Font.php

@@ -38,10 +38,8 @@ class Font extends Supervisor
 
     private string $strikeType = '';
 
-    /** @var ?ChartColor */
     private ?ChartColor $underlineColor = null;
 
-    /** @var ?ChartColor */
     private ?ChartColor $chartColor = null;
     // end of chart title items
 

src/PhpSpreadsheet/Writer/Xlsx/Workbook.php

@@ -14,11 +14,11 @@ class Workbook extends WriterPart
     /**
      * Write workbook to XML format.
      *
-     * @param bool $recalcRequired Indicate whether formulas should be recalculated before writing
+     * @param bool $preCalculateFormulas If true, formulas will be calculated before writing
      *
      * @return string XML Output
      */
-    public function writeWorkbook(Spreadsheet $spreadsheet, bool $recalcRequired = false): string
+    public function writeWorkbook(Spreadsheet $spreadsheet, bool $preCalculateFormulas = false): string
     {
         // Create XML writer
         if ($this->getParentWriter()->getUseDiskCaching()) {
@@ -57,7 +57,7 @@ public function writeWorkbook(Spreadsheet $spreadsheet, bool $recalcRequired = f
         (new DefinedNamesWriter($objWriter, $spreadsheet))->write();
 
         // calcPr
-        $this->writeCalcPr($objWriter, $recalcRequired);
+        $this->writeCalcPr($objWriter, $preCalculateFormulas);
 
         $objWriter->endElement();
 
@@ -146,9 +146,9 @@ private function writeWorkbookProtection(XMLWriter $objWriter, Spreadsheet $spre
     /**
      * Write calcPr.
      *
-     * @param bool $recalcRequired Indicate whether formulas should be recalculated before writing
+     * @param bool $preCalculateFormulas If true, formulas will be calculated before writing
      */
-    private function writeCalcPr(XMLWriter $objWriter, bool $recalcRequired = true): void
+    private function writeCalcPr(XMLWriter $objWriter, bool $preCalculateFormulas = true): void
     {
         $objWriter->startElement('calcPr');
 
@@ -157,10 +157,10 @@ private function writeCalcPr(XMLWriter $objWriter, bool $recalcRequired = true):
         //     because the file has changed
         $objWriter->writeAttribute('calcId', '999999');
         $objWriter->writeAttribute('calcMode', 'auto');
-        //    fullCalcOnLoad isn't needed if we've recalculating for the save
-        $objWriter->writeAttribute('calcCompleted', ($recalcRequired) ? '1' : '0');
-        $objWriter->writeAttribute('fullCalcOnLoad', ($recalcRequired) ? '0' : '1');
-        $objWriter->writeAttribute('forceFullCalc', ($recalcRequired) ? '0' : '1');
+        //    fullCalcOnLoad isn't needed if we will calculate before writing
+        $objWriter->writeAttribute('calcCompleted', ($preCalculateFormulas) ? '1' : '0');
+        $objWriter->writeAttribute('fullCalcOnLoad', ($preCalculateFormulas) ? '0' : '1');
+        $objWriter->writeAttribute('forceFullCalc', ($preCalculateFormulas) ? '0' : '1');
 
         $objWriter->endElement();
     }

tests/PhpSpreadsheetTests/Calculation/Functions/Database/SetupTeardownDatabases.php

@@ -14,14 +14,8 @@ class SetupTeardownDatabases extends TestCase
 {
     protected const RESULT_CELL = 'Z1';
 
-    /**
-     * @var ?Spreadsheet
-     */
     private ?Spreadsheet $spreadsheet = null;
 
-    /**
-     * @var ?Worksheet
-     */
     private ?Worksheet $sheet = null;
 
     protected function setUp(): void