RTF Writer: Paragraph - Add Missing Features

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 RTF: Add multiple missing controls and fix existing controls in Paragraph by [@rasamassen](https://github.com/rasamassen) in [#2824](https://github.com/PHPOffice/PHPWord/pull/2824)
 
 ### Miscellaneous
 
@@ -16,4 +17,4 @@
 
 ### BC Breaks
 
-### Notes
+### Notes

src/PhpWord/Writer/RTF/Style/AbstractStyle.php

@@ -105,4 +105,27 @@ protected function getValueIf($condition, $value)
     {
         return $condition == true ? $value : '';
     }
+
+    /**
+     * Write child style.
+     *
+     * @param string $name
+     * @param mixed $style
+     *
+     * @return string
+     */
+    protected function writeChildStyle($name, $style = null)
+    {
+        $stylePath = 'PhpOffice\\PhpWord\\Style\\' . ucfirst($name);
+        if (isset($style) && $style instanceof $stylePath) {
+            $writerPath = 'PhpOffice\\PhpWord\\Writer\\RTF\\Style\\' . ucfirst($name);
+            $writer = new $writerPath($style);
+
+            if (method_exists($writer, 'write')) {
+                return $writer->write();
+            }
+        }
+
+        return '';
+    }
 }

src/PhpWord/Writer/RTF/Style/Paragraph.php

@@ -36,10 +36,6 @@ class Paragraph extends AbstractStyle
      */
     private $nestedLevel = 0;
 
