Skip to content

Commit 1bacc1d

Browse files
andomiellandomiell
committed
Writer HTML: ListItemRun is now rendered as unordered list (<ul>/<li>) instead of plain paragraph
1 parent 0ab0b49 commit 1bacc1d

File tree

4 files changed

+100
-11
lines changed

4 files changed

+100
-11
lines changed

‎docs/changes/1.x/1.5.0.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
### Bug fixes
88

99
- Set writeAttribute return type by [@radarhere](https://github.com/radarhere) fixing [#2204](https://github.com/PHPOffice/PHPWord/issues/2204) in [#2776](https://github.com/PHPOffice/PHPWord/pull/2776)
10+
- Writer HTML: ListItemRun render as unordered lists by [@andomiell](https://github.com/andomiell) partially fixing [#1462](https://github.com/PHPOffice/PHPWord/issues/1462)
1011

1112
### Miscellaneous
1213

‎src/PhpWord/Writer/HTML/Element/Container.php‎

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,14 +50,43 @@ public function write()
5050
$content = '';
5151

5252
$elements = $container->getElements();
53-
foreach ($elements as $element) {
53+
foreach ($elements as $index => $element) {
54+
if ($element instanceof \PhpOffice\PhpWord\Element\ListItemRun) {
55+
$prevElement = $elements[$index - 1] ?? null;
56+
57+
if ($prevElement === null) {
58+
$content .= '<ul>';
59+
} elseif (!$prevElement instanceof \PhpOffice\PhpWord\Element\ListItemRun) {
60+
$content .= '<ul>';
61+
} elseif ($prevElement->getDepth() < $element->getDepth()) {
62+
if (str_ends_with($content, '</li>')) {
63+
$content = substr($content, 0, -5);
64+
}
65+
$content .= '<ul>';
66+
}
67+
}
68+
5469
$elementClass = get_class($element);
5570
$writerClass = str_replace('PhpOffice\\PhpWord\\Element', $this->namespace, $elementClass);
5671
if (class_exists($writerClass)) {
5772
/** @var AbstractElement $writer Type hint */
5873
$writer = new $writerClass($this->parentWriter, $element, $withoutP);
5974
$content .= $writer->write();
6075
}
76+
77+
if ($element instanceof \PhpOffice\PhpWord\Element\ListItemRun) {
78+
$nextElement = $elements[$index + 1] ?? null;
79+
80+
if ($nextElement === null) {
81+
$content .= '</ul>';
82+
} elseif (!$nextElement instanceof \PhpOffice\PhpWord\Element\ListItemRun) {
83+
$content .= '</ul>';
84+
} elseif ($nextElement->getDepth() < $element->getDepth()) {
85+
for ($i = $element->getDepth() - $nextElement->getDepth(); $i !== 0; --$i) {
86+
$content .= '</ul></li>';
87+
}
88+
}
89+
}
6190
}
6291

6392
return $content;

‎src/PhpWord/Writer/HTML/Element/ListItemRun.php‎

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,22 @@ public function write()
3636
return '';
3737
}
3838

39-
$writer = new Container($this->parentWriter, $this->element);
40-
$content = $writer->write() . PHP_EOL;
39+
$content = '<li>';
4140

42-
return $content;
41+
foreach ($this->element->getElements() as $element) {
42+
$namespace = 'PhpOffice\\PhpWord\\Writer\\HTML\\Element';
43+
$elementClass = get_class($element);
44+
$writerClass = str_replace('PhpOffice\\PhpWord\\Element', $namespace, $elementClass);
45+
46+
if (!class_exists($writerClass)) {
47+
continue;
48+
}
49+
50+
/** @var AbstractElement $writer */
51+
$writer = new $writerClass($this->parentWriter, $element, true);
52+
$content .= $writer->write();
53+
}
54+
55+
return "$content</li>";
4356
}
4457
}

‎tests/PhpWordTests/Writer/HTML/ElementTest.php‎

