RTF Writer: Add Pagination to Paragraph

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/Fix pagination 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/Paragraph.php

@@ -76,7 +76,7 @@ public function write()
 
         $content = '';
         if ($this->nestedLevel == 0) {
-            $content .= '\pard\nowidctlpar ';
+            $content .= '\pard';
         }
         $alignment = $style->getAlignment();
         $bidi = $style->isBidi();
@@ -94,14 +94,18 @@ public function write()
             $lineHeightAdjusted = (int) ($lineHeight * 240);
             $content .= "\\sl$lineHeightAdjusted\\slmult1";
         }
-        if ($style->hasPageBreakBefore()) {
-            $content .= '\\page';
-        }
+
+        // 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');
 
         $styles = $style->getStyleValues();
         $content .= $this->writeTabs($styles['tabs']);
 
-        return $content;
+        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\\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));
     }
 }

tests/PhpWordTests/Writer/RTF/StyleTest.php

@@ -126,7 +126,7 @@ public function testRTL(): void
         $parentWriter = new RTF();
         $element = new \PhpOffice\PhpWord\Element\Text('אב גד', ['RTL' => true]);
         $text = new RTF\Element\Text($parentWriter, $element);
-        $expect = "\\pard\\nowidctlpar {\\rtlch\\cf0\\f0 \\uc0{\\u1488}\\uc0{\\u1489} \\uc0{\\u1490}\\uc0{\\u1491}}\\par\n";
+        $expect = "\\pard\\widctlpar {\\rtlch\\cf0\\f0 \\uc0{\\u1488}\\uc0{\\u1489} \\uc0{\\u1490}\\uc0{\\u1491}}\\par\n";
         self::assertEquals($expect, $this->removeCr($text));
     }
 
@@ -136,7 +136,7 @@ public function testRTL2(): void
         $parentWriter = new RTF();
         $element = new \PhpOffice\PhpWord\Element\Text('אב גד');
         $text = new RTF\Element\Text($parentWriter, $element);
-        $expect = "\\pard\\nowidctlpar \\qr{\\rtlch\\cf0\\f0 \\uc0{\\u1488}\\uc0{\\u1489} \\uc0{\\u1490}\\uc0{\\u1491}}\\par\n";
+        $expect = "\\pard\\qr\\widctlpar {\\rtlch\\cf0\\f0 \\uc0{\\u1488}\\uc0{\\u1489} \\uc0{\\u1490}\\uc0{\\u1491}}\\par\n";
         self::assertEquals($expect, $this->removeCr($text));
     }
 
@@ -145,7 +145,7 @@ public function testPageBreakLineHeight(): void
         $parentWriter = new RTF();
         $element = new \PhpOffice\PhpWord\Element\Text('New page', null, ['lineHeight' => 1.08, 'pageBreakBefore' => true]);
         $text = new RTF\Element\Text($parentWriter, $element);
-        $expect = "\\pard\\nowidctlpar \\sl259\\slmult1\\page{\\cf0\\f0 New page}\\par\n";
+        $expect = "\\pard\\sl259\\slmult1\\widctlpar\\pagebb {\\cf0\\f0 New page}\\par\n";
         self::assertEquals($expect, $this->removeCr($text));
     }
 
@@ -155,7 +155,7 @@ public function testPageBreakLineHeight2(): void
         $parentWriter = new RTF();
         $element = new \PhpOffice\PhpWord\Element\Text('New page', null, ['lineHeight' => 1.08, 'pageBreakBefore' => true]);
         $text = new RTF\Element\Text($parentWriter, $element);
-        $expect = "\\pard\\nowidctlpar \\ql\\sl259\\slmult1\\page{\\cf0\\f0 New page}\\par\n";
+        $expect = "\\pard\\ql\\sl259\\slmult1\\widctlpar\\pagebb {\\cf0\\f0 New page}\\par\n";
         self::assertEquals($expect, $this->removeCr($text));
     }