Merge pull request #1550 from troosan/add_support_for_table_rtl

Add RightToLeft table presentation

CHANGELOG.md

@@ -6,6 +6,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 v0.17.0 (?? ??? 2019)
 ----------------------
 ### Added
+- Add RightToLeft table presentation. @troosan #1550
 
 ### Fixed
 

docs/styles.rst

@@ -108,11 +108,12 @@ Available Table style options:
 - ``border(Top|Right|Bottom|Left)Size``. Border size in *twip*.
 - ``cellMargin(Top|Right|Bottom|Left)``. Cell margin in *twip*.
 - ``indent``. Table indent from leading margin. Must be an instance of ``\PhpOffice\PhpWord\ComplexType\TblWidth``.
-- ``width``. Table width in percent.
+- ``width``. Table width in Fiftieths of a Percent or Twentieths of a Point.
 - ``unit``. The unit to use for the width. One of ``\PhpOffice\PhpWord\SimpleType\TblWidth``. Defaults to *auto*.
 - ``layout``. Table layout, either *fixed* or *autofit*  See ``\PhpOffice\PhpWord\Style\Table`` for constants.
 - ``cellSpacing`` Cell spacing in *twip*
 - ``position`` Floating Table Positioning, see below for options
+- ``bidiVisual`` Present table as Right-To-Left
 
 Floating Table Positioning options:
 

samples/Sample_36_RTL.php

@@ -14,6 +14,29 @@ $textrun->addText('This is a Left to Right paragraph.');
 $textrun = $section->addTextRun(array('alignment' => \PhpOffice\PhpWord\SimpleType\Jc::END));
 $textrun->addText('سلام این یک پاراگراف راست به چپ است', array('rtl' => true));
 
+$section->addText('Table visually presented as RTL');
+$style = array('rtl' => true, 'size' => 12);
+$tableStyle = array('borderSize' => 6, 'borderColor' => '000000', 'width' => 5000, 'unit' => \PhpOffice\PhpWord\SimpleType\TblWidth::PERCENT, 'bidiVisual' => true);
+
+$table = $section->addTable($tableStyle);
+$cellHCentered = array('alignment' => \PhpOffice\PhpWord\SimpleType\Jc::CENTER);
+$cellHEnd = array('alignment' => \PhpOffice\PhpWord\SimpleType\Jc::END);
+$cellVCentered = array('valign' => \PhpOffice\PhpWord\Style\Cell::VALIGN_CENTER);
+
+//Vidually bidirectinal table
+$table->addRow();
+$cell = $table->addCell(500, $cellVCentered);
+$textrun = $cell->addTextRun($cellHCentered);
+$textrun->addText('ردیف', $style);
+
+$cell = $table->addCell(11000);
+$textrun = $cell->addTextRun($cellHEnd);
+$textrun->addText('سوالات', $style);
+
+$cell = $table->addCell(500, $cellVCentered);
+$textrun = $cell->addTextRun($cellHCentered);
+$textrun->addText('بارم', $style);
+
 // Save file
 echo write($phpWord, basename(__FILE__, '.php'), $writers);
 if (!CLI) {

samples/index.php

@@ -22,7 +22,7 @@ if (!CLI) {
     <a class="btn btn-lg btn-primary" href="http://phpword.readthedocs.org/" role="button"><i class="fa fa-book fa-lg" title="Docs"></i>  Read the Docs</a>
 </p>
 </div>
-<?php
+    <?php
 }
 if (!CLI) {
     echo '<h3>Requirement check:</h3>';

src/PhpWord/Reader/Word2007/AbstractPart.php

@@ -483,6 +483,7 @@ abstract class AbstractPart
                     $styleDefs["border{$ucfSide}Style"] = array(self::READ_VALUE, "w:tblBorders/w:$side", 'w:val');
                 }
                 $styleDefs['layout'] = array(self::READ_VALUE, 'w:tblLayout', 'w:type');
+                $styleDefs['bidiVisual'] = array(self::READ_TRUE, 'w:bidiVisual');
                 $styleDefs['cellSpacing'] = array(self::READ_VALUE, 'w:tblCellSpacing', 'w:w');
                 $style = $this->readStyleDefs($xmlReader, $styleNode, $styleDefs);
 

src/PhpWord/Style/Table.php

@@ -170,6 +170,14 @@ class Table extends Border
      */
     private $columnWidths;
 
+    /**
+     * Visually Right to Left Table
+     *
+     * @see  http://www.datypic.com/sc/ooxml/e-w_bidiVisual-1.html
+     * @var bool
+     */
+    private $bidiVisual = false;
+
     /**
      * Create new table style
      *
@@ -775,4 +783,28 @@ class Table extends Border
     {
         $this->columnWidths = $value;
     }
+
+    /**
+     * Get bidiVisual
+     *
+     * @return bool
+     */
+    public function isBidiVisual()
+    {
+        return $this->bidiVisual;
+    }
+
+    /**
+     * Set bidiVisual
+     *
+     * @param bool $bidi
+     *            Set to true to visually present table as Right to Left
+     * @return self
+     */
+    public function setBidiVisual($bidi)
+    {
+        $this->bidiVisual = $bidi;
+
+        return $this;
+    }
 }

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

