Update recipes.rst (#2367)

* Add support for fractional font sizes

Word supports fractional font sizes like 8.5pt, but PHPWord doesn't.

* Add background color support for textboxes

* Add background color support for text boxes for Word writer

* Added period to the comments to match the cs-fixer configuration

* Fixed cs-fixer issues.

* Added type hints and matching PHPDoc. Also added @return void.

* Added bgcolor unit test coverage

* Removed @return void as not compatible with projects coding standard.

* Fixed several CS-Fixer issues

* Replaced deprecated "assertRegExp" test method by assertMatchesRegularExpression.

* Address the CI coverage issue for the regex match assertion.

* Add support for fractional font sizes

Word supports fractional font sizes like 8.5pt, but PHPWord doesn't.

* The default font size method now supports int and float font sizes. Added type hinting to settings class and unit test coverage for fractional (float) font size.

* The default font size method now supports int and float font sizes. Added type hinting to settings class and unit test coverage for fractional (float) font size.

Co-authored-by: hazington <hazington@eweso.de>
Co-authored-by: Progi1984 <progi1984@gmail.com>

docs/general.rst

@@ -192,11 +192,11 @@ You can also specify the status of the spell and grammar checks, marking spellin
 
 .. code-block:: php
 
-    $proofState = new ProofState();
-    $proofState->setGrammar(ProofState::CLEAN);
-    $proofState->setSpelling(ProofState::DIRTY);
+    $proofState = new \PhpOffice\PhpWord\ComplexType\ProofState();
+    $proofState->setGrammar(\PhpOffice\PhpWord\ComplexType\ProofState::CLEAN);
+    $proofState->setSpelling(\PhpOffice\PhpWord\ComplexType\ProofState::DIRTY);
 
-    $phpWord->getSettings()->setProofState(proofState);
+    $phpWord->getSettings()->setProofState($proofState);
 
 Track Revisions
 ~~~~~~~~~~~~~~~

docs/recipes.rst

@@ -29,7 +29,7 @@ Use ``php://output`` as the filename.
 .. code-block:: php
 
     $phpWord = new \PhpOffice\PhpWord\PhpWord();
-    $section = $phpWord->createSection();
+    $section = $phpWord->addSection();
     $section->addText('Hello World!');
     $file = 'HelloWorld.docx';
     header("Content-Description: File Transfer");

docs/templates-processing.rst

@@ -4,7 +4,7 @@ Templates processing
 ====================
 
 You can create an OOXML document template with included search-patterns (macros) which can be replaced by any value you wish. Only single-line values can be replaced.
-Macros are defined like this: ``${search-pattern}``.
+By default Macros are defined like this: ``${search-pattern}`` but you can define custom macros.
 To load a template file, create a new instance of the TemplateProcessor.
 
 .. code-block:: php
@@ -35,6 +35,30 @@ You can also set multiple values by passing all of them in an array.
 
     $templateProcessor->setValues(array('firstname' => 'John', 'lastname' => 'Doe'));
 
+setMacroOpeningChars
+""""""""
+You can define a custom opening macro. The following will set ``{#`` as the opening search pattern.
+
+.. code-block:: php
+
+    $templateProcessor->setMacroOpeningChars('{#');
+
+setMacroClosingChars
+""""""""
+You can define a custom closing macro. The following will set ``#}`` as the closing search pattern.
+
+.. code-block:: php
+
+    $templateProcessor->setMacroClosingChars('#}');
+
+setMacroChars
+""""""""
+You can define a custom opening and closing macro at the same time . The following will set the search-pattern like this: ``{#search-pattern#}`` .
+
+.. code-block:: php
+
+    $templateProcessor->setMacroChars('{#', '#}');
+
 setImageValue
 """""""""""""
 The search-pattern model for images can be like:

src/PhpWord/Reader/Word2007/AbstractPart.php

@@ -323,6 +323,8 @@ abstract class AbstractPart
                     $element->setChangeInfo($type, $author, $date);
                 }
             }
+        } elseif ($node->nodeName == 'w:softHyphen') {
+            $element = $parent->addText("\u{200c}", $fontStyle, $paragraphStyle);
         }
     }
 
@@ -558,7 +560,7 @@ abstract class AbstractPart
             'valign' => [self::READ_VALUE, 'w:vAlign'],
             'textDirection' => [self::READ_VALUE, 'w:textDirection'],
             'gridSpan' => [self::READ_VALUE, 'w:gridSpan'],
-            'vMerge' => [self::READ_VALUE, 'w:vMerge'],
+            'vMerge' => [self::READ_VALUE, 'w:vMerge', null, null, 'continue'],
             'bgColor' => [self::READ_VALUE, 'w:shd', 'w:fill'],
         ];
 