-    private const LEFT = Jc::LEFT;
-    private const RIGHT = Jc::RIGHT;
-    private const JUSTIFY = Jc::JUSTIFY;
-
     /**
      * Write style.
      *
@@ -57,69 +53,72 @@ public function write()
             Jc::END => '\qr',
             Jc::CENTER => '\qc',
             Jc::BOTH => '\qj',
-            self::LEFT => '\ql',
-            self::RIGHT => '\qr',
-            self::JUSTIFY => '\qj',
+            Jc::LEFT => '\ql',
+            Jc::RIGHT => '\qr',
+            Jc::JUSTIFY => '\qj',
+            Jc::DISTRIBUTE => '\qd',
+            Jc::THAI_DISTRIBUTE => '\qt',
+            Jc::HIGH_KASHIDA => '\qk20',
+            Jc::MEDIUM_KASHIDA => '\qk10',
+            Jc::LOW_KASHIDA => '\qk0',
         ];
         $bidiAlignments = [
             Jc::START => '\qr',
             Jc::END => '\ql',
             Jc::CENTER => '\qc',
             Jc::BOTH => '\qj',
-            self::LEFT => '\ql',
-            self::RIGHT => '\qr',
-            self::JUSTIFY => '\qj',
+            Jc::LEFT => '\ql',
+            Jc::RIGHT => '\qr',
+            Jc::JUSTIFY => '\qj',
+            Jc::DISTRIBUTE => '\qd',
+            Jc::THAI_DISTRIBUTE => '\qt',
+            Jc::HIGH_KASHIDA => '\qk20',
+            Jc::MEDIUM_KASHIDA => '\qk10',
+            Jc::LOW_KASHIDA => '\qk0',
         ];
 
-        $spaceAfter = $style->getSpaceAfter();
-        $spaceBefore = $style->getSpaceBefore();
-
         $content = '';
         if ($this->nestedLevel == 0) {
-            $content .= '\pard\nowidctlpar ';
+            $content .= '\pard';
         }
+
+        // Alignment
         $alignment = $style->getAlignment();
         $bidi = $style->isBidi();
         if ($alignment === '' && $bidi !== null) {
             $alignment = Jc::START;
         }
+
+        // Right to left
         if (isset($alignments[$alignment])) {
             $content .= $bidi ? $bidiAlignments[$alignment] : $alignments[$alignment];
         }
-        $content .= $this->writeIndentation($style->getIndentation());
-        $content .= $this->getValueIf($spaceBefore !== null, '\sb' . round($spaceBefore ?? 0));
-        $content .= $this->getValueIf($spaceAfter !== null, '\sa' . round($spaceAfter ?? 0));
-        $lineHeight = $style->getLineHeight();
-        if ($lineHeight) {
-            $lineHeightAdjusted = (int) ($lineHeight * 240);
-            $content .= "\\sl$lineHeightAdjusted\\slmult1";
-        }
-        if ($style->hasPageBreakBefore()) {
-            $content .= '\\page';
-        }
+        $content .= $this->getValueIf($style->isBidi(), '\rtlpar');
 
-        $styles = $style->getStyleValues();
-        $content .= $this->writeTabs($styles['tabs']);
+        // Indentation - Future: Create writeChildStyle in AbstractStyle
+        $content .= $this->writeChildStyle('Indentation', $style->getIndentation());
+        $content .= $this->writeChildStyle('Spacing', $style->getSpace());
+        // Future: Add Shading
 
-        return $content;
-    }
+        // Contextual Spacing
+        $content .= $this->getValueIf($style->hasContextualSpacing(), '\contextualspace');
+        // Future: Add Text Alignment
 
-    /**
-     * Writes an \PhpOffice\PhpWord\Style\Indentation.
-     *
-     * @param null|\PhpOffice\PhpWord\Style\Indentation $indent
-     *
-     * @return string
-     */
-    private function writeIndentation($indent = null)
-    {
-        if (isset($indent) && $indent instanceof \PhpOffice\PhpWord\Style\Indentation) {
-            $writer = new Indentation($indent);
+        // Pagination
+        $content .= $this->getValueIf($style->hasWidowControl(), '\widctlpar');
+        $content .= $this->getValueIf(!$style->hasWidowControl(), '\nowidctlpar');
+        $content .= $this->getValueIf($style->isKeepNext(), '\keepn');
+        $content .= $this->getValueIf($style->isKeepLines(), '\keep');
+        $content .= $this->getValueIf($style->hasPageBreakBefore(), '\pagebb');
 
-            return $writer->write();
-        }
+        // Hyphenation
+        $content .= $this->getValueIf($style->hasSuppressAutoHyphens(), '\hyphpar0');
+
+        // Tabs
+        $styles = $style->getStyleValues();
+        $content .= $this->writeTabs($styles['tabs']);
 
-        return '';
+        return $content . ' ';
     }
 
     /**

src/PhpWord/Writer/RTF/Style/Spacing.php

@@ -0,0 +1,72 @@
+<?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\Style;
+
+use PhpOffice\PhpWord\SimpleType\LineSpacingRule;
+
+/**
+ * RTF Spacing style writer.
+ *
+ * @since 0.11.0
+ */
+class Spacing extends AbstractStyle
+{
+    /**
+     * Write style.
+     *
+     * @return string
+     */
+    public function write()
+    {
+        $style = $this->getStyle();
+        if (!$style instanceof \PhpOffice\PhpWord\Style\Spacing) {
+            return '';
+        }
+
+        $spacingRules = [
+            LineSpacingRule::AUTO => '\slmult1',
+            LineSpacingRule::EXACT => '\slmult0',
+            LineSpacingRule::AT_LEAST => '\slmult0',
+        ];
+
+        $content = '';
+
+        // Space Before and After
+        $content .= $this->getValueIf($style->getBefore() !== null, '\sb' . round($style->getBefore() ?? 0));
+        $content .= $this->getValueIf($style->getAfter() !== null, '\sa' . round($style->getAfter() ?? 0));
+
+        // Space Between Lines
+        $line = $style->getLine();
+        if (null !== $line && $style->getLineRule() === LineSpacingRule::AUTO) {
+            $line += \PhpOffice\PhpWord\Style\Paragraph::LINE_HEIGHT;
+        }
+        // Exact is specified by using negative numbers
+        if ($style->getLineRule() === LineSpacingRule::EXACT && $line > 0) {
+            $line = $line * -1;
+        }
+        $content .= $this->getValueIf($line !== null, '\sl' . round($line ?? 0));
+
+        // Spacing Multiple
+        if ($line !== null) {
+            $content .= $this->getValueIf(isset($spacingRules[$style->getLineRule()]), $spacingRules[$style->getLineRule()]);
+        }
+
+        return $content;
+    }
+}

tests/PhpWordTests/Escaper/RtfEscaper2Test.php

