Replace macros by splitting existing text runs/paragraphs instead of replacing them

Author: jensschuppe

src/PhpWord/TemplateProcessor.php

@@ -315,6 +315,46 @@ public function setComplexBlock($search, Element\AbstractElement $complexType):
         $this->replaceXmlBlock($search, $xmlWriter->getData(), 'w:p');
     }
 
+    /**
+     * Replaces a search string (macro) with a set of rendered elements, splitting
+     * surrounding texts, text runs or paragraphs before and after the macro,
+     * depending on the types of elements to insert.
+     *
+     * @param \PhpOffice\PhpWord\Element\AbstractElement[] $elements
+     */
+    public function setElementsValue(string $search, array $elements): void
+    {
+        $elementsData = '';
+        $hasParagraphs = false;
+        foreach ($elements as $element) {
+            $elementName = substr(
+                get_class($element),
+                (int) strrpos(get_class($element), '\\') + 1
+            );
+            $objectClass = 'PhpOffice\\PhpWord\\Writer\\Word2007\\Element\\' . $elementName;
+
+            // For inline elements, do not create a new paragraph.
+            $withParagraph = Writer\Word2007\Element\Text::class !== $objectClass;
+            $hasParagraphs = $hasParagraphs || $withParagraph;
+
+            $xmlWriter = new XMLWriter();
+            /** @var \PhpOffice\PhpWord\Writer\Word2007\Element\AbstractElement $elementWriter */
+            $elementWriter = new $objectClass($xmlWriter, $element, !$withParagraph);
+            $elementWriter->write();
+            $elementsData .= $xmlWriter->getData();
+        }
+        $blockType = $hasParagraphs ? 'w:p' : 'w:r';
+        $where = $this->findContainingXmlBlockForMacro($search, $blockType);
+        if (is_array($where)) {
+            /** @phpstan-var array{start: int, end: int} $where */
+            $block = $this->getSlice($where['start'], $where['end']);
+            $parts = $hasParagraphs ? $this->splitParagraphIntoParagraphs($block) : $this->splitTextIntoTexts($block);
+            $this->replaceXmlBlock($search, $parts, $blockType);
+            $search = static::ensureMacroCompleted($search);
+            $this->replaceXmlBlock($search, $elementsData, $blockType);
+        }
+    }
+
     /**
      * @param mixed $search
      * @param mixed $replace
@@ -1464,6 +1504,49 @@ protected function splitTextIntoTexts($text)
         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);
     }
 
+    /**
+     * Splits a w:p into a list of w:p where each ${macro} is in a separate w:p.
+     */
+    public function splitParagraphIntoParagraphs(string $paragraph): string
+    {
+        $matches = [];
+        if (1 === preg_match('/(<w:pPr.*<\/w:pPr>)/i', $paragraph, $matches)) {
+            $extractedStyle = $matches[0];
+        } else {
+            $extractedStyle = '';
+        }
+        if (null === $paragraph = preg_replace('/>\s+</', '><', $paragraph)) {
+            throw new Exception('Error processing PhpWord document.');
+        }
+        $result = str_replace(
+            [
+                '${',
+                '}',
+            ],
+            [
+                '</w:t></w:r></w:p><w:p>' . $extractedStyle . '<w:r><w:t xml:space="preserve">${',
+                '}</w:t></w:r></w:p><w:p>' . $extractedStyle . '<w:r><w:t xml:space="preserve">',
+            ],
+            $paragraph
+        );
+
+        // Remove empty paragraphs that might have been created before/after the
+        // macro.
+        $result = str_replace(
+            [
+                '<w:p>' . $extractedStyle . '<w:r><w:t xml:space="preserve"></w:t></w:r></w:p>',
+                '<w:p><w:r><w:t xml:space="preserve"></w:t></w:r></w:p>',
+            ],
+            [
+                '',
+                '',
+            ],
+            $result
+        );
+
+        return $result;
+    }
+
     /**
      * Returns true if string contains a macro that is not in it's own w:r.
      *