Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Inherit style from paragraph/text run a macro is inside #63

Merged
merged 4 commits into from
Jun 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ public function replaceHtmlToken(string $macroVariable, string $renderedTokenMes
else {
// ... or as HTML: Render all elements and insert in the text
// run or paragraph containing the macro.
$this->setElementsValue($macroVariable, $elements);
$this->setElementsValue($macroVariable, $elements, TRUE);
}
} while (in_array($macroVariable, $this->getVariables(), TRUE));
}
Expand All @@ -143,13 +143,15 @@ public function replaceHtmlToken(string $macroVariable, string $renderedTokenMes
* surrounding texts, text runs or paragraphs before and after the macro,
* depending on the types of elements to insert.
*
* @param string $search
* @param \PhpOffice\PhpWord\Element\AbstractElement[] $elements
* @param bool $inheritStyle
* If TRUE and an element contains no style, it will be inherited from the
* paragraph/text run the macro is inside.
*
* @return void
* @throws \PhpOffice\PhpWord\Exception\Exception
*/
public function setElementsValue(string $search, array $elements): void {
public function setElementsValue(string $search, array $elements, bool $inheritStyle = FALSE): void {
$search = static::ensureMacroCompleted($search);
$elementsData = '';
$hasParagraphs = FALSE;
foreach ($elements as $element) {
Expand All @@ -174,58 +176,113 @@ public function setElementsValue(string $search, array $elements): void {
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);
$paragraphStyle = '';
$textRunStyle = '';
$parts = $hasParagraphs
? $this->splitParagraphIntoParagraphs($block, $paragraphStyle, $textRunStyle)
: $this->splitTextIntoTexts($block, $textRunStyle);
if ($inheritStyle) {
$elementsData = str_replace(['<w:pPr/>', '<w:rPr/>'], [$paragraphStyle, $textRunStyle], $elementsData);
}
$this->replaceXmlBlock($search, $parts, $blockType);
$search = static::ensureMacroCompleted($search);
$this->replaceXmlBlock($search, $elementsData, $blockType);
}
}

/**
* Splits a w:p into a list of w:p where each ${macro} is in a separate w:p.
*
* @param string $paragraph
* @param string $extractedParagraphStyle
* Is set to the extracted paragraph style (w:pPr).
* @param string $extractedTextRunStyle
* Is set to the extracted text run style (w:rPr).
*
* @return string
* @throws \PhpOffice\PhpWord\Exception\Exception
*/
public function splitParagraphIntoParagraphs(string $paragraph): string {
$matches = [];
if (1 === preg_match('/(<w:pPr.*<\/w:pPr>)/i', $paragraph, $matches)) {
$extractedStyle = $matches[0];
}
else {
$extractedStyle = '';
}
public function splitParagraphIntoParagraphs(
string $paragraph,
string &$extractedParagraphStyle = '',
string &$extractedTextRunStyle = ''
): string {
if (NULL === $paragraph = preg_replace('/>\s+</', '><', $paragraph)) {
throw new PhpWord\Exception\Exception('Error processing PhpWord document.');
}

$matches = [];
preg_match('#<w:pPr.*</w:pPr>#i', $paragraph, $matches);
$extractedParagraphStyle = $matches[0] ?? '';

preg_match('#<w:rPr.*</w:rPr>#i', $paragraph, $matches);
$extractedTextRunStyle = $matches[0] ?? '';

$result = str_replace(
[
'<w:t>',
'${',
'}',
],
[
'</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">',
'<w:t xml:space="preserve">',
sprintf(
'</w:t></w:r></w:p><w:p>%s<w:r><w:t xml:space="preserve">%s${',
$extractedParagraphStyle,
$extractedTextRunStyle
),
sprintf(
'}</w:t></w:r></w:p><w:p>%s<w:r>%s<w:t xml:space="preserve">',
$extractedParagraphStyle,
$extractedTextRunStyle
),
],
$paragraph
);

// Remove empty paragraphs that might have been created before/after the
// macro.
$emptyParagraph = sprintf(
'<w:p>%s<w:r>%s<w:t xml:space="preserve"></w:t></w:r></w:p>',
$extractedParagraphStyle,
$extractedTextRunStyle
);

return str_replace($emptyParagraph, '', $result);
}

/**
* @inheritDoc
* Adds output parameter for extracted style.
*
* @param string $extractedStyle
* Is set to the extracted text run style (w:rPr).
*
* @throws \PhpOffice\PhpWord\Exception\Exception
*/
protected function splitTextIntoTexts($text, string &$extractedStyle = '') {
if (NULL === $unformattedText = preg_replace('/>\s+</', '><', $text)) {
throw new PhpWord\Exception\Exception('Error processing PhpWord document.');
}

$matches = [];
preg_match('/<w:rPr.*<\/w:rPr>/i', $unformattedText, $matches);
$extractedStyle = $matches[0] ?? '';

if (!$this->textNeedsSplitting($text)) {
return $text;
}

$result = str_replace(
['<w:t>', '${', '}'],
[
'<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>',
'<w:t xml:space="preserve">',
'</w:t></w:r><w:r>' . $extractedStyle . '<w:t xml:space="preserve">${',
'}</w:t></w:r><w:r>' . $extractedStyle . '<w:t xml:space="preserve">',
],
[
'',
'',
],
$result
$unformattedText
);
return $result;

$emptyTextRun = '<w:r>' . $extractedStyle . '<w:t xml:space="preserve"></w:t></w:r>';

return str_replace($emptyTextRun, '', $result);
}

}
Loading
Loading