Allow php-cs-fixer to Handle Implicit Backslashes

Its defaults are to unescape within single quotes, and escape within double quotes and here-docs. Right now, it leaves everything as-is, which means our code is inconsistent and need not be. Further, although dealing with complex regular expressions will never be easy, I find it much easier to figure out what's going on when superfluous back-slashes are removed.

These changes were all made automatically using the "fix" script, so should be reliable. They, of course, pass all unit tests.

Author: oleibman

.php-cs-fixer.dist.php

@@ -221,7 +221,7 @@
         'standardize_not_equals' => true,
         'static_lambda' => false, // Risky if we can't guarantee nobody use `bindTo()`
         'strict_comparison' => false, // No, too dangerous to change that
-        'string_implicit_backslashes' => false, // was escape_implicit_backslashes, too confusing
+        'string_implicit_backslashes' => ['single_quoted' => 'unescape', 'double_quoted' => 'escape', 'heredoc' => 'escape'], // was escape_implicit_backslashes
         'strict_param' => false, // No, too dangerous to change that
         'string_length_to_empty' => true,
         'string_line_ending' => true,

composer.json

@@ -15,6 +15,7 @@
         "platform": {
             "php" : "8.1.99"
         },
+        "process-timeout": 600,
         "sort-packages": true,
         "allow-plugins": {
             "dealerdirect/phpcodesniffer-composer-installer": true

src/PhpSpreadsheet/Calculation/Calculation.php

@@ -52,7 +52,7 @@ class Calculation
     //    Defined Names: Named Range of cells, or Named Formulae
     const CALCULATION_REGEXP_DEFINEDNAME = '((([^\s,!&%^\/\*\+<>=-]*)|(\'(?:[^\']|\'[^!])+?\')|(\"(?:[^\"]|\"[^!])+?\"))!)?([_\p{L}][_\p{L}\p{N}\.]*)';
     // Structured Reference (Fully Qualified and Unqualified)
-    const CALCULATION_REGEXP_STRUCTURED_REFERENCE = '([\p{L}_\\\\][\p{L}\p{N}\._]+)?(\[(?:[^\d\]+-])?)';
+    const CALCULATION_REGEXP_STRUCTURED_REFERENCE = '([\p{L}_\\\][\p{L}\p{N}\._]+)?(\[(?:[^\d\]+-])?)';
     //    Error
     const CALCULATION_REGEXP_ERROR = '\#[A-Z][A-Z0_\/]*[!\?]?';
 

src/PhpSpreadsheet/Calculation/DateTimeExcel/DateValue.php

@@ -47,7 +47,7 @@ public static function fromString(null|array|string|int|bool|float $dateValue):
         }
 
         // try to parse as date iff there is at least one digit
-        if (is_string($dateValue) && preg_match('/\\d/', $dateValue) !== 1) {
+        if (is_string($dateValue) && preg_match('/\d/', $dateValue) !== 1) {
             return ExcelError::VALUE();
         }
 

src/PhpSpreadsheet/Calculation/DateTimeExcel/TimeValue.php

@@ -43,7 +43,7 @@ public static function fromString(null|array|string|int|bool|float $timeValue):
         }
 
         // try to parse as time iff there is at least one digit
-        if (is_string($timeValue) && preg_match('/\\d/', $timeValue) !== 1) {
+        if (is_string($timeValue) && preg_match('/\d/', $timeValue) !== 1) {
             return ExcelError::VALUE();
         }
 

src/PhpSpreadsheet/Calculation/Engine/Operands/StructuredReference.php

@@ -29,7 +29,7 @@ final class StructuredReference implements Operand, Stringable
         self::ITEM_SPECIFIER_TOTALS,
     ];
 
-    private const TABLE_REFERENCE = '/([\p{L}_\\\\][\p{L}\p{N}\._]+)?(\[(?:[^\]\[]+|(?R))*+\])/miu';
+    private const TABLE_REFERENCE = '/([\p{L}_\\\][\p{L}\p{N}\._]+)?(\[(?:[^\]\[]+|(?R))*+\])/miu';
 
     private string $value;
 

src/PhpSpreadsheet/Calculation/FormulaParser.php

@@ -213,7 +213,7 @@ private function parseToTokens(): void
             // scientific notation check
             if (str_contains(self::OPERATORS_SN, $this->formula[$index])) {
                 if (strlen($value) > 1) {
-                    if (preg_match('/^[1-9]{1}(\\.\\d+)?E{1}$/', $this->formula[$index]) != 0) {
+                    if (preg_match('/^[1-9]{1}(\.\d+)?E{1}$/', $this->formula[$index]) != 0) {
                         $value .= $this->formula[$index];
                         ++$index;
 

src/PhpSpreadsheet/Calculation/Functions.php

@@ -338,7 +338,7 @@ public static function expandDefinedName(string $coordinate, Cell $cell): string
 
     public static function trimTrailingRange(string $coordinate): string
     {
-        return (string) preg_replace('/:[\\w\$]+$/', '', $coordinate);
+        return (string) preg_replace('/:[\w\$]+$/', '', $coordinate);
     }
 
     public static function trimSheetFromCellReference(string $coordinate): string

src/PhpSpreadsheet/Calculation/Internal/WildcardMatch.php

@@ -6,10 +6,10 @@ class WildcardMatch
 {
     private const SEARCH_SET = [
         '~~', // convert double tilde to unprintable value
-        '~\\*', // convert tilde backslash asterisk to [*] (matches literal asterisk in regexp)
-        '\\*', // convert backslash asterisk to .* (matches string of any length in regexp)
-        '~\\?', // convert tilde backslash question to [?] (matches literal question mark in regexp)
-        '\\?', // convert backslash question to . (matches one character in regexp)
+        '~\*', // convert tilde backslash asterisk to [*] (matches literal asterisk in regexp)
+        '\*', // convert backslash asterisk to .* (matches string of any length in regexp)
+        '~\?', // convert tilde backslash question to [?] (matches literal question mark in regexp)
+        '\?', // convert backslash question to . (matches one character in regexp)
         "\x1c", // convert original double tilde to single tilde
     ];
 

src/PhpSpreadsheet/Calculation/TextData/Trim.php

@@ -25,7 +25,7 @@ public static function nonPrintable(mixed $stringValue = '')
 
         $stringValue = Helpers::extractString($stringValue);
 
-        return (string) preg_replace('/[\\x00-\\x1f]/', '', "$stringValue");
+        return (string) preg_replace('/[\x00-\x1f]/', '', "$stringValue");
     }
 
     /**