@@ -54,6 +54,10 @@ class Paragraph extends AbstractStyle
             $xmlWriter->writeAttribute('fo:margin-bottom', $marginBottom . 'cm');
             $xmlWriter->writeAttribute('fo:text-align', $style->getAlignment());
         }
+
+        //Right to left
+        $xmlWriter->writeAttributeIf($style->isBidi(), 'style:writing-mode', 'rl-tb');
+
         $xmlWriter->endElement(); //style:paragraph-properties
 
         $xmlWriter->endElement(); //style:style

src/PhpWord/Writer/ODText/Style/Table.php

@@ -43,6 +43,7 @@ class Table extends AbstractStyle
         //$xmlWriter->writeAttribute('style:width', 'table');
         $xmlWriter->writeAttribute('style:rel-width', 100);
         $xmlWriter->writeAttribute('table:align', 'center');
+        $xmlWriter->writeAttributeIf($style->isBidiVisual(), 'style:writing-mode', 'rl-tb');
         $xmlWriter->endElement(); // style:table-properties
         $xmlWriter->endElement(); // style:style
 

src/PhpWord/Writer/Word2007/Style/Table.php

@@ -86,6 +86,9 @@ class Table extends AbstractStyle
         $styleWriter = new TablePosition($xmlWriter, $style->getPosition());
         $styleWriter->write();
 
+        //Right to left
+        $xmlWriter->writeElementIf($style->isBidiVisual() !== null, 'w:bidiVisual', 'w:val', $this->writeOnOf($style->isBidiVisual()));
+
         $this->writeMargin($xmlWriter, $style);
         $this->writeBorder($xmlWriter, $style);
 

tests/PhpWord/Reader/Word2007/StyleTest.php

@@ -147,6 +147,24 @@ class StyleTest extends AbstractTestReader
         $this->assertSame(2160, $tableStyle->getIndent()->getValue());
     }
 
+    public function testReadTableRTL()
+    {
+        $documentXml = '<w:tbl>
+            <w:tblPr>
+                <w:bidiVisual w:val="1"/>
+            </w:tblPr>
+        </w:tbl>';
+
+        $phpWord = $this->getDocumentFromString(array('document' => $documentXml));
+
+        $elements = $phpWord->getSection(0)->getElements();
+        $this->assertInstanceOf('PhpOffice\PhpWord\Element\Table', $elements[0]);
+        $this->assertInstanceOf('PhpOffice\PhpWord\Style\Table', $elements[0]->getStyle());
+        /** @var \PhpOffice\PhpWord\Style\Table $tableStyle */
+        $tableStyle = $elements[0]->getStyle();
+        $this->assertTrue($tableStyle->isBidiVisual());
+    }
+
     public function testReadHidden()
     {
         $documentXml = '<w:p>

tests/PhpWord/Writer/Word2007/Style/TableTest.php

@@ -141,4 +141,21 @@ class TableTest extends \PHPUnit\Framework\TestCase
         $this->assertSame($value, (int) $doc->getElementAttribute($path, 'w:w'));
         $this->assertSame($type, $doc->getElementAttribute($path, 'w:type'));
     }
+
+    public function testRigthToLeft()
+    {
+        $tableStyle = new Table();
+        $tableStyle->setBidiVisual(true);
+
+        $phpWord = new \PhpOffice\PhpWord\PhpWord();
+        $section = $phpWord->addSection();
+        $table = $section->addTable($tableStyle);
+        $table->addRow();
+
+        $doc = TestHelperDOCX::getDocument($phpWord, 'Word2007');
+
+        $path = '/w:document/w:body/w:tbl/w:tblPr/w:bidiVisual';
+        $this->assertTrue($doc->elementExists($path));
+        $this->assertEquals('1', $doc->getElementAttribute($path, 'w:val'));
+    }
 }