@@ -23,7 +23,7 @@
  */
 class RtfEscaper2Test extends \PHPUnit\Framework\TestCase
 {
-    const HEADER = '\\pard\\nowidctlpar {\\cf0\\f0 ';
+    const HEADER = '\\pard\\widctlpar {\\cf0\\f0 ';
     const TRAILER = '}\\par';
 
     public function escapestring($str)

tests/PhpWordTests/Escaper/RtfEscaper3Test.php

@@ -25,8 +25,8 @@
  */
 class RtfEscaper3Test extends \PHPUnit\Framework\TestCase
 {
-    const HEADER = '\\pard\\nowidctlpar \ql{\\cf0\\f0 ';
-    const HEADER_RTL = '\\pard\\nowidctlpar \qr{\\rtlch\\cf0\\f0 ';
+    const HEADER = '\\pard\\ql\\widctlpar {\\cf0\\f0 ';
+    const HEADER_RTL = '\\pard\\qr\\rtlpar\\widctlpar {\\rtlch\\cf0\\f0 ';
     const TRAILER = '}\\par';
 
     protected function tearDown(): void

tests/PhpWordTests/Writer/RTF/Element/TableTest.php

@@ -59,15 +59,15 @@ public function testTable(): void
             '\\pard',
             "\\trowd \\cellx$width \\cellx$width2 ",
             '\\intbl',
-            '\\ql{\\cf0\\f0 1}\\par',
+            '\\ql\\widctlpar {\\cf0\\f0 1}\\par',
             '\\cell',
             '\\intbl',
             '{\\cf0\\f0 2}\\par',
             '\\cell',
             '\\row',
             "\\trowd \\cellx$width \\cellx$width2 ",
             '\\intbl',
-            '\\ql{\\cf0\\f0 3}\\par',
+            '\\ql\\widctlpar {\\cf0\\f0 3}\\par',
             '\\cell',
             '\\intbl',
             '{\\cf0\\f0 4}\par',
@@ -102,7 +102,7 @@ public function testTableStyle(): void
             '\\clbrdrr\\brdrs\\brdrw2\\brdrcf0',
             "\\cellx$width ",
             '\\intbl',
-            '\\ql{\\cf0\\f0 1}\\par',
+            '\\ql\\widctlpar {\\cf0\\f0 1}\\par',
             '\\cell',
             '\\row',
             '\\pard',
@@ -128,7 +128,7 @@ public function testTableStyleNotExisting(): void
             '\\pard',
             "\\trowd \\cellx$width ",
             '\\intbl',
-            '\\ql{\\cf0\\f0 1}\\par',
+            '\\ql\\widctlpar {\\cf0\\f0 1}\\par',
             '\\cell',
             '\\row',
             '\\pard',
@@ -158,7 +158,7 @@ public function testTableCellStyle(): void
             '\\clbrdrr\\brdrdot\\brdrw2\\brdrcf0',
             "\\cellx$width ",
             '\\intbl',
-            '\\ql{\\cf0\\f0 1}\\par',
+            '\\ql\\widctlpar {\\cf0\\f0 1}\\par',
             '\\cell',
             '\\row',
             '\\pard',

tests/PhpWordTests/Writer/RTF/Element2Test.php

@@ -47,7 +47,7 @@ public function testTextRun(): void
         $element->addText('Hello ');
         $element->addText('there.');
         $textrun = new WriterTextRun($parentWriter, $element);
-        $expect = "\\pard\\nowidctlpar \\ql{{\\cf0\\f0 Hello }{\\cf0\\f0 there.}}\\par\n";
+        $expect = "\\pard\\ql\\widctlpar {{\\cf0\\f0 Hello }{\\cf0\\f0 there.}}\\par\n";
         self::assertEquals($expect, $this->removeCr($textrun));
     }
 
@@ -59,7 +59,7 @@ public function testTextRunParagraphStyle(): void
         $element->addText('Hello ');
         $element->addText('there.');
         $textrun = new WriterTextRun($parentWriter, $element);
-        $expect = "\\pard\\nowidctlpar \\ql\\sb0\\sa0{{\\cf0\\f0 Hello }{\\cf0\\f0 there.}}\\par\n";
+        $expect = "\\pard\\ql\\sb0\\sa0\\widctlpar {{\\cf0\\f0 Hello }{\\cf0\\f0 there.}}\\par\n";
         self::assertEquals($expect, $this->removeCr($textrun));
     }
 
@@ -72,7 +72,7 @@ public function testTitle(): void
         $section = $phpWord->addSection();
         $element = $section->addTitle('First Heading', 1);
         $elwrite = new WriterTitle($parentWriter, $element);
