Skip to content

Template Processor: Fix 0 considered as empty string #2748

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Feb 12, 2025
Merged

Template Processor: Fix 0 considered as empty string #2748

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9992fe0
Fix `0` considered as empty string
cavasinf May 30, 2024
1026015
Update changelog
cavasinf Oct 14, 2024
9a5a6f3
Updated changelog & Added unit test
Progi1984 Feb 12, 2025
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
1 change: 1 addition & 0 deletions docs/changes/1.x/1.4.0.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
- Reader Word2007: Support Header elements within Title elements by [@SpraxDev](https://github.com/SpraxDev) fixing [#2616](https://github.com/PHPOffice/PHPWord/issues/2616), [#2426](https://github.com/PHPOffice/PHPWord/issues/2426) in [#2674](https://github.com/PHPOffice/PHPWord/pull/2674)
- Reader HTML: Support for inherit value for property line-height by [@Progi1984](https://github.com/Progi1984) fixing [#2683](https://github.com/PHPOffice/PHPWord/issues/2683) in [#2733](https://github.com/PHPOffice/PHPWord/pull/2733)
- Writer HTML: Fixed null string for Text Elements by [@armagedon007](https://github.com/armagedon007) and [@Progi1984](https://github.com/Progi1984) in [#2738](https://github.com/PHPOffice/PHPWord/pull/2738)
- Template Processor: Fix 0 considered as empty string by [@cavasinf](https://github.com/cavasinf), [@SnipsMine](https://github.com/SnipsMine) and [@Progi1984](https://github.com/Progi1984) fixing [#2572](https://github.com/PHPOffice/PHPWord/issues/2572), [#2703](https://github.com/PHPOffice/PHPWord/issues/2703) in [#2748](https://github.com/PHPOffice/PHPWord/pull/2748)

### Miscellaneous

Expand Down
2 changes: 1 addition & 1 deletion src/PhpWord/TemplateProcessor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -269,7 +269,7 @@ protected static function ensureMacroCompleted($macro)
*/
protected static function ensureUtf8Encoded($subject)
{
return $subject ? Text::toUTF8($subject) : '';
return (null !== $subject) ? Text::toUTF8($subject) : '';
}

/**
Expand Down
97 changes: 97 additions & 0 deletions tests/PhpWordTests/TemplateProcessorTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1641,4 +1641,101 @@ public function testShouldMakeFieldsUpdateOnOpenWithCustomMacro(): void
$templateProcessor->setUpdateFields(false);
self::assertStringContainsString('<w:updateFields w:val="false"/>', $templateProcessor->getSettingsPart());
}

public function testEnsureUtf8Encoded(): void
{
$mainPart = '<w:tbl>
<w:tr>
<w:tc>
<w:tcPr>
<w:vMerge w:val="restart"/>
</w:tcPr>
<w:p>
<w:r>
<w:t t=1>${stringZero}</w:t>
</w:r>
</w:p>
</w:tc>
<w:tc>
<w:p>
<w:r>
<w:t t=2>${intZero}</w:t>
</w:r>
</w:p>
</w:tc>
<w:tc>
<w:p>
<w:r>
<w:t t=3>${stringTest}</w:t>
</w:r>
</w:p>
</w:tc>
<w:tc>
<w:p>
<w:r>
<w:t t=4>${null}</w:t>
</w:r>
</w:p>
</w:tc>
<w:tc>
<w:p>
<w:r>
<w:t t=5>${floatZero}</w:t>
</w:r>
</w:p>
</w:tc>
<w:tc>
<w:p>
<w:r>
<w:t t=6>${intTen}</w:t>
</w:r>
</w:p>
</w:tc>
<w:tc>
<w:p>
<w:r>
<w:t t=7>${boolFalse}</w:t>
</w:r>
</w:p>
</w:tc>
<w:tc>
<w:p>
<w:r>
<w:t t=8>${boolTrue}</w:t>
</w:r>
</w:p>
</w:tc>
</w:tr>
</w:tbl>';
$templateProcessor = new TestableTemplateProcesor($mainPart);

self::assertEquals(
['stringZero', 'intZero', 'stringTest', 'null', 'floatZero', 'intTen', 'boolFalse', 'boolTrue'],
$templateProcessor->getVariables()
);

$templateProcessor->setValue('stringZero', '0');
self::assertStringContainsString('<w:t t=1>0</w:t>', $templateProcessor->getMainPart());

$templateProcessor->setValue('intZero', 0);
self::assertStringContainsString('<w:t t=2>0</w:t>', $templateProcessor->getMainPart());

$templateProcessor->setValue('stringTest', 'test');
self::assertStringContainsString('<w:t t=3>test</w:t>', $templateProcessor->getMainPart());

$templateProcessor->setValue('null', null);
self::assertStringContainsString('<w:t t=4></w:t>', $templateProcessor->getMainPart());

$templateProcessor->setValue('floatZero', 0.00);
self::assertStringContainsString('<w:t t=5>0</w:t>', $templateProcessor->getMainPart());

$templateProcessor->setValue('intTen', 10);
self::assertStringContainsString('<w:t t=6>10</w:t>', $templateProcessor->getMainPart());

$templateProcessor->setValue('boolFalse', false);
self::assertStringContainsString('<w:t t=7></w:t>', $templateProcessor->getMainPart());

$templateProcessor->setValue('boolTrue', true);
self::assertStringContainsString('<w:t t=8>1</w:t>', $templateProcessor->getMainPart());
}
}