Lines changed: 53 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@
2020

2121
use DateTime;
2222
use DOMDocument;
23+
use DOMNode;
24+
use DOMNodeList;
2325
use DOMXPath;
2426
use PhpOffice\PhpWord\Element\Text as TextElement;
2527
use PhpOffice\PhpWord\Element\TextRun;
@@ -200,24 +202,68 @@ public function testWriteTitleTextRun(): void
200202
*/
201203
public function testListItemRun(): void
202204
{
203-
$expected1 = 'List item run 1';
204-
$expected2 = 'List item run 1 in bold';
205+
$expected11 = 'List item run 1.1';
206+
$expected11InBold = 'List item run 1.1 in bold';
207+
$expected12 = 'List item run 1.2';
208+
$expected21 = 'List item run 2.1';
209+
$expected22 = 'List item run 2.2';
210+
$expected31 = 'List item run 3.1';
211+
$expected13 = 'List item run 1.3';
205212

206213
$phpWord = new PhpWord();
207214
$section = $phpWord->addSection();
208215

209-
$listItemRun = $section->addListItemRun(0, null, 'MyParagraphStyle');
210-
$listItemRun->addText($expected1);
211-
$listItemRun->addText($expected2, ['bold' => true]);
216+
$listItemRun11 = $section->addListItemRun(0, null, 'MyParagraphStyle');
217+
$listItemRun11->addText($expected11);
218+
$listItemRun11->addText($expected11InBold, ['bold' => true]);
219+
220+
$listItemRun12 = $section->addListItemRun(0);
221+
$listItemRun12->addText($expected12);
222+
223+
$listItemRun21 = $section->addListItemRun(1);
224+
$listItemRun21->addText($expected21);
225+
226+
$listItemRun22 = $section->addListItemRun(1);
227+
$listItemRun22->addText($expected22);
228+
229+
$listItemRun31 = $section->addListItemRun(2);
230+
$listItemRun31->addText($expected31);
231+
232+
$listItemRun13 = $section->addListItemRun(0);
233+
$listItemRun13->addText($expected13);
212234

213235
$htmlWriter = new HTML($phpWord);
214236
$content = $htmlWriter->getContent();
215237

216238
$dom = new DOMDocument();
217239
$dom->loadHTML($content);
218240

219-
self::assertEquals($expected1, $dom->getElementsByTagName('p')->item(0)->textContent);
220-
self::assertEquals($expected2, $dom->getElementsByTagName('p')->item(1)->textContent);
241+
$xpath = new DOMXPath($dom);
242+
243+
/** @var DOMNodeList<DOMNode> $list */
244+
$list = $xpath->query('//body/div/ul/li');
245+
246+
$item11 = $list->item(0);
247+
$item12 = $list->item(1);
248+
$item13 = $list->item(2);
249+
250+
self::assertEquals($expected11, $item11->childNodes->item(0)->textContent);
251+
self::assertEquals('span', $item11->childNodes->item(1)->nodeName);
252+
self::assertEquals($expected11InBold, $item11->childNodes->item(1)->textContent);
253+
254+
self::assertEquals($expected12, $item12->childNodes->item(0)->textContent);
255+
self::assertEquals('ul', $item12->childNodes->item(1)->nodeName);
256+
257+
self::assertEquals($expected21, $item12->childNodes->item(1)->childNodes->item(0)->textContent);
258+
259+
$item22 = $item12->childNodes->item(1)->childNodes->item(1);
260+
261+
self::assertEquals($expected22, $item22->childNodes->item(0)->textContent);
262+
self::assertEquals('ul', $item22->childNodes->item(1)->nodeName);
263+
264+
self::assertEquals($expected31, $item22->childNodes->item(1)->childNodes->item(0)->textContent);
265+
266+
self::assertEquals($expected13, $item13->childNodes->item(0)->textContent);
221267
}
222268

223269
/**

0 commit comments

Comments
 (0)