-        $expect = "\\pard\\nowidctlpar \\ql\\sb0\\sa0{\\outlinelevel0{\\cf0\\f0 First Heading}\\par\n}";
+        $expect = "\\pard\\ql\\sb0\\sa0\\widctlpar {\\outlinelevel0{\\cf0\\f0 First Heading}\\par\n}";
         self::assertEquals($expect, $this->removeCr($elwrite));
         Settings::setDefaultRtl(null);
     }

tests/PhpWordTests/Writer/RTF/ElementTest.php

@@ -121,15 +121,15 @@ public function testTable(): void
             '\\pard',
             "\\trowd \\cellx$width \\cellx$width2 ",
             '\\intbl',
-            '{\\cf0\\f0 1}\\par',
+            '\\widctlpar {\\cf0\\f0 1}\\par',
             '\\cell',
             '\\intbl',
             '{\\cf0\\f0 2}\\par',
             '\\cell',
             '\\row',
             "\\trowd \\cellx$width \\cellx$width2 ",
             '\\intbl',
-            '{\\cf0\\f0 3}\\par',
+            '\\widctlpar {\\cf0\\f0 3}\\par',
             '\\cell',
             '\\intbl',
             '{\\cf0\\f0 4}\par',
@@ -149,7 +149,7 @@ public function testTextRun(): void
         $element->addText('Hello ');
         $element->addText('there.');
         $textrun = new RTF\Element\TextRun($parentWriter, $element);
-        $expect = "\\pard\\nowidctlpar {{\\cf0\\f0 Hello }{\\cf0\\f0 there.}}\\par\n";
+        $expect = "\\pard\\widctlpar {{\\cf0\\f0 Hello }{\\cf0\\f0 there.}}\\par\n";
         self::assertEquals($expect, $this->removeCr($textrun));
     }
 
@@ -160,7 +160,7 @@ public function testTextRunParagraphStyle(): void
         $element->addText('Hello ');
         $element->addText('there.');
         $textrun = new RTF\Element\TextRun($parentWriter, $element);
-        $expect = "\\pard\\nowidctlpar \\sb0\\sa0{{\\cf0\\f0 Hello }{\\cf0\\f0 there.}}\\par\n";
+        $expect = "\\pard\\sb0\\sa0\\widctlpar {{\\cf0\\f0 Hello }{\\cf0\\f0 there.}}\\par\n";
         self::assertEquals($expect, $this->removeCr($textrun));
     }
 
@@ -172,7 +172,7 @@ public function testTitle(): void
         $section = $phpWord->addSection();
         $element = $section->addTitle('First Heading', 1);
         $elwrite = new RTF\Element\Title($parentWriter, $element);
-        $expect = "\\pard\\nowidctlpar \\sb0\\sa0{\\outlinelevel0{\\cf0\\f0 First Heading}\\par\n}";
+        $expect = "\\pard\\sb0\\sa0\\widctlpar {\\outlinelevel0{\\cf0\\f0 First Heading}\\par\n}";
         self::assertEquals($expect, $this->removeCr($elwrite));
     }
 
@@ -188,7 +188,7 @@ public function testRuby(): void
         $element->addRuby($baseTextRun, $rubyTextRun, $properties);
 
         $textrun = new RTF\Element\TextRun($parentWriter, $element);
-        $expect = "\\pard\\nowidctlpar {{base text (ruby)}}\\par\n";
+        $expect = "\\pard\\widctlpar {{base text (ruby)}}\\par\n";
         self::assertEquals($expect, $this->removeCr($textrun));
     }
 
@@ -213,7 +213,7 @@ public function testRubyTitle(): void
         $element = $section->addTitle($textRun, 1);
         $elwrite = new RTF\Element\Title($parentWriter, $element);
 
-        $expect = "\\pard\\nowidctlpar \\sb0\\sa2{\\outlinelevel0{\\cf0\\f0\\fs48\\b base text (ruby)}\\par\n}";
+        $expect = "\\pard\\sb0\\sa2\\widctlpar {\\outlinelevel0{\\cf0\\f0\\fs48\\b base text (ruby)}\\par\n}";
         self::assertEquals($expect, $this->removeCr($elwrite));
     }
 }