Some Tweaks for Fields

Author: oleibman

src/PhpWord/Element/Field.php

@@ -97,7 +97,7 @@ class Field extends AbstractElement
             'options' => [
                 'f', 'h', 'n', 'p', 'r', 't', 'w',
                 'd' => [',', '.', ''],
-                'NumberSeperatorSequence' => [',', '.', ''],
+                'NumberSeperatorSequence' => [',', '.', ''], // grandfather typo
                 'NumberSeparatorSequence' => [',', '.', ''],
             ],
         ],
@@ -254,7 +254,8 @@ public function getProperties()
     public function setOptions(array $options = [])
     {
         foreach (array_keys($options) as $optionkey) {
-            if (!(isset($this->fieldsArray[$this->type]['options'][$optionkey])) && substr($optionkey, 0, 1) !== '\\') {
+            $optionkey = preg_replace('/^[\\\\](.)$/', '$1', $optionkey) ?? $optionkey;
+            if (!(isset($this->fieldsArray[$this->type]['options'][$optionkey]))) {
                 throw new InvalidArgumentException("Invalid option '$optionkey', possible values are " . implode(', ', $this->fieldsArray[$this->type]['options']));
             }
         }

src/PhpWord/Writer/Word2007/Element/Field.php

@@ -224,6 +224,7 @@ private function buildPropertiesAndOptions(ElementField $element)
 
                     break;
                 default:
+                    $option = preg_replace('/^(.)$/', '\\\\$1', $option) ?? $option;
                     $propertiesAndOptions .= $option . ' ';
             }
         }
@@ -318,13 +319,14 @@ protected function writeRef(ElementField $element): void
         'InsertParagraphNumberFullContext' => '\\w',
     ];
 
-    private const NUMBER_SEPARATOR_SEQUENCE = ['NumberSeperatorSequence', 'NumberSeparatorSequence', '\\d'];
+    private const NUMBER_SEPARATOR_SEQUENCE = ['NumberSeperatorSequence', 'NumberSeparatorSequence', '\\d', 'd'];
 
     private function convertRefOption(string $optionKey, string $optionValue): string
     {
         if (in_array($optionKey, self::NUMBER_SEPARATOR_SEQUENCE, true)) {
-            return '\\d ' . $optionValue;
+            return ($optionValue === '') ? '' : ('\\d ' . $optionValue);
         }
+        $optionValue = preg_replace('/^(.)$/', '\\\\$1', $optionValue) ?? $optionValue;
 
         return self::OPTION_VALUES[$optionValue] ?? (in_array($optionValue, self::OPTION_VALUES, true) ? $optionValue : '');
     }

tests/PhpWordTests/Writer/Word2007/Element/FieldTest.php

@@ -49,7 +49,7 @@ public function testWriteWithRefType(): void
             ],
             [
                 'InsertParagraphNumberRelativeContext',
-                'CreateHyperLink',
+                'h', // could have been supplied as 'CreateHyperLink' or '\h'
                 'NumberSeperatorSequence' => ',',
             ]
         );