Preserve 0x0a In Strings If Desired

Fix #347, which had gone stale but is now reopened. PhpSpreadsheet is automatically replacing CR-LF and CR with LF. The reason for this is unknown, although I suggest a possibility in the issue. I am not willing to make this a breaking change. This PR adds a new property `preserveCr` with setter and getter to DefaultValueBinder (and, by extension, to StringValueBinder and AdvancedValueBinder). The property defaults to false, but users who wish to preserve CR-LF and CR can set it to true for a Spreadsheet or a Reader.

Author: oleibman

src/PhpSpreadsheet/Cell/Cell.php

@@ -278,7 +278,14 @@ public function setValueExplicit(mixed $value, string $dataType = DataType::TYPE
             case DataType::TYPE_INLINE:
                 // Rich text
                 $value2 = StringHelper::convertToString($value, true);
-                $this->value = DataType::checkString(($value instanceof RichText) ? $value : $value2);
+                // Cells?->Worksheet?->Spreadsheet
+                $binder = $this->parent?->getParent()?->getParent()?->getValueBinder();
+                $preserveCr = false;
+                if ($binder !== null && method_exists($binder, 'getPreserveCr')) {
+                    /** @var bool */
+                    $preserveCr = $binder->getPreserveCr();
+                }
+                $this->value = DataType::checkString(($value instanceof RichText) ? $value : $value2, $preserveCr);
 
                 break;
             case DataType::TYPE_NUMERIC:

src/PhpSpreadsheet/Cell/DataType.php

@@ -53,7 +53,7 @@ public static function getErrorCodes(): array
      *
      * @return RichText|string Sanitized value
      */
-    public static function checkString(null|RichText|string $textValue): RichText|string
+    public static function checkString(null|RichText|string $textValue, bool $preserveCr = false): RichText|string
     {
         if ($textValue instanceof RichText) {
             // TODO: Sanitize Rich-Text string (max. character count is 32,767)
@@ -64,7 +64,9 @@ public static function checkString(null|RichText|string $textValue): RichText|st
         $textValue = StringHelper::substring((string) $textValue, 0, self::MAX_STRING_LENGTH);
 
         // we require that newline is represented as "\n" in core, not as "\r\n" or "\r"
-        $textValue = str_replace(["\r\n", "\r"], "\n", $textValue);
+        if (!$preserveCr) {
+            $textValue = str_replace(["\r\n", "\r"], "\n", $textValue);
+        }
 
         return $textValue;
     }

src/PhpSpreadsheet/Cell/DefaultValueBinder.php

@@ -108,4 +108,18 @@ public static function dataTypeForValue(mixed $value): string
 
         return DataType::TYPE_STRING;
     }
+
+    protected bool $preserveCr = false;
+
+    public function getPreserveCr(): bool
+    {
+        return $this->preserveCr;
+    }
+
+    public function setPreserveCr(bool $preserveCr): self
+    {
+        $this->preserveCr = $preserveCr;
+
+        return $this;
+    }
 }

src/PhpSpreadsheet/Reader/Xls/LoadSpreadsheet.php

@@ -27,7 +27,7 @@ protected function loadSpreadsheetFromFile2(string $filename, Xls $xls): Spreads
 
         // Initialisations
         $xls->spreadsheet = $this->newSpreadsheet();
-        $xls->spreadsheet->setValueBinder($this->valueBinder);
+        $xls->spreadsheet->setValueBinder($xls->valueBinder);
         $xls->spreadsheet->removeSheetByIndex(0); // remove 1st sheet
         if (!$xls->readDataOnly) {
             $xls->spreadsheet->removeCellStyleXfByIndex(0); // remove the default style