RTF Changes

oleibman · oleibman · commit ecfafd757667 · 2019-12-03T07:46:16.000-08:00
1. Converter is currently expecting colors as strings of hex digits,
   but PhpWord allows specification of colors by named constant, so
   result is random when one of those is used. This change handles
   all the named colors.
2. Table needs \pard at end; formatting may be wrong without it.
3. RTF writer will no longer ignore paragraph style for TextRun.
4. RTF writer will no longer ignore paragraph and font style for Title.
5. Add support for RTF headers and footers.
6. Add support for right-to-left in font.
7. Add support for PageBreakBefore and LineHeight for paragraphs.
8. Add support for PageNumberingStart for sections.

There are test cases for all of these changes.
diff --git a/src/PhpWord/Shared/Converter.php b/src/PhpWord/Shared/Converter.php
@@ -326,8 +326,9 @@ public static function htmlToRgb($value)
     {
         if ($value[0] == '#') {
             $value = substr($value, 1);
+        } else {
+            $value = self::stringToRgb($value);
         }
-        $value = self::stringToRgb($value);
 
         if (strlen($value) == 6) {
             list($red, $green, $blue) = array($value[0] . $value[1], $value[2] . $value[3], $value[4] . $value[5]);
diff --git a/src/PhpWord/Writer/RTF/Element/AbstractElement.php b/src/PhpWord/Writer/RTF/Element/AbstractElement.php
@@ -41,14 +41,14 @@ abstract class AbstractElement extends HTMLAbstractElement
      *
      * @var \PhpOffice\PhpWord\Style\Font
      */
-    private $fontStyle;
+    protected $fontStyle;
 
     /**
      * Paragraph style
      *
      * @var \PhpOffice\PhpWord\Style\Paragraph
      */
-    private $paragraphStyle;
+    protected $paragraphStyle;
 
     public function __construct(AbstractWriter $parentWriter, Element $element, $withoutP = false)
     {
diff --git a/src/PhpWord/Writer/RTF/Element/Table.php b/src/PhpWord/Writer/RTF/Element/Table.php
@@ -58,6 +58,7 @@ public function write()
                 $content .= $this->writeRow($rows[$i]);
                 $content .= '\row' . PHP_EOL;
             }
+            $content .= '\pard' . PHP_EOL;
         }
 
         return $content;
diff --git a/src/PhpWord/Writer/RTF/Element/TextRun.php b/src/PhpWord/Writer/RTF/Element/TextRun.php
@@ -32,6 +32,7 @@ class TextRun extends AbstractElement
     public function write()
     {
         $writer = new Container($this->parentWriter, $this->element);
+        $this->getStyles();
 
         $content = '';
         $content .= $this->writeOpening();
diff --git a/src/PhpWord/Writer/RTF/Element/Title.php b/src/PhpWord/Writer/RTF/Element/Title.php
@@ -24,4 +24,71 @@
  */
 class Title extends Text
 {
+    protected function getStyles()
+    {
+        /** @var \PhpOffice\PhpWord\Element\Text $element Type hint */
+        $element = $this->element;
+        $style = $element->getStyle();
+        if (is_string($style)) {
+            $style = str_replace('Heading', 'Heading_', $style);
+            $style = \PhpOffice\PhpWord\Style::getStyle($style);
+            if ($style instanceof \PhpOffice\PhpWord\Style\Font) {
+                $this->fontStyle = $style;
+                $pstyle = $style->getParagraph();
+                if ($pstyle instanceof \PhpOffice\PhpWord\Style\Paragraph && $pstyle->hasPageBreakBefore()) {
+                    $sect = $element->getParent();
+                    if ($sect instanceof \PhpOffice\PhpWord\Element\Section) {
+                        $elems = $sect->getElements();
+                        if ($elems[0] === $element) {
+                            $pstyle = clone $pstyle;
+                            $pstyle->setPageBreakBefore(false);
+                        }
+                    }
+                }
+                $this->paragraphStyle = $pstyle;
+            }
+        }
+    }
+
+    /**
+     * Write element
+     *
+     * @return string
+     */
+    public function write()
+    {
+        /** @var \PhpOffice\PhpWord\Element\Text $element Type hint */
+        $element = $this->element;
+        $elementClass = str_replace('\\Writer\\RTF', '', get_class($this));
+        if (!$element instanceof $elementClass || !is_string($element->getText())) {
+            return '';
+        }
+
+        $this->getStyles();
+
+        $content = '';
+
+        $content .= $this->writeOpening();
+        $endout = '';
+        $style = $element->getStyle();
+        if (is_string($style)) {
+            $style = str_replace('Heading', '', $style);
+            if (is_numeric($style)) {
+                $style = (int) $style - 1;
+                if ($style >= 0 && $style <= 8) {
+                    $content .= '{\\outlinelevel' . $style;
+                    $endout = '}';
+                }
+            }
+        }
+
+        $content .= '{';
+        $content .= $this->writeFontStyle();
+        $content .= $this->writeText($element->getText());
+        $content .= '}';
+        $content .= $this->writeClosing();
+        $content .= $endout;
+
+        return $content;
+    }
 }
diff --git a/src/PhpWord/Writer/RTF/Part/Document.php b/src/PhpWord/Writer/RTF/Part/Document.php
@@ -17,6 +17,7 @@
 
 namespace PhpOffice\PhpWord\Writer\RTF\Part;
 
+use PhpOffice\PhpWord\Element\Footer;
 use PhpOffice\PhpWord\Settings;
 use PhpOffice\PhpWord\Writer\RTF\Element\Container;
 use PhpOffice\PhpWord\Writer\RTF\Style\Section as SectionStyleWriter;
@@ -105,11 +106,36 @@ private function writeFormatting()
         $content .= '\lang' . $langId;
         $content .= '\kerning1'; // Point size (in half-points) above which to kern character pairs
         $content .= '\fs' . (Settings::getDefaultFontSize() * 2); // Set the font size in half-points
+        if ($docSettings->hasEvenAndOddHeaders()) {
+            $content .= '\\facingp';
+        }
         $content .= PHP_EOL;
 
         return $content;
     }
 
+    /**
+     * Write titlepg directive if any "f" headers or footers
+     *
+     * @param \PhpOffice\PhpWord\PhpWord\Element\Section $section
+     * @return string
+     */
+    private static function writeTitlepg($section)
+    {
+        foreach ($section->getHeaders() as $header) {
+            if ($header->getType() === Footer::FIRST) {
+                return '\\titlepg' . PHP_EOL;
+            }
+        }
+        foreach ($section->getFooters() as $header) {
+            if ($header->getType() === Footer::FIRST) {
+                return '\\titlepg' . PHP_EOL;
+            }
+        }
+
+        return '';
+    }
+
     /**
      * Write sections
      *
@@ -120,10 +146,53 @@ private function writeSections()
         $content = '';
 
         $sections = $this->getParentWriter()->getPhpWord()->getSections();
+        $evenOdd = $this->getParentWriter()->getPhpWord()->getSettings()->hasEvenAndOddHeaders();
         foreach ($sections as $section) {
             $styleWriter = new SectionStyleWriter($section->getStyle());
             $styleWriter->setParentWriter($this->getParentWriter());
             $content .= $styleWriter->write();
+            $content .= self::writeTitlepg($section);
+
+            foreach ($section->getHeaders() as $header) {
+                $type = $header->getType();
+                if ($evenOdd || $type !== FOOTER::EVEN) {
+                    $content .= '{\\header';
+                    if ($type === Footer::FIRST) {
+                        $content .= 'f';
+                    } elseif ($evenOdd) {
+                        $content .= ($type === FOOTER::EVEN) ? 'l' : 'r';
+                    }
+                    foreach ($header->getElements() as $element) {
+                        $cl = get_class($element);
+                        $cl2 = str_replace('Element', 'Writer\\RTF\\Element', $cl);
+                        if (class_exists($cl2)) {
+                            $elementWriter = new $cl2($this->getParentWriter(), $element);
+                            $content .= $elementWriter->write();
+                        }
+                    }
+                    $content .= '}' . PHP_EOL;
+                }
+            }
+            foreach ($section->getFooters() as $footer) {
+                $type = $footer->getType();
+                if ($evenOdd || $type !== FOOTER::EVEN) {
+                    $content .= '{\\footer';
+                    if ($type === Footer::FIRST) {
+                        $content .= 'f';
+                    } elseif ($evenOdd) {
+                        $content .= ($type === FOOTER::EVEN) ? 'l' : 'r';
+                    }
+                    foreach ($footer->getElements() as $element) {
+                        $cl = get_class($element);
+                        $cl2 = str_replace('Element', 'Writer\\RTF\\Element', $cl);
+                        if (class_exists($cl2)) {
+                            $elementWriter = new $cl2($this->getParentWriter(), $element);
+                            $content .= $elementWriter->write();
+                        }
+                    }
+                    $content .= '}' . PHP_EOL;
+                }
+            }
 
             $elementWriter = new Container($this->getParentWriter(), $section);
             $content .= $elementWriter->write();
diff --git a/src/PhpWord/Writer/RTF/Style/Font.php b/src/PhpWord/Writer/RTF/Style/Font.php
@@ -49,6 +49,7 @@ public function write()
         }
 
         $content = '';
+        $content .= $this->getValueIf($style->isRTL(), '\rtlch');
         $content .= '\cf' . $this->colorIndex;
         $content .= '\f' . $this->nameIndex;
 
diff --git a/src/PhpWord/Writer/RTF/Style/Paragraph.php b/src/PhpWord/Writer/RTF/Style/Paragraph.php
@@ -52,6 +52,8 @@ public function write()
             Jc::END    => '\qr',
             Jc::CENTER => '\qc',
             Jc::BOTH   => '\qj',
+            Jc::LEFT   => '\ql',
+            Jc::RIGHT  => '\qr',
         );
 
         $spaceAfter = $style->getSpaceAfter();
@@ -67,6 +69,14 @@ public function write()
         $content .= $this->writeIndentation($style->getIndentation());
         $content .= $this->getValueIf($spaceBefore !== null, '\sb' . round($spaceBefore));
         $content .= $this->getValueIf($spaceAfter !== null, '\sa' . round($spaceAfter));
+        $lineHeight = $style->getLineHeight();
+        if ($lineHeight !== null) {
+            $lineHeightAdjusted = (int) ($lineHeight * 240);
+            $content .= "\\sl$lineHeightAdjusted\\slmult1";
+        }
+        if ($style->getPageBreakBefore()) {
+            $content .= '\\page';
+        }
 
         $styles = $style->getStyleValues();
         $content .= $this->writeTabs($styles['tabs']);
diff --git a/src/PhpWord/Writer/RTF/Style/Section.php b/src/PhpWord/Writer/RTF/Style/Section.php
@@ -53,6 +53,7 @@ public function write()
         $content .= $this->getValueIf($style->getHeaderHeight() !== null, '\headery' . round($style->getHeaderHeight()));
         $content .= $this->getValueIf($style->getFooterHeight() !== null, '\footery' . round($style->getFooterHeight()));
         $content .= $this->getValueIf($style->getGutter() !== null, '\guttersxn' . round($style->getGutter()));
+        $content .= $this->getValueIf($style->getPageNumberingStart() !== null, '\pgnstarts' . $style->getPageNumberingStart() . '\pgnrestart');
         $content .= ' ';
 
         // Borders
diff --git a/tests/PhpWord/Shared/ConverterTest.php b/tests/PhpWord/Shared/ConverterTest.php
@@ -108,19 +108,13 @@ public function testUnitConversions()
      */
     public function testHtmlToRGB()
     {
-        // Prepare test values [ original, expected ]
-        $values = array();
-        $values[] = array('#FF99DD', array(255, 153, 221)); // With #
-        $values[] = array('FF99DD', array(255, 153, 221)); // 6 characters
-        $values[] = array('F9D', array(255, 153, 221)); // 3 characters
-        $values[] = array('0F9D', false); // 4 characters
-        $values[] = array(\PhpOffice\PhpWord\Style\Font::FGCOLOR_DARKMAGENTA, array(139, 0, 139));
-        $values[] = array('unknow', array(0, 0, 0)); // 6 characters, invalid
-        // Conduct test
-        foreach ($values as $value) {
-            $result = Converter::htmlToRgb($value[0]);
-            $this->assertEquals($value[1], $result);
-        }
+        $flse = false;
+        $this->assertEquals(array(255, 153, 221), Converter::htmlToRgb('#FF99DD')); // With #
+        $this->assertEquals(array(224, 170, 29), Converter::htmlToRgb('E0AA1D')); // 6 characters
+        $this->assertEquals(array(102, 119, 136), Converter::htmlToRgb('678')); // 3 characters
+        $this->assertEquals($flse, Converter::htmlToRgb('0F9D')); // 4 characters
+        $this->assertEquals(array(0, 0, 0), Converter::htmlToRgb('unknow')); // 6 characters, invalid
+        $this->assertEquals(array(139, 0, 139), Converter::htmlToRgb(\PhpOffice\PhpWord\Style\Font::FGCOLOR_DARKMAGENTA)); // Constant
     }
 
     /**
diff --git a/tests/PhpWord/Writer/RTF/ElementTest.php b/tests/PhpWord/Writer/RTF/ElementTest.php
@@ -80,4 +80,80 @@ public function testIndexField()
 
         $this->assertEquals("{}\\par\n", $this->removeCr($field));
     }
+
+    public function testTable()
+    {
+        $parentWriter = new RTF();
+        $element = new \PhpOffice\PhpWord\Element\Table();
+        $width = 100;
+        $width2 = 2 * $width;
+        $element->addRow();
+        $tce = $element->addCell($width);
+        $tce->addText('1');
+        $tce = $element->addCell($width);
+        $tce->addText('2');
+        $element->addRow();
+        $tce = $element->addCell($width);
+        $tce->addText('3');
+        $tce = $element->addCell($width);
+        $tce->addText('4');
+        $table = new \PhpOffice\PhpWord\Writer\RTF\Element\Table($parentWriter, $element);
+        $expect = implode("\n", array(
+            '\\pard',
+            "\\trowd \\cellx$width \\cellx$width2 ",
+            '\\intbl',
+            '{\\cf0\\f0 1}\\par',
+            '\\cell',
+            '\\intbl',
+            '{\\cf0\\f0 2}\\par',
+            '\\cell',
+            '\\row',
+            "\\trowd \\cellx$width \\cellx$width2 ",
+            '\\intbl',
+            '{\\cf0\\f0 3}\\par',
+            '\\cell',
+            '\\intbl',
+            '{\\cf0\\f0 4}\par',
+            '\\cell',
+            '\\row',
+            '\\pard',
+            '',
+            ));
+
+        $this->assertEquals($expect, $this->removeCr($table));
+    }
+
+    public function testTextRun()
+    {
+        $parentWriter = new RTF();
+        $element = new \PhpOffice\PhpWord\Element\TextRun();
+        $element->addText('Hello ');
+        $element->addText('there.');
+        $textrun = new \PhpOffice\PhpWord\Writer\RTF\Element\TextRun($parentWriter, $element);
+        $expect = "\\pard\\nowidctlpar {{\\cf0\\f0 Hello }{\\cf0\\f0 there.}}\\par\n";
+        $this->assertEquals($expect, $this->removeCr($textrun));
+    }
+
+    public function testTextRunParagraphStyle()
+    {
+        $parentWriter = new RTF();
+        $element = new \PhpOffice\PhpWord\Element\TextRun(array('spaceBefore' => 0, 'spaceAfter' => 0));
+        $element->addText('Hello ');
+        $element->addText('there.');
+        $textrun = new \PhpOffice\PhpWord\Writer\RTF\Element\TextRun($parentWriter, $element);
+        $expect = "\\pard\\nowidctlpar \\sb0\\sa0{{\\cf0\\f0 Hello }{\\cf0\\f0 there.}}\\par\n";
+        $this->assertEquals($expect, $this->removeCr($textrun));
+    }
+
+    public function testTitle()
+    {
+        $parentWriter = new RTF();
+        $phpWord = new \PhpOffice\PhpWord\PhpWord();
+        $phpWord->addTitleStyle(1, array(), array('spaceBefore' => 0, 'spaceAfter' => 0));
+        $section = $phpWord->addSection();
+        $element = $section->addTitle('First Heading', 1);
+        $elwrite = new \PhpOffice\PhpWord\Writer\RTF\Element\Title($parentWriter, $element);
+        $expect = "\\pard\\nowidctlpar \\sb0\\sa0{\\outlinelevel0{\\cf0\\f0 First Heading}\\par\n}";
+        $this->assertEquals($expect, $this->removeCr($elwrite));
+    }
 }
diff --git a/tests/PhpWord/Writer/RTF/HeaderFooterTest.php b/tests/PhpWord/Writer/RTF/HeaderFooterTest.php
diff --git a/tests/PhpWord/Writer/RTF/StyleTest.php b/tests/PhpWord/Writer/RTF/StyleTest.php

Original file line number	Diff line number	Diff line change
`@@ -326,8 +326,9 @@ public static function htmlToRgb($value)`
`326`	`326`	`{`
`327`	`327`	`if ($value[0] == '#') {`
`328`	`328`	`$value = substr($value, 1);`
	`329`	`+ } else {`
	`330`	`+ $value = self::stringToRgb($value);`
`329`	`331`	`}`
`330`		`- $value = self::stringToRgb($value);`
`331`	`332`
`332`	`333`	`if (strlen($value) == 6) {`
`333`	`334`	`list($red, $green, $blue) = array($value[0] . $value[1], $value[2] . $value[3], $value[4] . $value[5]);`
Original file line number	Diff line number	Diff line change
`@@ -41,14 +41,14 @@ abstract class AbstractElement extends HTMLAbstractElement`
`41`	`41`	`*`
`42`	`42`	`* @var \PhpOffice\PhpWord\Style\Font`
`43`	`43`	`*/`
`44`		`- private $fontStyle;`
	`44`	`+ protected $fontStyle;`
`45`	`45`
`46`	`46`	`/**`
`47`	`47`	`* Paragraph style`
`48`	`48`	`*`
`49`	`49`	`* @var \PhpOffice\PhpWord\Style\Paragraph`
`50`	`50`	`*/`
`51`		`- private $paragraphStyle;`
	`51`	`+ protected $paragraphStyle;`
`52`	`52`
`53`	`53`	`public function __construct(AbstractWriter $parentWriter, Element $element, $withoutP = false)`
`54`	`54`	`{`
Original file line number	Diff line number	Diff line change
`@@ -58,6 +58,7 @@ public function write()`
`58`	`58`	`$content .= $this->writeRow($rows[$i]);`
`59`	`59`	`$content .= '\row' . PHP_EOL;`
`60`	`60`	`}`
	`61`	`+ $content .= '\pard' . PHP_EOL;`
`61`	`62`	`}`
`62`	`63`
`63`	`64`	`return $content;`
Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,7 @@ class TextRun extends AbstractElement`
`32`	`32`	`public function write()`
`33`	`33`	`{`
`34`	`34`	`$writer = new Container($this->parentWriter, $this->element);`
	`35`	`+ $this->getStyles();`
`35`	`36`
`36`	`37`	`$content = '';`
`37`	`38`	`$content .= $this->writeOpening();`
Original file line number	Diff line number	Diff line change
`@@ -49,6 +49,7 @@ public function write()`
`49`	`49`	`}`
`50`	`50`
`51`	`51`	`$content = '';`
	`52`	`+ $content .= $this->getValueIf($style->isRTL(), '\rtlch');`
`52`	`53`	`$content .= '\cf' . $this->colorIndex;`
`53`	`54`	`$content .= '\f' . $this->nameIndex;`
`54`	`55`