Rasamassen PR's 2821 and 2823

I made RTF usable some time ago. @rasamassen has recently done a lot of useful work to cover many missing areas. Since who knows when those changes will be merged, I intend to incorporate much of that work. I will do this with several pushes, each based on one or more of those changes. This one is based on PR PHPOffice#2821 (fixes issue PHPOffice#1106), and PR PHPOffice#2823.

Author: oleibman

src/PhpWord/Escaper/Rtf.php

@@ -31,6 +31,9 @@ protected function escapeAsciiCharacter($code)
         if ($code == 9) {
             return '{\\tab}';
         }
+        if ($code === 10) {
+            return ''; // or maybe '\par'
+        }
         if (0x20 > $code || $code >= 0x80) {
             return '{\\u' . $code . '}';
         }

src/PhpWord/Style/ListItem.php

@@ -115,6 +115,21 @@ public function getNumStyle()
         return $this->numStyle;
     }
 
+    /**
+     * Get numbering style.
+     *
+     * @return ?Numbering
+     */
+    public function getNumbering()
+    {
+        $numStyleObject = Style::getStyle($this->numStyle);
+        if ($numStyleObject instanceof Numbering) {
+            return $numStyleObject;
+        }
+
+        return null;
+    }
+
     /**
      * Set numbering style name.
      *

src/PhpWord/Writer/RTF.php

@@ -101,6 +101,16 @@ public function getColorTable()
         return $this->getWriterPart('Header')->getColorTable();
     }
 
+    /**
+     * Get list table.
+     *
+     * @return array
+     */
+    public function getListTable()
+    {
+        return $this->getWriterPart('Header')->getListTable();
+    }
+
     /**
      * Get last paragraph style.
      *

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

@@ -46,7 +46,7 @@ public function write()
             return '';
         }
         $containerClass = substr(get_class($container), strrpos(get_class($container), '\\') + 1);
-        $withoutP = in_array($containerClass, ['TextRun', 'Footnote', 'Endnote']) ? true : false;
+        $withoutP = in_array($containerClass, ['TextRun', 'Footnote', 'Endnote', 'ListItemRun', 'Field']) ? true : false;
         $content = '';
 
         $elements = $container->getElements();

src/PhpWord/Writer/RTF/Element/ListItem.php

@@ -25,4 +25,49 @@
  */
 class ListItem extends Text
 {
+    /**
+     * Write list item element.
+     */
+    public function write()
+    {
+        /** @var \PhpOffice\PhpWord\Element\Text $element Type hint */
+        $element = $this->element;
+        if (!$element instanceof \PhpOffice\PhpWord\Element\ListItem) {
+            return '';
+        }
+
+        $this->getStyles();
+
+        $depth = (int) $element->getDepth();
+        $style = $element->getStyle();
+        $text = $element->getTextObject();
+
+        // Bullet List
+        $content = '';
+        $content .= $this->writeOpening();
+        if ($style instanceof \PhpOffice\PhpWord\Style\ListItem) {
+            $numStyle = $style->getNumbering();
+            if ($numStyle->getType() == 'singleLevel') {
+                $depth = 0;
+            }
+            $levels = $numStyle->getLevels();
+            $content .= '\ilvl' . $element->getDepth();
+            $content .= '\ls' . $style->getNumId();
+            $content .= '\tx' . $levels[$depth]->getTabPos();
+            $content .= '\fi' . $levels[$depth]->getHanging() * -1;
+            $content .= '\li' . $levels[$depth]->getLeft();
+            $content .= '\lin' . $levels[$depth]->getLeft();
+        }
+        $content .= $this->writeFontStyle(); // Doesn't work. Don't know why. Probalby something to do with \PphOffice\PhpWord\Element\ListItem storing styles in a textObject type \PphOffice\PhpWord\Element\Text rather than within the Element itself
+        $content .= PHP_EOL;
+        /* $content .= '{\listtext\f2 \\\'b7\tab }'; // Not sure if needed for listItemRun
+        $content .= PHP_EOL; */
+        $content .= '{';
+        $content .= $this->writeText($element->getText());
+        $content .= '}';
+        $content .= PHP_EOL;
+        $content .= $this->writeClosing();
+
+        return $content;
+    }
 }

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

@@ -0,0 +1,67 @@
+<?php
+
+/**
+ * This file is part of PHPWord - A pure PHP library for reading and writing
+ * word processing documents.
+ *
+ * PHPWord is free software distributed under the terms of the GNU Lesser
+ * General Public License version 3 as published by the Free Software Foundation.
+ *
+ * For the full copyright and license information, please read the LICENSE
+ * file that was distributed with this source code. For the full list of
+ * contributors, visit https://github.com/PHPOffice/PHPWord/contributors.
+ *
+ * @see         https://github.com/PHPOffice/PHPWord
+ *
+ * @license     http://www.gnu.org/licenses/lgpl.txt LGPL version 3
+ */
+
+namespace PhpOffice\PhpWord\Writer\RTF\Element;
+
+/**
+ * ListItem element HTML writer.
+ *
+ * @since 0.10.0
+ */
+class ListItemRun extends TextRun
+{
+    /**
+     * Write list item.
+     *
+     * @return string
+     */
+    public function write()
+    {
+        $element = $this->element;
+        if (!$element instanceof \PhpOffice\PhpWord\Element\ListItemRun) {
+            return '';
+        }
+
+        $writer = new Container($this->parentWriter, $element);
+        $this->getStyles();
+
+        $depth = (int) $element->getDepth();
+        $style = $element->getStyle();
+
+        $content = '';
+        $content .= $this->writeOpening();
+        if ($style instanceof \PhpOffice\PhpWord\Style\ListItem) {
+            $numStyle = $style->getNumbering();
+            $levels = $numStyle->getLevels();
+            $content .= '\ilvl' . $element->getDepth();
+            $content .= '\ls' . $style->getNumId();
+            $content .= '\tx' . $levels[$depth]->getTabPos();
+            $hanging = $levels[$depth]->getLeft() + $levels[$depth]->getHanging();
+            $left = 0 - $levels[$depth]->getHanging();
+            $content .= '\fi' . $left;
+            $content .= '\li' . $hanging;
+            $content .= '\lin' . $hanging;
+        }
+        $content .= '{';
+        $content .= $writer->write();
+        $content .= '}';
+        $content .= $this->writeClosing();
+
+        return $content;
+    }
+}