Writer HTML: ListItemRun is now rendered as unordered list (<ul>/<li>) instead of plain paragraph

Author: andomiell

docs/changes/1.x/1.5.0.md

@@ -7,6 +7,7 @@
 ### Bug fixes
 
 - 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)
+- Writer HTML: ListItemRun render as unordered lists by [@andomiell](https://github.com/andomiell) partially fixing [#1462](https://github.com/PHPOffice/PHPWord/issues/1462)
 
 ### Miscellaneous
 

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

@@ -50,14 +50,43 @@ public function write()
         $content = '';
 
         $elements = $container->getElements();
-        foreach ($elements as $element) {
+        foreach ($elements as $index => $element) {
+            if ($element instanceof \PhpOffice\PhpWord\Element\ListItemRun) {
+                $prevElement = $elements[$index - 1] ?? null;
+
+                if ($prevElement === null) {
+                    $content .= '<ul>';
+                } elseif (!$prevElement instanceof \PhpOffice\PhpWord\Element\ListItemRun) {
+                    $content .= '<ul>';
+                } elseif ($prevElement->getDepth() < $element->getDepth()) {
+                    if (str_ends_with($content, '</li>')) {
+                        $content = substr($content, 0, -5);
+                    }
+                    $content .= '<ul>';
+                }
+            }
+
             $elementClass = get_class($element);
             $writerClass = str_replace('PhpOffice\\PhpWord\\Element', $this->namespace, $elementClass);
             if (class_exists($writerClass)) {
                 /** @var AbstractElement $writer Type hint */
                 $writer = new $writerClass($this->parentWriter, $element, $withoutP);
                 $content .= $writer->write();
             }
+
+            if ($element instanceof \PhpOffice\PhpWord\Element\ListItemRun) {
+                $nextElement = $elements[$index + 1] ?? null;
+
+                if ($nextElement === null) {
+                    $content .= '</ul>';
+                } elseif (!$nextElement instanceof \PhpOffice\PhpWord\Element\ListItemRun) {
+                    $content .= '</ul>';
+                } elseif ($nextElement->getDepth() < $element->getDepth()) {
+                    for ($i = $element->getDepth() - $nextElement->getDepth(); $i !== 0; --$i) {
+                        $content .= '</ul></li>';
+                    }
+                }
+            }
         }
 
         return $content;

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

@@ -36,9 +36,22 @@ public function write()
             return '';
         }
 
-        $writer = new Container($this->parentWriter, $this->element);
-        $content = $writer->write() . PHP_EOL;
+        $content = '<li>';
 
-        return $content;
+        foreach ($this->element->getElements() as $element) {
+            $namespace = 'PhpOffice\\PhpWord\\Writer\\HTML\\Element';
+            $elementClass = get_class($element);
+            $writerClass = str_replace('PhpOffice\\PhpWord\\Element', $namespace, $elementClass);
+
+            if (!class_exists($writerClass)) {
+                continue;
+            }
+
+            /** @var AbstractElement $writer */
+            $writer = new $writerClass($this->parentWriter, $element, true);
+            $content .= $writer->write();
+        }
+
+        return "$content</li>";
     }
 }

tests/PhpWordTests/Writer/HTML/ElementTest.php

@@ -200,24 +200,62 @@ public function testWriteTitleTextRun(): void
      */
     public function testListItemRun(): void
     {
-        $expected1 = 'List item run 1';
-        $expected2 = 'List item run 1 in bold';
+        $expected11 = 'List item run 1.1';
+        $expected11InBold = 'List item run 1.1 in bold';
+        $expected12 = 'List item run 1.2';
+        $expected21 = 'List item run 2.1';
+        $expected22 = 'List item run 2.2';
+        $expected31 = 'List item run 3.1';
+        $expected13 = 'List item run 1.3';
 
         $phpWord = new PhpWord();
         $section = $phpWord->addSection();
 
-        $listItemRun = $section->addListItemRun(0, null, 'MyParagraphStyle');
-        $listItemRun->addText($expected1);
-        $listItemRun->addText($expected2, ['bold' => true]);
+        $section->addText('List with inline formatting.');
+        $listItemRun = $section->addListItemRun();
+        $listItemRun->addText('List item 1');
+        $listItemRun->addText(' in bold', ['bold' => true]);
+        $listItemRun = $section->addListItemRun(1);
+        $listItemRun->addText('List item 2');
+        $listItemRun->addText(' in italic', ['italic' => true]);
+        $footnote = $listItemRun->addFootnote();
+        $footnote->addText('this is a footnote on a list item');
+        $listItemRun = $section->addListItemRun();
+        $listItemRun->addText('List item 3');
+        $listItemRun->addText(' underlined', ['underline' => 'dash']);
+        $section->addTextBreak(2);
 
         $htmlWriter = new HTML($phpWord);
         $content = $htmlWriter->getContent();
 
         $dom = new DOMDocument();
         $dom->loadHTML($content);
 
-        self::assertEquals($expected1, $dom->getElementsByTagName('p')->item(0)->textContent);
-        self::assertEquals($expected2, $dom->getElementsByTagName('p')->item(1)->textContent);
+        $xpath = new DOMXPath($dom);
+
+        $list = $xpath->query('//body/div/ul/li');
+
+        $item11 = $list->item(0);
+        $item12 = $list->item(1);
+        $item13 = $list->item(2);
+
+        self::assertEquals($expected11, $item11->childNodes->item(0)->textContent);
+        self::assertEquals('span', $item11->childNodes->item(1)->nodeName);
+        self::assertEquals($expected11InBold, $item11->childNodes->item(1)->textContent);
+
+        self::assertEquals($expected12, $item12->childNodes->item(0)->textContent);
+        self::assertEquals('ul', $item12->childNodes->item(1)->nodeName);
+
+        self::assertEquals($expected21, $item12->childNodes->item(1)->childNodes->item(0)->textContent);
+
+        $item22 = $item12->childNodes->item(1)->childNodes->item(1);
+
+        self::assertEquals($expected22, $item22->childNodes->item(0)->textContent);
+        self::assertEquals('ul', $item22->childNodes->item(1)->nodeName);
+
+        self::assertEquals($expected31, $item22->childNodes->item(1)->childNodes->item(0)->textContent);
+
+        self::assertEquals($expected13, $item13->childNodes->item(0)->textContent);
     }
 
     /**