@@ -626,7 +628,7 @@ abstract class AbstractPart
         $styles = [];
 
         foreach ($styleDefs as $styleProp => $styleVal) {
-            [$method, $element, $attribute, $expected] = array_pad($styleVal, 4, null);
+            [$method, $element, $attribute, $expected, $default] = array_pad($styleVal, 5, null);
 
             $element = $this->findPossibleElement($xmlReader, $parentNode, $element);
             if ($element === null) {
@@ -640,7 +642,7 @@ abstract class AbstractPart
 
                 // Use w:val as default if no attribute assigned
                 $attribute = ($attribute === null) ? 'w:val' : $attribute;
-                $attributeValue = $xmlReader->getAttribute($attribute, $node);
+                $attributeValue = $xmlReader->getAttribute($attribute, $node) ?? $default;
 
                 $styleValue = $this->readStyleDef($method, $attributeValue, $expected);
                 if ($styleValue !== null) {

src/PhpWord/Settings.php

@@ -2,10 +2,8 @@
 /**
  * This file is part of PHPWord - A pure PHP library for reading and writing
  * word processing documents.
- *
  * PHPWord is free software distributed under the terms of the GNU Lesser
  * General Public License version 3 as published by the Free Software Foundation.
- *
  * For the full copyright and license information, please read the LICENSE
  * file that was distributed with this source code. For the full list of
  * contributors, visit https://github.com/PHPOffice/PHPWord/contributors.
@@ -29,48 +27,46 @@ class Settings
      *
      * @const string
      */
-    const ZIPARCHIVE = 'ZipArchive';
-    const PCLZIP = 'PclZip';
-    const OLD_LIB = \PhpOffice\PhpWord\Shared\ZipArchive::class; // @deprecated 0.11
+    public const ZIPARCHIVE = 'ZipArchive';
+    public const PCLZIP = 'PclZip';
+    public const OLD_LIB = \PhpOffice\PhpWord\Shared\ZipArchive::class; // @deprecated 0.11
 
     /**
      * PDF rendering libraries.
      *
      * @const string
      */
-    const PDF_RENDERER_DOMPDF = 'DomPDF';
-    const PDF_RENDERER_TCPDF = 'TCPDF';
-    const PDF_RENDERER_MPDF = 'MPDF';
+    public const PDF_RENDERER_DOMPDF = 'DomPDF';
+    public const PDF_RENDERER_TCPDF = 'TCPDF';
+    public const PDF_RENDERER_MPDF = 'MPDF';
 
     /**
      * Measurement units multiplication factor.
-     *
      * Applied to:
      * - Section: margins, header/footer height, gutter, column spacing
      * - Tab: position
      * - Indentation: left, right, firstLine, hanging
-     * - Spacing: before, after
+     * - Spacing: before, after.
      *
      * @const string
      */
-    const UNIT_TWIP = 'twip'; // = 1/20 point
-    const UNIT_CM = 'cm';
-    const UNIT_MM = 'mm';
-    const UNIT_INCH = 'inch';
-    const UNIT_POINT = 'point'; // = 1/72 inch
-    const UNIT_PICA = 'pica'; // = 1/6 inch = 12 points
+    public const UNIT_TWIP = 'twip'; // = 1/20 point
+    public const UNIT_CM = 'cm';
+    public const UNIT_MM = 'mm';
+    public const UNIT_INCH = 'inch';
+    public const UNIT_POINT = 'point'; // = 1/72 inch
+    public const UNIT_PICA = 'pica'; // = 1/6 inch = 12 points
 
     /**
      * Default font settings.
-     *
      * OOXML defined font size values in halfpoints, i.e. twice of what PhpWord
      * use, and the conversion will be conducted during XML writing.
      */
-    const DEFAULT_FONT_NAME = 'Arial';
-    const DEFAULT_FONT_SIZE = 10;
-    const DEFAULT_FONT_COLOR = '000000';
-    const DEFAULT_FONT_CONTENT_TYPE = 'default'; // default|eastAsia|cs
-    const DEFAULT_PAPER = 'A4';
+    public const DEFAULT_FONT_NAME = 'Arial';
+    public const DEFAULT_FONT_SIZE = 10;
+    public const DEFAULT_FONT_COLOR = '000000';
+    public const DEFAULT_FONT_CONTENT_TYPE = 'default'; // default|eastAsia|cs
+    public const DEFAULT_PAPER = 'A4';
 
     /**
      * Compatibility option for XMLWriter.
@@ -89,21 +85,21 @@ class Settings
     /**
      * Name of the external Library used for rendering PDF files.
      *
-     * @var string
+     * @var null|string
      */
     private static $pdfRendererName;
 
     /**
      * Directory Path to the external Library used for rendering PDF files.
      *
-     * @var string
+     * @var null|string
      */
     private static $pdfRendererPath;
 
     /**
      * Measurement unit.
      *
-     * @var float|int
+     * @var string
      */
     private static $measurementUnit = self::UNIT_TWIP;
 
@@ -117,7 +113,7 @@ class Settings
     /**
      * Default font size.
      *
-     * @var int
+     * @var float|int
      */
     private static $defaultFontSize = self::DEFAULT_FONT_SIZE;
 
@@ -148,23 +144,17 @@ class Settings
      *
      * @return bool Compatibility
      */
-    public static function hasCompatibility()
+    public static function hasCompatibility(): bool
     {
         return self::$xmlWriterCompatibility;
     }
 
     /**
      * Set the compatibility option used by the XMLWriter.
-     *
-     * This sets the setIndent and setIndentString for better compatibility
-     *
-     * @param bool $compatibility
-     *
-     * @return bool
+     * This sets the setIndent and setIndentString for better compatibility.
      */
-    public static function setCompatibility($compatibility)
+    public static function setCompatibility(bool $compatibility): bool
     {
-        $compatibility = (bool) $compatibility;
         self::$xmlWriterCompatibility = $compatibility;
 
         return true;
@@ -172,22 +162,16 @@ class Settings
 
     /**
      * Get zip handler class.
-     *
-     * @return string
      */
-    public static function getZipClass()
+    public static function getZipClass(): string
     {
         return self::$zipClass;
     }
 
     /**
      * Set zip handler class.
-     *
-     * @param  string $zipClass
-     *
-     * @return bool
      */
-    public static function setZipClass($zipClass)
+    public static function setZipClass(string $zipClass): bool
     {
         if (in_array($zipClass, [self::PCLZIP, self::ZIPARCHIVE, self::OLD_LIB])) {
             self::$zipClass = $zipClass;
@@ -201,12 +185,9 @@ class Settings
     /**
      * Set details of the external library for rendering PDF files.
      *
-     * @param string $libraryName
-     * @param string $libraryBaseDir
-     *
      * @return bool Success or failure
      */
-    public static function setPdfRenderer($libraryName, $libraryBaseDir)
+    public static function setPdfRenderer(string $libraryName, string $libraryBaseDir): bool
     {
         if (!self::setPdfRendererName($libraryName)) {
             return false;
@@ -217,22 +198,16 @@ class Settings
 
     /**
      * Return the PDF Rendering Library.
-     *
-     * @return string
      */
-    public static function getPdfRendererName()
+    public static function getPdfRendererName(): ?string
     {
         return self::$pdfRendererName;
     }
 
     /**
      * Identify the external library to use for rendering PDF files.
-     *
-     * @param string $libraryName
-     *
-     * @return bool
      */
-    public static function setPdfRendererName($libraryName)
+    public static function setPdfRendererName(?string $libraryName): bool
     {
         $pdfRenderers = [self::PDF_RENDERER_DOMPDF, self::PDF_RENDERER_TCPDF, self::PDF_RENDERER_MPDF];
         if (!in_array($libraryName, $pdfRenderers)) {
@@ -245,10 +220,8 @@ class Settings
 
     /**
      * Return the directory path to the PDF Rendering Library.
-     *
-     * @return string
      */
-    public static function getPdfRendererPath()
+    public static function getPdfRendererPath(): ?string
     {
         return self::$pdfRendererPath;
     }
@@ -256,11 +229,11 @@ class Settings
     /**
      * Location of external library to use for rendering PDF files.
      *
-     * @param string $libraryBaseDir Directory path to the library's base folder
+     * @param null|string $libraryBaseDir Directory path to the library's base folder
      *
      * @return bool Success or failure
      */
-    public static function setPdfRendererPath($libraryBaseDir)
+    public static function setPdfRendererPath(?string $libraryBaseDir): bool
     {
         if (!$libraryBaseDir || false === file_exists($libraryBaseDir) || false === is_readable($libraryBaseDir)) {
             return false;
@@ -272,25 +245,25 @@ class Settings
 
     /**
      * Get measurement unit.
-     *
-     * @return string
      */
-    public static function getMeasurementUnit()
+    public static function getMeasurementUnit(): string
     {
         return self::$measurementUnit;
     }
 
     /**
      * Set measurement unit.
-     *
-     * @param string $value
-     *
-     * @return bool
      */
-    public static function setMeasurementUnit($value)
+    public static function setMeasurementUnit(string $value): bool
     {
-        $units = [self::UNIT_TWIP, self::UNIT_CM, self::UNIT_MM, self::UNIT_INCH,
-            self::UNIT_POINT, self::UNIT_PICA, ];
+        $units = [
+            self::UNIT_TWIP,
+            self::UNIT_CM,
+            self::UNIT_MM,
+            self::UNIT_INCH,
+            self::UNIT_POINT,
+            self::UNIT_PICA,
+        ];
         if (!in_array($value, $units)) {
             return false;
         }
@@ -302,11 +275,11 @@ class Settings
     /**
      * Sets the user defined path to temporary directory.
      *
-     * @since 0.12.0
-     *
      * @param string $tempDir The user defined path to temporary directory
+     *
+     * @since 0.12.0
      */
-    public static function setTempDir($tempDir): void
+    public static function setTempDir(string $tempDir): void
     {
         self::$tempDir = $tempDir;
     }
@@ -315,10 +288,8 @@ class Settings
      * Returns path to temporary directory.
      *
      * @since 0.12.0
-     *
-     * @return string
      */
-    public static function getTempDir()
+    public static function getTempDir(): string
     {
         if (!empty(self::$tempDir)) {
             $tempDir = self::$tempDir;
@@ -331,44 +302,34 @@ class Settings
 
     /**
      * @since 0.13.0
-     *
-     * @return bool
      */
-    public static function isOutputEscapingEnabled()
+    public static function isOutputEscapingEnabled(): bool
     {
         return self::$outputEscapingEnabled;
     }
 
     /**
      * @since 0.13.0
-     *
-     * @param bool $outputEscapingEnabled
      */
-    public static function setOutputEscapingEnabled($outputEscapingEnabled): void
+    public static function setOutputEscapingEnabled(bool $outputEscapingEnabled): void
     {
         self::$outputEscapingEnabled = $outputEscapingEnabled;
     }
 
     /**
      * Get default font name.
-     *
-     * @return string
      */
-    public static function getDefaultFontName()
+    public static function getDefaultFontName(): string
     {
         return self::$defaultFontName;
     }
 
     /**
      * Set default font name.
-     *
-     * @param string $value
-     *
-     * @return bool
      */
-    public static function setDefaultFontName($value)
+    public static function setDefaultFontName(string $value): bool
     {
-        if (is_string($value) && trim($value) !== '') {
+        if (trim($value) !== '') {
             self::$defaultFontName = $value;
 
             return true;
@@ -380,7 +341,7 @@ class Settings
     /**
      * Get default font size.
      *
-     * @return int
+     * @return float|int
      */
     public static function getDefaultFontSize()
     {
@@ -390,14 +351,11 @@ class Settings
     /**
      * Set default font size.
      *
-     * @param int $value
-     *
-     * @return bool
+     * @param null|float|int $value
      */
-    public static function setDefaultFontSize($value)
+    public static function setDefaultFontSize($value): bool
     {
-        $value = (int) $value;
-        if ($value > 0) {
+        if ((is_int($value) || is_float($value)) && (int) $value > 0) {
             self::$defaultFontSize = $value;
 
             return true;
@@ -408,12 +366,8 @@ class Settings
 
     /**
      * Load setting from phpword.yml or phpword.yml.dist.
-     *
-     * @param string $filename
-     *
-     * @return array
      */
-    public static function loadConfig($filename = null)
+    public static function loadConfig(?string $filename = null): array
     {
         // Get config file
         $configFile = null;
@@ -455,24 +409,18 @@ class Settings
 
     /**
      * Get default paper.
-     *
-     * @return string
      */
-    public static function getDefaultPaper()
+    public static function getDefaultPaper(): string
     {
         return self::$defaultPaper;
     }
 
     /**
      * Set default paper.
-     *
-     * @param string $value
-     *
-     * @return bool
      */
-    public static function setDefaultPaper($value)
+    public static function setDefaultPaper(string $value): bool
     {
-        if (is_string($value) && trim($value) !== '') {
+        if (trim($value) !== '') {
             self::$defaultPaper = $value;
 
             return true;

src/PhpWord/Shared/Html.php

@@ -444,7 +444,11 @@ class Html
             $rowStyles['tblHeader'] = true;
         }
 
-        return $element->addRow(null, $rowStyles);
+        // set cell height to control row heights
+        $height = $rowStyles['height'] ?? null;
+        unset($rowStyles['height']); // would not apply
+
+        return $element->addRow($height, $rowStyles);
     }
 
     /**
@@ -808,6 +812,11 @@ class Html
                         $styles['unit'] = \PhpOffice\PhpWord\SimpleType\TblWidth::AUTO;
                     }
 
+                    break;
+                case 'height':
+                    $styles['height'] = Converter::cssToTwip($value);
+                    $styles['exactHeight'] = true;
+
                     break;
                 case 'border':
                 case 'border-top':

src/PhpWord/Style/Cell.php

@@ -286,7 +286,7 @@ class Cell extends Border
      */
     public function setWidth($value)
     {
-        $this->setIntVal($value);
+        $this->width = $this->setIntVal($value);
 
         return $this;
     }

src/PhpWord/Style/TextBox.php

@@ -2,10 +2,8 @@
 /**
  * This file is part of PHPWord - A pure PHP library for reading and writing
  * word processing documents.
- *
  * PHPWord is free software distributed under the terms of the GNU Lesser
  * General Public License version 3 as published by the Free Software Foundation.
- *
  * For the full copyright and license information, please read the LICENSE
  * file that was distributed with this source code. For the full list of
  * contributors, visit https://github.com/PHPOffice/PHPWord/contributors.
@@ -27,121 +25,128 @@ class TextBox extends Image
     /**
      * margin top.
      *
-     * @var int
+     * @var null|int
      */
     private $innerMarginTop;
 
     /**
      * margin left.
      *
-     * @var int
+     * @var null|int
      */
     private $innerMarginLeft;
 
     /**
      * margin right.
      *
-     * @var int
+     * @var null|int
      */
     private $innerMarginRight;
 
     /**
      * Cell margin bottom.
      *
-     * @var int
+     * @var null|int
      */
     private $innerMarginBottom;
 
     /**
      * border size.
      *
-     * @var int
+     * @var null|int
      */
     private $borderSize;
 
     /**
      * border color.
      *
-     * @var string
+     * @var null|string
      */
     private $borderColor;
 
     /**
-     * Set margin top.
+     * background color.
      *
-     * @param int $value
+     * @var null|string
      */
-    public function setInnerMarginTop($value = null): void
+    private $bgColor;
+
+    /**
+     * Set background color.
+     */
+    public function setBgColor(?string $value = null): void
+    {
+        $this->bgColor = $value;
+    }
+
+    /**
+     * Get background color.
+     */
+    public function getBgColor(): ?string
+    {
+        return $this->bgColor;
+    }
+
+    /**
+     * Set margin top.
+     */
+    public function setInnerMarginTop(?int $value = null): void
     {
         $this->innerMarginTop = $value;
     }
 
     /**
      * Get margin top.
-     *
-     * @return int
      */
-    public function getInnerMarginTop()
+    public function getInnerMarginTop(): ?int
     {
         return $this->innerMarginTop;
     }
 
     /**
      * Set margin left.
-     *
-     * @param int $value
      */
-    public function setInnerMarginLeft($value = null): void
+    public function setInnerMarginLeft(?int $value = null): void
     {
         $this->innerMarginLeft = $value;
     }
 
     /**
      * Get margin left.
-     *
-     * @return int
      */
-    public function getInnerMarginLeft()
+    public function getInnerMarginLeft(): ?int
     {
         return $this->innerMarginLeft;
     }
 
     /**
      * Set margin right.
-     *
-     * @param int $value
      */
-    public function setInnerMarginRight($value = null): void
+    public function setInnerMarginRight(?int $value = null): void
     {
         $this->innerMarginRight = $value;
     }
 
     /**
      * Get margin right.
-     *
-     * @return int
      */
-    public function getInnerMarginRight()
+    public function getInnerMarginRight(): ?int
     {
         return $this->innerMarginRight;
     }
 
     /**
      * Set margin bottom.
-     *
-     * @param int $value
      */
-    public function setInnerMarginBottom($value = null): void
+    public function setInnerMarginBottom(?int $value = null): void
     {
         $this->innerMarginBottom = $value;
     }
 
     /**
      * Get margin bottom.
-     *
-     * @return int
      */
-    public function getInnerMarginBottom()
+    public function getInnerMarginBottom(): ?int
     {
         return $this->innerMarginBottom;
     }
@@ -149,9 +154,9 @@ class TextBox extends Image
     /**
      * Set TLRB cell margin.
      *
-     * @param int $value Margin in twips
+     * @param null|int $value Margin in twips
      */
-    public function setInnerMargin($value = null): void
+    public function setInnerMargin(?int $value = null): void
     {
         $this->setInnerMarginTop($value);
         $this->setInnerMarginLeft($value);
@@ -164,17 +169,15 @@ class TextBox extends Image
      *
      * @return int[]
      */
-    public function getInnerMargin()
+    public function getInnerMargin(): array
     {
         return [$this->innerMarginLeft, $this->innerMarginTop, $this->innerMarginRight, $this->innerMarginBottom];
     }
 
     /**
      * Has inner margin?
-     *
-     * @return bool
      */
-    public function hasInnerMargins()
+    public function hasInnerMargins(): bool
     {
         $hasInnerMargins = false;
         $margins = $this->getInnerMargin();
@@ -191,39 +194,33 @@ class TextBox extends Image
     /**
      * Set border size.
      *
-     * @param int $value Size in points
+     * @param null|int $value Size in points
      */
-    public function setBorderSize($value = null): void
+    public function setBorderSize(?int $value = null): void
     {
         $this->borderSize = $value;
     }
 
     /**
      * Get border size.
-     *
-     * @return int
      */
-    public function getBorderSize()
+    public function getBorderSize(): ?int
     {
         return $this->borderSize;
     }
 
     /**
      * Set border color.
-     *
-     * @param string $value
      */
-    public function setBorderColor($value = null): void
+    public function setBorderColor(?string $value = null): void
     {
         $this->borderColor = $value;
     }
 
     /**
      * Get border color.
-     *
-     * @return string
      */
-    public function getBorderColor()
+    public function getBorderColor(): ?string
     {
         return $this->borderColor;
     }

src/PhpWord/TemplateProcessor.php

@@ -94,6 +94,10 @@ class TemplateProcessor
      */
     protected $tempDocumentNewImages = [];
 
+    protected static $macroOpeningChars = '${';
+
+    protected static $macroClosingChars = '}';
+
     /**
      * @since 0.12.0 Throws CreateTemporaryFileException and CopyFileException instead of Exception
      *
@@ -238,8 +242,8 @@ class TemplateProcessor
      */
     protected static function ensureMacroCompleted($macro)
     {
-        if (substr($macro, 0, 2) !== '${' && substr($macro, -1) !== '}') {
-            $macro = '${' . $macro . '}';
+        if (substr($macro, 0, 2) !== self::$macroOpeningChars && substr($macro, -1) !== self::$macroClosingChars) {
+            $macro = self::$macroOpeningChars . $macro . self::$macroClosingChars;
         }
 
         return $macro;
@@ -856,8 +860,12 @@ class TemplateProcessor
     {
         $xmlBlock = null;
         $matches = [];
+        $escapedMacroOpeningChars = self::$macroOpeningChars;
+        $escapedMacroClosingChars = self::$macroClosingChars;
         preg_match(
-            '/(.*((?s)<w:p\b(?:(?!<w:p\b).)*?\${' . $blockname . '}<\/w:.*?p>))(.*)((?s)<w:p\b(?:(?!<w:p\b).)[^$]*?\${\/' . $blockname . '}<\/w:.*?p>)/is',
+            //'/(.*((?s)<w:p\b(?:(?!<w:p\b).)*?\{{' . $blockname . '}<\/w:.*?p>))(.*)((?s)<w:p\b(?:(?!<w:p\b).)[^$]*?\{{\/' . $blockname . '}<\/w:.*?p>)/is',
+            '/(.*((?s)<w:p\b(?:(?!<w:p\b).)*?\\' . $escapedMacroOpeningChars . $blockname . $escapedMacroClosingChars . '<\/w:.*?p>))(.*)((?s)<w:p\b(?:(?!<w:p\b).)[^$]*?\\' . $escapedMacroOpeningChars . '\/' . $blockname . $escapedMacroClosingChars . '<\/w:.*?p>)/is',
+            //'/(.*((?s)<w:p\b(?:(?!<w:p\b).)*?\\'. $escapedMacroOpeningChars . $blockname . '}<\/w:.*?p>))(.*)((?s)<w:p\b(?:(?!<w:p\b).)[^$]*?\\'.$escapedMacroOpeningChars.'\/' . $blockname . '}<\/w:.*?p>)/is',
             $this->tempDocumentMainPart,
             $matches
         );
@@ -896,8 +904,10 @@ class TemplateProcessor
     public function replaceBlock($blockname, $replacement): void
     {
         $matches = [];
+        $escapedMacroOpeningChars = preg_quote(self::$macroOpeningChars);
+        $escapedMacroClosingChars = preg_quote(self::$macroClosingChars);
         preg_match(
-            '/(<\?xml.*)(<w:p.*>\${' . $blockname . '}<\/w:.*?p>)(.*)(<w:p.*\${\/' . $blockname . '}<\/w:.*?p>)/is',
+            '/(<\?xml.*)(<w:p.*>' . $escapedMacroOpeningChars . $blockname . $escapedMacroClosingChars . '<\/w:.*?p>)(.*)(<w:p.*' . $escapedMacroOpeningChars . '\/' . $blockname . $escapedMacroClosingChars . '<\/w:.*?p>)/is',
             $this->tempDocumentMainPart,
             $matches
         );
@@ -1013,8 +1023,12 @@ class TemplateProcessor
      */
     protected function fixBrokenMacros($documentPart)
     {
+        $brokenMacroOpeningChars = substr(self::$macroOpeningChars, 0, 1);
+        $endMacroOpeningChars = substr(self::$macroOpeningChars, 1);
+        $macroClosingChars = self::$macroClosingChars;
+
         return preg_replace_callback(
-            '/\$(?:\{|[^{$]*\>\{)[^}$]*\}/U',
+            '/\\' . $brokenMacroOpeningChars . '(?:\\' . $endMacroOpeningChars . '|[^{$]*\>\{)[^' . $macroClosingChars . '$]*\}/U',
             function ($match) {
                 return strip_tags($match[0]);
             },
@@ -1053,7 +1067,10 @@ class TemplateProcessor
     protected function getVariablesForPart($documentPartXML)
     {
         $matches = [];
-        preg_match_all('/\$\{(.*?)}/i', $documentPartXML, $matches);
+        $escapedMacroOpeningChars = preg_quote(self::$macroOpeningChars);
+        $escapedMacroClosingChars = preg_quote(self::$macroClosingChars);
+
+        preg_match_all("/$escapedMacroOpeningChars(.*?)$escapedMacroClosingChars/i", $documentPartXML, $matches);
 
         return $matches[1];
     }
@@ -1238,8 +1255,11 @@ class TemplateProcessor
     protected function indexClonedVariables($count, $xmlBlock)
     {
         $results = [];
+        $escapedMacroOpeningChars = preg_quote(self::$macroOpeningChars);
+        $escapedMacroClosingChars = preg_quote(self::$macroClosingChars);
+
         for ($i = 1; $i <= $count; ++$i) {
-            $results[] = preg_replace('/\$\{([^:]*?)(:.*?)?\}/', '\${\1#' . $i . '\2}', $xmlBlock);
+            $results[] = preg_replace("/$escapedMacroOpeningChars([^:]*?)(:.*?)?$escapedMacroClosingChars/", self::$macroOpeningChars . '\1#' . $i . '\2' . self::$macroClosingChars, $xmlBlock);
         }
 
         return $results;
@@ -1394,7 +1414,7 @@ class TemplateProcessor
         }
 
         $unformattedText = preg_replace('/>\s+</', '><', $text);
-        $result = str_replace(['${', '}'], ['</w:t></w:r><w:r>' . $extractedStyle . '<w:t xml:space="preserve">${', '}</w:t></w:r><w:r>' . $extractedStyle . '<w:t xml:space="preserve">'], $unformattedText);
+        $result = str_replace([self::$macroOpeningChars, self::$macroClosingChars], ['</w:t></w:r><w:r>' . $extractedStyle . '<w:t xml:space="preserve">' . self::$macroOpeningChars, self::$macroClosingChars . '</w:t></w:r><w:r>' . $extractedStyle . '<w:t xml:space="preserve">'], $unformattedText);
 
         return str_replace(['<w:r>' . $extractedStyle . '<w:t xml:space="preserve"></w:t></w:r>', '<w:r><w:t xml:space="preserve"></w:t></w:r>', '<w:t>'], ['', '', '<w:t xml:space="preserve">'], $result);
     }
@@ -1408,6 +1428,25 @@ class TemplateProcessor
      */
     protected function textNeedsSplitting($text)
     {
-        return preg_match('/[^>]\${|}[^<]/i', $text) == 1;
+        $escapedMacroOpeningChars = preg_quote(self::$macroOpeningChars);
+        $escapedMacroClosingChars = preg_quote(self::$macroClosingChars);
+
+        return 1 === preg_match('/[^>]' . $escapedMacroOpeningChars . '|' . $escapedMacroClosingChars . '[^<]/i', $text);
+    }
+
+    public function setMacroOpeningChars(string $macroOpeningChars): void
+    {
+        self::$macroOpeningChars = $macroOpeningChars;
+    }
+
+    public function setMacroClosingChars(string $macroClosingChars): void
+    {
+        self::$macroClosingChars = $macroClosingChars;
+    }
+
+    public function setMacroChars(string $macroOpeningChars, string $macroClosingChars): void
+    {
+        self::$macroOpeningChars = $macroOpeningChars;
+        self::$macroClosingChars = $macroClosingChars;
     }
 }

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

@@ -2,10 +2,8 @@
 /**
  * This file is part of PHPWord - A pure PHP library for reading and writing
  * word processing documents.
- *
  * PHPWord is free software distributed under the terms of the GNU Lesser
  * General Public License version 3 as published by the Free Software Foundation.
- *
  * For the full copyright and license information, please read the LICENSE
  * file that was distributed with this source code. For the full list of
  * contributors, visit https://github.com/PHPOffice/PHPWord/contributors.
@@ -50,6 +48,10 @@ class TextBox extends Image
         $xmlWriter->startElement('v:shape');
         $xmlWriter->writeAttribute('type', '#_x0000_t0202');
 
+        if ($style->getBgColor()) {
+            $xmlWriter->writeAttribute('fillcolor', $style->getBgColor());
+        }
+
         $styleWriter->write();
         $styleWriter->writeBorder();
 

src/PhpWord/Writer/Word2007/Style/TextBox.php

@@ -2,10 +2,8 @@
 /**
  * This file is part of PHPWord - A pure PHP library for reading and writing
  * word processing documents.
- *
  * PHPWord is free software distributed under the terms of the GNU Lesser
  * General Public License version 3 as published by the Free Software Foundation.
- *
  * For the full copyright and license information, please read the LICENSE
  * file that was distributed with this source code. For the full list of
  * contributors, visit https://github.com/PHPOffice/PHPWord/contributors.

tests/PhpWordTests/SettingsTest.php

@@ -2,10 +2,8 @@
 /**
  * This file is part of PHPWord - A pure PHP library for reading and writing
  * word processing documents.
- *
  * PHPWord is free software distributed under the terms of the GNU Lesser
  * General Public License version 3 as published by the Free Software Foundation.
- *
  * For the full copyright and license information, please read the LICENSE
  * file that was distributed with this source code. For the full list of
  * contributors, visit https://github.com/PHPOffice/PHPWord/contributors.
@@ -19,15 +17,15 @@ namespace PhpOffice\PhpWordTests;
 
 use PhpOffice\PhpWord\PhpWord;
 use PhpOffice\PhpWord\Settings;
+use PHPUnit\Framework\TestCase;
 
 /**
  * Test class for PhpOffice\PhpWord\Settings.
  *
  * @coversDefaultClass \PhpOffice\PhpWord\Settings
- *
  * @runTestsInSeparateProcesses
  */
-class SettingsTest extends \PHPUnit\Framework\TestCase
+class SettingsTest extends TestCase
 {
     private $compatibility;
 
@@ -151,7 +149,6 @@ class SettingsTest extends \PHPUnit\Framework\TestCase
     /**
      * @covers ::getTempDir
      * @covers ::setTempDir
-     *
      * @depends testPhpTempDirIsUsedByDefault
      */
     public function testTempDirCanBeSet(): void
@@ -189,6 +186,12 @@ class SettingsTest extends \PHPUnit\Framework\TestCase
         self::assertEquals(12, Settings::getDefaultFontSize());
         self::assertFalse(Settings::setDefaultFontSize(null));
         self::assertEquals(12, Settings::getDefaultFontSize());
+        self::assertTrue(Settings::setDefaultFontSize(12.5));
+        self::assertEquals(12.5, Settings::getDefaultFontSize());
+        self::assertFalse(Settings::setDefaultFontSize(0.5));
+        self::assertEquals(12.5, Settings::getDefaultFontSize());
+        self::assertFalse(Settings::setDefaultFontSize(0));
+        self::assertEquals(12.5, Settings::getDefaultFontSize());
     }
 
     /**

tests/PhpWordTests/Shared/HtmlTest.php

@@ -464,6 +464,58 @@ HTML;
         self::assertEquals('dxa', $doc->getElement($xpath)->getAttribute('w:type'));
     }
 
+    /**
+     * Parse heights in rows, which also allows for controlling column height.
+     */
+    public function testParseTableRowHeight(): void
+    {
+        $phpWord = new PhpWord();
+        $section = $phpWord->addSection([
+            'orientation' => \PhpOffice\PhpWord\Style\Section::ORIENTATION_LANDSCAPE,
+        ]);
+
+        $html = <<<HTML
+<table>
+    <tr style="height: 100px;">
+        <td>100px</td>
+    </tr>
+    <tr style="height: 200pt;">
+        <td>200pt</td>
+    </tr>
+    <tr>
+        <td>
+            <table>
+                <tr style="height: 300px;">
+                    <td>300px</td>
+                </tr>
+            </table>
+        </td>
+    </tr>
+</table>
+HTML;
+
+        Html::addHtml($section, $html);
+        $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007');
+
+        // <tr style="height: 100; ... 100px = 1500 twips (100 / 96 * 1440)
+        $xpath = '/w:document/w:body/w:tbl/w:tr/w:trPr/w:trHeight';
+        self::assertTrue($doc->elementExists($xpath));
+        self::assertEquals(1500, $doc->getElement($xpath)->getAttribute('w:val'));
+        self::assertEquals('exact', $doc->getElement($xpath)->getAttribute('w:hRule'));
+
+        // <tr style="height: 200pt; ... 200pt = 4000 twips (200 / 72 * 1440)
+        $xpath = '/w:document/w:body/w:tbl/w:tr[2]/w:trPr/w:trHeight';
+        self::assertTrue($doc->elementExists($xpath));
+        self::assertEquals(4000, $doc->getElement($xpath)->getAttribute('w:val'));
+        self::assertEquals('exact', $doc->getElement($xpath)->getAttribute('w:hRule'));
+
+        // <tr style="width: 300; .. 300px = 4500 twips (300 / 72 * 1440)
+        $xpath = '/w:document/w:body/w:tbl/w:tr[3]/w:tc/w:tbl/w:tr/w:trPr/w:trHeight';
+        self::assertTrue($doc->elementExists($xpath));
+        self::assertEquals(4500, $doc->getElement($xpath)->getAttribute('w:val'));
+        self::assertEquals('exact', $doc->getElement($xpath)->getAttribute('w:hRule'));
+    }
+
     /**
      * Test parsing table (attribute border).
      */

tests/PhpWordTests/Style/TextBoxTest.php

@@ -2,10 +2,8 @@
 /**
  * This file is part of PHPWord - A pure PHP library for reading and writing
  * word processing documents.
- *
  * PHPWord is free software distributed under the terms of the GNU Lesser
  * General Public License version 3 as published by the Free Software Foundation.
- *
  * For the full copyright and license information, please read the LICENSE
  * file that was distributed with this source code. For the full list of
  * contributors, visit https://github.com/PHPOffice/PHPWord/contributors.
@@ -20,15 +18,15 @@ namespace PhpOffice\PhpWordTests\Style;
 use InvalidArgumentException;
 use PhpOffice\PhpWord\SimpleType\Jc;
 use PhpOffice\PhpWord\Style\TextBox;
+use PHPUnit\Framework\TestCase;
 
 /**
  * Test class for PhpOffice\PhpWord\Style\Image.
  *
  * @coversDefaultClass \PhpOffice\PhpWord\Style\Image
- *
  * @runTestsInSeparateProcesses
  */
-class TextBoxTest extends \PHPUnit\Framework\TestCase
+class TextBoxTest extends TestCase
 {
     /**
      * Test setting style with normal value.
@@ -55,6 +53,7 @@ class TextBoxTest extends \PHPUnit\Framework\TestCase
             'innerMarginLeft' => '5',
             'borderSize' => '2',
             'borderColor' => 'red',
+            'bgColor' => 'blue',
         ];
         foreach ($properties as $key => $value) {
             $set = "set{$key}";
@@ -89,6 +88,7 @@ class TextBoxTest extends \PHPUnit\Framework\TestCase
             'innerMarginLeft' => '5',
             'borderSize' => '2',
             'borderColor' => 'red',
+            'bgColor' => 'blue',
         ];
         foreach ($properties as $key => $value) {
             $get = "get{$key}";
@@ -305,4 +305,15 @@ class TextBoxTest extends \PHPUnit\Framework\TestCase
         $object->setBorderColor($expected);
         self::assertEquals($expected, $object->getBorderColor());
     }
+
+    /**
+     * Test set/get bgColor.
+     */
+    public function testSetGetBgColor(): void
+    {
+        $expected = 'blue';
+        $object = new TextBox();
+        $object->setBgColor($expected);
+        self::assertEquals($expected, $object->getBgColor());
+    }
 }

tests/PhpWordTests/TemplateProcessorTest.php

@@ -232,6 +232,33 @@ final class TemplateProcessorTest extends \PHPUnit\Framework\TestCase
         self::assertTrue($docFound);
     }
 
+    /**
+     * @covers ::cloneRow
+     * @covers ::saveAs
+     * @covers ::setValue
+     */
+    public function testCloneRowWithCustomMacro(): void
+    {
+        $templateProcessor = new TemplateProcessor(__DIR__ . '/_files/templates/clone-merge-with-custom-macro.docx');
+
+        $templateProcessor->setMacroOpeningChars('{#');
+        $templateProcessor->setMacroClosingChars('#}');
+
+        self::assertEquals(
+            ['tableHeader', 'userId', 'userName', 'userLocation'],
+            $templateProcessor->getVariables()
+        );
+
+        $docName = 'clone-test-result.docx';
+        $templateProcessor->setValue('tableHeader', utf8_decode('ééé'));
+        $templateProcessor->cloneRow('userId', 1);
+        $templateProcessor->setValue('userId#1', 'Test');
+        $templateProcessor->saveAs($docName);
+        $docFound = file_exists($docName);
+        unlink($docName);
+        self::assertTrue($docFound);
+    }
+
     /**
      * @covers ::cloneRow
      * @covers ::saveAs
@@ -301,6 +328,68 @@ final class TemplateProcessorTest extends \PHPUnit\Framework\TestCase
         $templateProcessor->cloneRow('fake_search', 2);
     }
 
+    /**
+     * @covers ::cloneRow
+     * @covers ::saveAs
+     * @covers ::setValue
+     */
+    public function testCloneRowAndSetValuesWithCustomMacro(): void
+    {
+        $mainPart = '<w:tbl>
+            <w:tr>
+                <w:tc>
+                    <w:tcPr>
+                        <w:vMerge w:val="restart"/>
+                    </w:tcPr>
+                    <w:p>
+                        <w:r>
+                            <w:t>{{userId}}</w:t>
+                        </w:r>
+                    </w:p>
+                </w:tc>
+                <w:tc>
+                    <w:p>
+                        <w:r>
+                            <w:t>{{userName}}</w:t>
+                        </w:r>
+                    </w:p>
+                </w:tc>
+            </w:tr>
+            <w:tr>
+                <w:tc>
+                    <w:tcPr>
+                        <w:vMerge/>
+                    </w:tcPr>
+                    <w:p/>
+                </w:tc>
+                <w:tc>
+                    <w:p>
+                        <w:r>
+                            <w:t>{{userLocation}}</w:t>
+                        </w:r>
+                    </w:p>
+                </w:tc>
+            </w:tr>
+        </w:tbl>';
+        $templateProcessor = new TestableTemplateProcesor($mainPart);
+        $templateProcessor->setMacroOpeningChars('{{');
+        $templateProcessor->setMacroClosingChars('}}');
+
+        self::assertEquals(
+            ['userId', 'userName', 'userLocation'],
+            $templateProcessor->getVariables()
+        );
+
+        $values = [
+            ['userId' => 1, 'userName' => 'Batman', 'userLocation' => 'Gotham City'],
+            ['userId' => 2, 'userName' => 'Superman', 'userLocation' => 'Metropolis'],
+        ];
+        $templateProcessor->setValue('tableHeader', 'My clonable table');
+        $templateProcessor->cloneRowAndSetValues('userId', $values);
+        self::assertStringContainsString('<w:t>Superman</w:t>', $templateProcessor->getMainPart());
+        self::assertStringContainsString('<w:t>Metropolis</w:t>', $templateProcessor->getMainPart());
+    }
+
     /**
      * @covers ::saveAs
      * @covers ::setValue
@@ -322,6 +411,29 @@ final class TemplateProcessorTest extends \PHPUnit\Framework\TestCase
         self::assertTrue($docFound);
     }
 
+    /**
+     * @covers ::saveAs
+     * @covers ::setValue
+     */
+    public function testCustomMacrosCanBeReplacedInHeaderAndFooter(): void
+    {
+        $templateProcessor = new TemplateProcessor(__DIR__ . '/_files/templates/header-footer-with-custom-macro.docx');
+        $templateProcessor->setMacroOpeningChars('{{');
+        $templateProcessor->setMacroClosingChars('}}');
+
+        self::assertEquals(['documentContent', 'headerValue:100:100', 'footerValue'], $templateProcessor->getVariables());
+
+        $macroNames = ['headerValue', 'documentContent', 'footerValue'];
+        $macroValues = ['Header Value', 'Document text.', 'Footer Value'];
+        $templateProcessor->setValue($macroNames, $macroValues);
+
+        $docName = 'header-footer-test-result.docx';
+        $templateProcessor->saveAs($docName);
+        $docFound = file_exists($docName);
+        unlink($docName);
+        self::assertTrue($docFound);
+    }
+
     /**
      * @covers ::setValue
      */
@@ -337,6 +449,22 @@ final class TemplateProcessorTest extends \PHPUnit\Framework\TestCase
         );
     }
 
+    /**
+     * @covers ::setValue
+     */
+    public function testSetValueWithCustomMacro(): void
+    {
+        $templateProcessor = new TemplateProcessor(__DIR__ . '/_files/templates/clone-merge-with-custom-macro.docx');
+        $templateProcessor->setMacroChars('{#', '#}');
+        Settings::setOutputEscapingEnabled(true);
+        $helloworld = "hello\nworld";
+        $templateProcessor->setValue('userName', $helloworld);
+        self::assertEquals(
+            ['tableHeader', 'userId', 'userLocation'],
+            $templateProcessor->getVariables()
+        );
+    }
+
     public function testSetComplexValue(): void
     {
         $title = new TextRun();
@@ -390,6 +518,60 @@ final class TemplateProcessorTest extends \PHPUnit\Framework\TestCase
         self::assertEquals(preg_replace('/>\s+</', '><', $result), preg_replace('/>\s+</', '><', $templateProcessor->getMainPart()));
     }
 
+    public function testSetComplexValueWithCustomMacro(): void
+    {
+        $title = new TextRun();
+        $title->addText('This is my title');
+
+        $firstname = new Text('Donald');
+        $lastname = new Text('Duck');
+
+        $mainPart = '<?xml version="1.0" encoding="UTF-8"?>
+        <w:p>
+            <w:r>
+                <w:t xml:space="preserve">Hello {{document-title}}</w:t>
+            </w:r>
+        </w:p>
+        <w:p>
+            <w:r>
+                <w:t xml:space="preserve">Hello {{firstname}} {{lastname}}</w:t>
+            </w:r>
+        </w:p>';
+
+        $result = '<?xml version="1.0" encoding="UTF-8"?>
+        <w:p>
+            <w:pPr/>
+            <w:r>
+                <w:rPr/>
+                <w:t xml:space="preserve">This is my title</w:t>
+            </w:r>
+        </w:p>
+        <w:p>
+            <w:r>
+                <w:t xml:space="preserve">Hello </w:t>
+            </w:r>
+            <w:r>
+                <w:rPr/>
+                <w:t xml:space="preserve">Donald</w:t>
+            </w:r>
+            <w:r>
+                <w:t xml:space="preserve"> </w:t>
+            </w:r>
+            <w:r>
+                <w:rPr/>
+                <w:t xml:space="preserve">Duck</w:t>
+            </w:r>
+        </w:p>';
+
+        $templateProcessor = new TestableTemplateProcesor($mainPart);
+        $templateProcessor->setMacroChars('{{', '}}');
+        $templateProcessor->setComplexBlock('document-title', $title);
+        $templateProcessor->setComplexValue('firstname', $firstname);
+        $templateProcessor->setComplexValue('lastname', $lastname);
+
+        self::assertEquals(preg_replace('/>\s+</', '><', $result), preg_replace('/>\s+</', '><', $templateProcessor->getMainPart()));
+    }
+
     /**
      * @covers ::setValues
      */
@@ -408,6 +590,25 @@ final class TemplateProcessorTest extends \PHPUnit\Framework\TestCase
         self::assertStringContainsString('Hello John Doe', $templateProcessor->getMainPart());
     }
 
+    /**
+     * @covers ::setValues
+     */
+    public function testSetValuesWithCustomMacro(): void
+    {
+        $mainPart = '<?xml version="1.0" encoding="UTF-8"?>
+        <w:p>
+            <w:r>
+                <w:t xml:space="preserve">Hello {#firstname#} {#lastname#}</w:t>
+            </w:r>
+        </w:p>';
+
+        $templateProcessor = new TestableTemplateProcesor($mainPart);
+        $templateProcessor->setMacroChars('{#', '#}');
+        $templateProcessor->setValues(['firstname' => 'John', 'lastname' => 'Doe']);
+
+        self::assertStringContainsString('Hello John Doe', $templateProcessor->getMainPart());
+    }
+
     /**
      * @covers ::setImageValue
      */
@@ -547,6 +748,44 @@ final class TemplateProcessorTest extends \PHPUnit\Framework\TestCase
         );
     }
 
+    /**
+     * @covers ::getVariableCount
+     */
+    public function testGetVariableCountCountsHowManyTimesEachPlaceholderIsPresentWithCustomMacro(): void
+    {
+        // create template with placeholders
+        $phpWord = new PhpWord();
+        $section = $phpWord->addSection();
+        $header = $section->addHeader();
+        $header->addText('{{a_field_that_is_present_three_times}}');
+        $footer = $section->addFooter();
+        $footer->addText('{{a_field_that_is_present_twice}}');
+        $section2 = $phpWord->addSection();
+        $section2->addText('
+                {{a_field_that_is_present_one_time}}
+                  {{a_field_that_is_present_three_times}}
+              {{a_field_that_is_present_twice}}
+                   {{a_field_that_is_present_three_times}}
+        ');
+        $objWriter = IOFactory::createWriter($phpWord);
+        $templatePath = 'test.docx';
+        $objWriter->save($templatePath);
+
+        $templateProcessor = new TemplateProcessor($templatePath);
+        $templateProcessor->setMacroChars('{{', '}}');
+        $variableCount = $templateProcessor->getVariableCount();
+        unlink($templatePath);
+
+        self::assertEquals(
+            [
+                'a_field_that_is_present_three_times' => 3,
+                'a_field_that_is_present_twice' => 2,
+                'a_field_that_is_present_one_time' => 1,
+            ],
+            $variableCount
+        );
+    }
+
     /**
      * @covers ::cloneBlock
      */
@@ -600,6 +839,61 @@ final class TemplateProcessorTest extends \PHPUnit\Framework\TestCase
         }
     }
 
+    /**
+     * @covers ::cloneBlock
+     */
+    public function testCloneBlockCanCloneABlockTwiceWithCustomMacro(): void
+    {
+        // create template with placeholders and block
+        $phpWord = new PhpWord();
+        $section = $phpWord->addSection();
+        $documentElements = [
+            'Title: {{title}}',
+            '{{subreport}}',
+            '{{subreport.id}}: {{subreport.text}}. ',
+            '{{/subreport}}',
+        ];
+        foreach ($documentElements as $documentElement) {
+            $section->addText($documentElement);
+        }
+
+        $objWriter = IOFactory::createWriter($phpWord);
+        $templatePath = 'test.docx';
+        $objWriter->save($templatePath);
+
+        // replace placeholders and save the file
+        $templateProcessor = new TemplateProcessor($templatePath);
+        $templateProcessor->setMacroChars('{{', '}}');
+        $templateProcessor->setValue('title', 'Some title');
+        $templateProcessor->cloneBlock('subreport', 2);
+        $templateProcessor->setValue('subreport.id', '123', 1);
+        $templateProcessor->setValue('subreport.text', 'Some text', 1);
+        $templateProcessor->setValue('subreport.id', '456', 1);
+        $templateProcessor->setValue('subreport.text', 'Some other text', 1);
+        $templateProcessor->saveAs($templatePath);
+
+        // assert the block has been cloned twice
+        // and the placeholders have been replaced correctly
+        $phpWord = IOFactory::load($templatePath);
+        $sections = $phpWord->getSections();
+        /** @var \PhpOffice\PhpWord\Element\TextRun[] $actualElements */
+        $actualElements = $sections[0]->getElements();
+
+        unlink($templatePath);
+        $expectedElements = [
+            'Title: Some title',
+            '123: Some text. ',
+            '456: Some other text. ',
+        ];
+        self::assertCount(count($expectedElements), $actualElements);
+        foreach ($expectedElements as $i => $expectedElement) {
+            self::assertEquals(
+                $expectedElement,
+                $actualElements[$i]->getElement(0)->getText()
+            );
+        }
+    }
+
     /**
      * @covers ::cloneBlock
      */
@@ -629,6 +923,36 @@ final class TemplateProcessorTest extends \PHPUnit\Framework\TestCase
         self::assertEquals(3, substr_count($templateProcessor->getMainPart(), 'This block will be cloned with ${variable}'));
     }
 
+    /**
+     * @covers ::cloneBlock
+     */
+    public function testCloneBlockWithCustomMacro(): void
+    {
+        $mainPart = '<?xml version="1.0" encoding="UTF-8"?>
+        <w:p>
+            <w:r>
+                <w:rPr></w:rPr>
+                <w:t>{{CLONEME}}</w:t>
+            </w:r>
+        </w:p>
+        <w:p>
+            <w:r>
+                <w:t xml:space="preserve">This block will be cloned with {{variable}}</w:t>
+            </w:r>
+        </w:p>
+        <w:p>
+            <w:r w:rsidRPr="00204FED">
+                <w:t>{{/CLONEME}}</w:t>
+            </w:r>
+        </w:p>';
+
+        $templateProcessor = new TestableTemplateProcesor($mainPart);
+        $templateProcessor->setMacroChars('{{', '}}');
+        $templateProcessor->cloneBlock('CLONEME', 3);
+
+        self::assertEquals(3, substr_count($templateProcessor->getMainPart(), 'This block will be cloned with {{variable}}'));
+    }
+
     /**
      * @covers ::cloneBlock
      */
@@ -660,6 +984,38 @@ final class TemplateProcessorTest extends \PHPUnit\Framework\TestCase
         self::assertStringContainsString('Address ${address#3}, Street ${street#3}', $templateProcessor->getMainPart());
     }
 
+    /**
+     * @covers ::cloneBlock
+     */
+    public function testCloneBlockWithVariablesAndCustomMacro(): void
+    {
+        $mainPart = '<?xml version="1.0" encoding="UTF-8"?>
+        <w:p>
+            <w:r>
+                <w:rPr></w:rPr>
+                <w:t>{{CLONEME}}</w:t>
+            </w:r>
+        </w:p>
+        <w:p>
+            <w:r>
+                <w:t xml:space="preserve">Address {{address}}, Street {{street}}</w:t>
+            </w:r>
+        </w:p>
+        <w:p>
+            <w:r w:rsidRPr="00204FED">
+                <w:t>{{/CLONEME}}</w:t>
+            </w:r>
+        </w:p>';
+
+        $templateProcessor = new TestableTemplateProcesor($mainPart);
+        $templateProcessor->setMacroChars('{{', '}}');
+        $templateProcessor->cloneBlock('CLONEME', 3, true, true);
+
+        self::assertStringContainsString('Address {{address#1}}, Street {{street#1}}', $templateProcessor->getMainPart());
+        self::assertStringContainsString('Address {{address#2}}, Street {{street#2}}', $templateProcessor->getMainPart());
+        self::assertStringContainsString('Address {{address#3}}, Street {{street#3}}', $templateProcessor->getMainPart());
+    }
+
     public function testCloneBlockWithVariableReplacements(): void
     {
         $mainPart = '<?xml version="1.0" encoding="UTF-8"?>
@@ -693,6 +1049,40 @@ final class TemplateProcessorTest extends \PHPUnit\Framework\TestCase
         self::assertStringContainsString('City: Rome, Street: Via della Conciliazione', $templateProcessor->getMainPart());
     }
 
+    public function testCloneBlockWithVariableReplacementsAndCustomMacro(): void
+    {
+        $mainPart = '<?xml version="1.0" encoding="UTF-8"?>
+        <w:p>
+            <w:r>
+                <w:rPr></w:rPr>
+                <w:t>{{CLONEME}}</w:t>
+            </w:r>
+        </w:p>
+        <w:p>
+            <w:r>
+                <w:t xml:space="preserve">City: {{city}}, Street: {{street}}</w:t>
+            </w:r>
+        </w:p>
+        <w:p>
+            <w:r w:rsidRPr="00204FED">
+                <w:t>{{/CLONEME}}</w:t>
+            </w:r>
+        </w:p>';
+
+        $replacements = [
+            ['city' => 'London', 'street' => 'Baker Street'],
+            ['city' => 'New York', 'street' => '5th Avenue'],
+            ['city' => 'Rome', 'street' => 'Via della Conciliazione'],
+        ];
+        $templateProcessor = new TestableTemplateProcesor($mainPart);
+        $templateProcessor->setMacroChars('{{', '}}');
+        $templateProcessor->cloneBlock('CLONEME', 0, true, false, $replacements);
+
+        self::assertStringContainsString('City: London, Street: Baker Street', $templateProcessor->getMainPart());
+        self::assertStringContainsString('City: New York, Street: 5th Avenue', $templateProcessor->getMainPart());
+        self::assertStringContainsString('City: Rome, Street: Via della Conciliazione', $templateProcessor->getMainPart());
+    }
+
     /**
      * Template macros can be fixed.
      *
@@ -724,6 +1114,38 @@ final class TemplateProcessorTest extends \PHPUnit\Framework\TestCase
         self::assertEquals('<w:t>$</w:t></w:r><w:bookmarkStart w:id="0" w:name="_GoBack"/><w:bookmarkEnd w:id="0"/><w:r><w:t xml:space="preserve">15,000.00. </w:t></w:r><w:r w:rsidR="0056499B"><w:t>${variable_name}</w:t></w:r>', $fixed);
     }
 
+    /**
+     * Template macros can be fixed even with cutome macro.
+     *
+     * @covers ::fixBrokenMacros
+     */
+    public function testFixBrokenMacrosWithCustomMacro(): void
+    {
+        $templateProcessor = new TestableTemplateProcesor();
+        $templateProcessor->setMacroChars('{{', '}}');
+
+        $fixed = $templateProcessor->fixBrokenMacros('<w:r><w:t>normal text</w:t></w:r>');
+        self::assertEquals('<w:r><w:t>normal text</w:t></w:r>', $fixed);
+
+        $fixed = $templateProcessor->fixBrokenMacros('<w:r><w:t>{{documentContent}}</w:t></w:r>');
+        self::assertEquals('<w:r><w:t>{{documentContent}}</w:t></w:r>', $fixed);
+
+        $fixed = $templateProcessor->fixBrokenMacros('<w:r><w:t>{</w:t><w:t>{documentContent}}</w:t></w:r>');
+        self::assertEquals('<w:r><w:t>{{documentContent}}</w:t></w:r>', $fixed);
+
+        $fixed = $templateProcessor->fixBrokenMacros('<w:r><w:t>$1500</w:t><w:t>{{documentContent}}</w:t></w:r>');
+        self::assertEquals('<w:r><w:t>$1500</w:t><w:t>{{documentContent}}</w:t></w:r>', $fixed);
+
+        $fixed = $templateProcessor->fixBrokenMacros('<w:r><w:t>$1500</w:t><w:t>{</w:t><w:t>{documentContent}}</w:t></w:r>');
+        self::assertEquals('<w:r><w:t>$1500</w:t><w:t>{{documentContent}}</w:t></w:r>', $fixed);
+
+        $fixed = $templateProcessor->fixBrokenMacros('<w:r><w:t>25$ plus some info {hint}</w:t></w:r>');
+        self::assertEquals('<w:r><w:t>25$ plus some info {hint}</w:t></w:r>', $fixed);
+
+        $fixed = $templateProcessor->fixBrokenMacros('<w:t>$</w:t></w:r><w:bookmarkStart w:id="0" w:name="_GoBack"/><w:bookmarkEnd w:id="0"/><w:r><w:t xml:space="preserve">15,000.00. </w:t></w:r><w:r w:rsidR="0056499B"><w:t>{</w:t></w:r><w:r w:rsidR="00573DFD" w:rsidRPr="00573DFD"><w:rPr><w:iCs/></w:rPr><w:t>{</w:t></w:r><w:proofErr w:type="spellStart"/><w:r w:rsidR="00573DFD" w:rsidRPr="00573DFD"><w:rPr><w:iCs/></w:rPr><w:t>variable_name</w:t></w:r><w:proofErr w:type="spellEnd"/><w:r w:rsidR="00573DFD" w:rsidRPr="00573DFD"><w:rPr><w:iCs/></w:rPr><w:t>}}</w:t></w:r>');
+        self::assertEquals('<w:t>$</w:t></w:r><w:bookmarkStart w:id="0" w:name="_GoBack"/><w:bookmarkEnd w:id="0"/><w:r><w:t xml:space="preserve">15,000.00. </w:t></w:r><w:r w:rsidR="0056499B"><w:t>{{variable_name}}</w:t></w:r>', $fixed);
+    }
+
     /**
      * @covers ::getMainPartName
      */
@@ -736,6 +1158,19 @@ final class TemplateProcessorTest extends \PHPUnit\Framework\TestCase
         self::assertEquals($variables, $templateProcessor->getVariables());
     }
 
+    /**
+     * @covers ::getMainPartName
+     */
+    public function testMainPartNameDetectionWithCustomMacro(): void
+    {
+        $templateProcessor = new TemplateProcessor(__DIR__ . '/_files/templates/document22-with-custom-macro-xml.docx');
+        $templateProcessor->setMacroOpeningChars('{#');
+        $templateProcessor->setMacroClosingChars('#}');
+        $variables = ['test'];
+
+        self::assertEquals($variables, $templateProcessor->getVariables());
+    }
+
     /**
      * @covers ::getVariables
      */
@@ -753,6 +1188,25 @@ final class TemplateProcessorTest extends \PHPUnit\Framework\TestCase
         self::assertEquals(['variable_name'], $variables);
     }
 
+    /**
+     * @covers ::getVariables
+     */
+    public function testGetVariablesWithCustomMacro(): void
+    {
+        $templateProcessor = new TestableTemplateProcesor();
+        $templateProcessor->setMacroOpeningChars('{{');
+        $templateProcessor->setMacroClosingChars('}}');
+
+        $variables = $templateProcessor->getVariablesForPart('<w:r><w:t>normal text</w:t></w:r>');
+        self::assertEquals([], $variables);
+
+        $variables = $templateProcessor->getVariablesForPart('<w:r><w:t>{{documentContent}}</w:t></w:r>');
+        self::assertEquals(['documentContent'], $variables);
+
+        $variables = $templateProcessor->getVariablesForPart('<w:t>{</w:t></w:r><w:bookmarkStart w:id="0" w:name="_GoBack"/><w:bookmarkEnd w:id="0"/><w:r><w:t xml:space="preserve">15,000.00. </w:t></w:r><w:r w:rsidR="0056499B"><w:t>{</w:t></w:r><w:r w:rsidR="00573DFD" w:rsidRPr="00573DFD"><w:rPr><w:iCs/></w:rPr><w:t>{</w:t></w:r><w:proofErr w:type="spellStart"/><w:r w:rsidR="00573DFD" w:rsidRPr="00573DFD"><w:rPr><w:iCs/></w:rPr><w:t>variable_name</w:t></w:r><w:proofErr w:type="spellEnd"/><w:r w:rsidR="00573DFD" w:rsidRPr="00573DFD"><w:rPr><w:iCs/></w:rPr><w:t>}}</w:t></w:r>');
+        self::assertEquals(['variable_name'], $variables);
+    }
+
     /**
      * @covers ::textNeedsSplitting
      */
@@ -768,6 +1222,22 @@ final class TemplateProcessorTest extends \PHPUnit\Framework\TestCase
         self::assertFalse($templateProcessor->textNeedsSplitting($splitText));
     }
 
+    /**
+     * @covers ::textNeedsSplitting
+     */
+    public function testTextNeedsSplittingWithCustomMacro(): void
+    {
+        $templateProcessor = new TestableTemplateProcesor();
+        $templateProcessor->setMacroChars('{{', '}}');
+
+        self::assertFalse($templateProcessor->textNeedsSplitting('<w:r><w:rPr><w:b/><w:i/></w:rPr><w:t xml:space="preserve">{{nothing-to-replace}}</w:t></w:r>'));
+
+        $text = '<w:r><w:rPr><w:b/><w:i/></w:rPr><w:t xml:space="preserve">Hello {{firstname}} {{lastname}}</w:t></w:r>';
+        self::assertTrue($templateProcessor->textNeedsSplitting($text));
+        $splitText = $templateProcessor->splitTextIntoTexts($text);
+        self::assertFalse($templateProcessor->textNeedsSplitting($splitText));
+    }
+
     /**
      * @covers ::splitTextIntoTexts
      */
@@ -782,6 +1252,21 @@ final class TemplateProcessorTest extends \PHPUnit\Framework\TestCase
         self::assertEquals('<w:r><w:rPr><w:b/><w:i/></w:rPr><w:t xml:space="preserve">Hello </w:t></w:r><w:r><w:rPr><w:b/><w:i/></w:rPr><w:t xml:space="preserve">${firstname}</w:t></w:r><w:r><w:rPr><w:b/><w:i/></w:rPr><w:t xml:space="preserve"> </w:t></w:r><w:r><w:rPr><w:b/><w:i/></w:rPr><w:t xml:space="preserve">${lastname}</w:t></w:r>', $splitText);
     }
 
+    /**
+     * @covers ::splitTextIntoTexts
+     */
+    public function testSplitTextIntoTextsWithCustomMacro(): void
+    {
+        $templateProcessor = new TestableTemplateProcesor();
+        $templateProcessor->setMacroChars('{{', '}}');
+
+        $splitText = $templateProcessor->splitTextIntoTexts('<w:r><w:rPr><w:b/><w:i/></w:rPr><w:t xml:space="preserve">{{nothing-to-replace}}</w:t></w:r>');
+        self::assertEquals('<w:r><w:rPr><w:b/><w:i/></w:rPr><w:t xml:space="preserve">{{nothing-to-replace}}</w:t></w:r>', $splitText);
+
+        $splitText = $templateProcessor->splitTextIntoTexts('<w:r><w:rPr><w:b/><w:i/></w:rPr><w:t xml:space="preserve">Hello {{firstname}} {{lastname}}</w:t></w:r>');
+        self::assertEquals('<w:r><w:rPr><w:b/><w:i/></w:rPr><w:t xml:space="preserve">Hello </w:t></w:r><w:r><w:rPr><w:b/><w:i/></w:rPr><w:t xml:space="preserve">{{firstname}}</w:t></w:r><w:r><w:rPr><w:b/><w:i/></w:rPr><w:t xml:space="preserve"> </w:t></w:r><w:r><w:rPr><w:b/><w:i/></w:rPr><w:t xml:space="preserve">{{lastname}}</w:t></w:r>', $splitText);
+    }
+
     public function testFindXmlBlockStart(): void
     {
         $toFind = '<w:r>
@@ -825,6 +1310,50 @@ final class TemplateProcessorTest extends \PHPUnit\Framework\TestCase
         self::assertEquals($toFind, $templateProcessor->getSlice($position['start'], $position['end']));
     }
 
+    public function testFindXmlBlockStartWithCustomMacro(): void
+    {
+        $toFind = '<w:r>
+                    <w:rPr>
+                        <w:rFonts w:ascii="Calibri" w:hAnsi="Calibri" w:cs="Calibri"/>
+                        <w:lang w:val="en-GB"/>
+                    </w:rPr>
+                    <w:t>This whole paragraph will be replaced with my {{title}}</w:t>
+                </w:r>';
+        $mainPart = '<w:document xmlns:wpc="http://schemas.microsoft.com/office/word/2010/wordprocessingCanvas" xmlns:cx="http://schemas.microsoft.com/office/drawing/2014/chartex" xmlns:cx1="http://schemas.microsoft.com/office/drawing/2015/9/8/chartex" xmlns:cx2="http://schemas.microsoft.com/office/drawing/2015/10/21/chartex" xmlns:cx3="http://schemas.microsoft.com/office/drawing/2016/5/9/chartex" xmlns:cx4="http://schemas.microsoft.com/office/drawing/2016/5/10/chartex" xmlns:cx5="http://schemas.microsoft.com/office/drawing/2016/5/11/chartex" xmlns:cx6="http://schemas.microsoft.com/office/drawing/2016/5/12/chartex" xmlns:cx7="http://schemas.microsoft.com/office/drawing/2016/5/13/chartex" xmlns:cx8="http://schemas.microsoft.com/office/drawing/2016/5/14/chartex" xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006" xmlns:aink="http://schemas.microsoft.com/office/drawing/2016/ink" xmlns:am3d="http://schemas.microsoft.com/office/drawing/2017/model3d" xmlns:o="urn:schemas-microsoft-com:office:office" xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships" xmlns:m="http://schemas.openxmlformats.org/officeDocument/2006/math" xmlns:v="urn:schemas-microsoft-com:vml" xmlns:wp14="http://schemas.microsoft.com/office/word/2010/wordprocessingDrawing" xmlns:wp="http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing" xmlns:w10="urn:schemas-microsoft-com:office:word" xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main" xmlns:w14="http://schemas.microsoft.com/office/word/2010/wordml" xmlns:w15="http://schemas.microsoft.com/office/word/2012/wordml" xmlns:w16cid="http://schemas.microsoft.com/office/word/2016/wordml/cid" xmlns:w16se="http://schemas.microsoft.com/office/word/2015/wordml/symex" xmlns:wpg="http://schemas.microsoft.com/office/word/2010/wordprocessingGroup" xmlns:wpi="http://schemas.microsoft.com/office/word/2010/wordprocessingInk" xmlns:wne="http://schemas.microsoft.com/office/word/2006/wordml" xmlns:wps="http://schemas.microsoft.com/office/word/2010/wordprocessingShape" mc:Ignorable="w14 w15 w16se w16cid wp14">
+            <w:p w14:paraId="165D45AF" w14:textId="7FEC9B41" w:rsidR="005B1098" w:rsidRDefault="005B1098">
+                <w:r w:rsidR="00A045B2">
+                    <w:rPr>
+                        <w:rFonts w:ascii="Calibri" w:hAnsi="Calibri" w:cs="Calibri"/>
+                        <w:lang w:val="en-GB"/>
+                    </w:rPr>
+                    <w:t xml:space="preserve"> {{value1}} {{value2}}</w:t>
+                </w:r>
+                <w:r>
+                    <w:rPr>
+                        <w:rFonts w:ascii="Calibri" w:hAnsi="Calibri" w:cs="Calibri"/>
+                        <w:lang w:val="en-GB"/>
+                    </w:rPr>
+                    <w:t>.</w:t>
+                </w:r>
+            </w:p>
+            <w:p w14:paraId="330D1954" w14:textId="0AB1D347" w:rsidR="00156568" w:rsidRDefault="00156568">
+                <w:pPr>
+                    <w:rPr>
+                        <w:rFonts w:ascii="Calibri" w:hAnsi="Calibri" w:cs="Calibri"/>
+                        <w:lang w:val="en-GB"/>
+                    </w:rPr>
+                </w:pPr>
+                ' . $toFind . '
+            </w:p>
+        </w:document>';
+
+        $templateProcessor = new TestableTemplateProcesor($mainPart);
+        $templateProcessor->setMacroChars('{{', '}}');
+        $position = $templateProcessor->findContainingXmlBlockForMacro('{{title}}', 'w:r');
+
+        self::assertEquals($toFind, $templateProcessor->getSlice($position['start'], $position['end']));
+    }
+
     public function testShouldReturnFalseIfXmlBlockNotFound(): void
     {
         $mainPart = '<w:document xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main">
@@ -852,6 +1381,34 @@ final class TemplateProcessorTest extends \PHPUnit\Framework\TestCase
         self::assertFalse($result);
     }
 
+    public function testShouldReturnFalseIfXmlBlockNotFoundWithCustomMacro(): void
+    {
+        $mainPart = '<w:document xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main">
+            <w:p>
+                <w:r>
+                    <w:rPr>
+                        <w:lang w:val="en-GB"/>
+                    </w:rPr>
+                    <w:t xml:space="preserve">this is my text containing a ${macro}</w:t>
+                </w:r>
+            </w:p>
+        </w:document>';
+        $templateProcessor = new TestableTemplateProcesor($mainPart);
+        $templateProcessor->setMacroChars('{{', '}}');
+
+        //non-existing macro
+        $result = $templateProcessor->findContainingXmlBlockForMacro('{{fake-macro}}', 'w:p');
+        self::assertFalse($result);
+
+        //existing macro but not inside node looked for
+        $result = $templateProcessor->findContainingXmlBlockForMacro('{{macro}}', 'w:fake-node');
+        self::assertFalse($result);
+
+        //existing macro but end tag not found after macro
+        $result = $templateProcessor->findContainingXmlBlockForMacro('{{macro}}', 'w:rPr');
+        self::assertFalse($result);
+    }
+
     public function testShouldMakeFieldsUpdateOnOpen(): void
     {
         $settingsPart = '<w:settings xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main">
@@ -865,4 +1422,19 @@ final class TemplateProcessorTest extends \PHPUnit\Framework\TestCase
         $templateProcessor->setUpdateFields(false);
         self::assertStringContainsString('<w:updateFields w:val="false"/>', $templateProcessor->getSettingsPart());
     }
+
+    public function testShouldMakeFieldsUpdateOnOpenWithCustomMacro(): void
+    {
+        $settingsPart = '<w:settings xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main">
+            <w:zoom w:percent="100"/>
+        </w:settings>';
+        $templateProcessor = new TestableTemplateProcesor(null, $settingsPart);
+        $templateProcessor->setMacroChars('{{', '}}');
+
+        $templateProcessor->setUpdateFields(true);
+        self::assertStringContainsString('<w:updateFields w:val="true"/>', $templateProcessor->getSettingsPart());
+
+        $templateProcessor->setUpdateFields(false);
+        self::assertStringContainsString('<w:updateFields w:val="false"/>', $templateProcessor->getSettingsPart());
+    }
 }

tests/PhpWordTests/Writer/Word2007/Part/DocumentTest.php

@@ -2,10 +2,8 @@
 /**
  * This file is part of PHPWord - A pure PHP library for reading and writing
  * word processing documents.
- *
  * PHPWord is free software distributed under the terms of the GNU Lesser
  * General Public License version 3 as published by the Free Software Foundation.
- *
  * For the full copyright and license information, please read the LICENSE
  * file that was distributed with this source code. For the full list of
  * contributors, visit https://github.com/PHPOffice/PHPWord/contributors.
@@ -61,11 +59,11 @@ class DocumentTest extends \PHPUnit\Framework\TestCase
         $doc = TestHelperDOCX::getDocument($phpWord);
         self::assertNotNull($doc);
 
-//         $this->assertTrue($doc->elementExists('/Properties/property[name="key1"]/vt:lpwstr'));
-//         $this->assertTrue($doc->elementExists('/Properties/property[name="key2"]/vt:bool'));
-//         $this->assertTrue($doc->elementExists('/Properties/property[name="key3"]/vt:i4'));
-//         $this->assertTrue($doc->elementExists('/Properties/property[name="key4"]/vt:r8'));
-//         $this->assertTrue($doc->elementExists('/Properties/property[name="key5"]/vt:lpwstr'));
+        //         $this->assertTrue($doc->elementExists('/Properties/property[name="key1"]/vt:lpwstr'));
+        //         $this->assertTrue($doc->elementExists('/Properties/property[name="key2"]/vt:bool'));
+        //         $this->assertTrue($doc->elementExists('/Properties/property[name="key3"]/vt:i4'));
+        //         $this->assertTrue($doc->elementExists('/Properties/property[name="key4"]/vt:r8'));
+        //         $this->assertTrue($doc->elementExists('/Properties/property[name="key5"]/vt:lpwstr'));
     }
 
     /**
@@ -408,7 +406,13 @@ class DocumentTest extends \PHPUnit\Framework\TestCase
         // behind
         $element = $doc->getElement('/w:document/w:body/w:p[2]/w:r/w:pict/v:shape');
         $style = $element->getAttribute('style');
-        self::assertRegExp('/z\-index:\-[0-9]*/', $style);
+
+        // Try to address CI coverage issue for PHP 7.1 and 7.2 when using regex match assertions
+        if (method_exists(static::class, 'assertRegExp')) {
+            self::assertRegExp('/z\-index:\-[0-9]*/', $style);
+        } else {
+            self::assertMatchesRegularExpression('/z\-index:\-[0-9]*/', $style);
+        }
 
         // square
         $element = $doc->getElement('/w:document/w:body/w:p[4]/w:r/w:pict/v:shape/w10:wrap');
@@ -551,7 +555,13 @@ class DocumentTest extends \PHPUnit\Framework\TestCase
         $cell->addText('Test');
 
         $doc = TestHelperDOCX::getDocument($phpWord);
-        self::assertEquals(Cell::DEFAULT_BORDER_COLOR, $doc->getElementAttribute('/w:document/w:body/w:tbl/w:tr/w:tc/w:tcPr/w:tcBorders/w:top', 'w:color'));
+        self::assertEquals(
+            Cell::DEFAULT_BORDER_COLOR,
+            $doc->getElementAttribute(
+                '/w:document/w:body/w:tbl/w:tr/w:tc/w:tcPr/w:tcBorders/w:top',
+                'w:color'
+            )
+        );
     }
 
     /**