HTML Writer : Fixed rowspan for tables

samples/Sample_09_Tables.php

@@ -56,11 +56,13 @@
 
 /*
  *  3. colspan (gridSpan) and rowspan (vMerge)
- *  ---------------------
- *  |     |   B    |    |
- *  |  A  |--------|  E |
- *  |     | C |  D |    |
- *  ---------------------
+ *  -------------------------
+ *  |  A  |     B     |  C  |
+ *  |-----|-----------|     |
+ *  |        D        |     |
+ *  ------|-----------|     |
+ *  |  E  |  F  |  G  |     |
+ *  -------------------------
  */
 
 $section->addPageBreak();
@@ -74,28 +76,23 @@
 $cellVCentered = ['valign' => 'center'];
 
 $spanTableStyleName = 'Colspan Rowspan';
-$phpWord->addTableStyle($spanTableStyleName, $fancyTableStyle);
+$phpWord->addTableStyle($spanTableStyleName, $styleTable);
 $table = $section->addTable($spanTableStyleName);
 
-$table->addRow();
-
-$cell1 = $table->addCell(2000, $cellRowSpan);
-$textrun1 = $cell1->addTextRun($cellHCentered);
-$textrun1->addText('A');
-$textrun1->addFootnote()->addText('Row span');
-
-$cell2 = $table->addCell(4000, $cellColSpan);
-$textrun2 = $cell2->addTextRun($cellHCentered);
-$textrun2->addText('B');
-$textrun2->addFootnote()->addText('Column span');
+$row1 = $table->addRow();
+$row1->addCell(500)->addText('A');
+$row1->addCell(1000, array('gridSpan' => 2))->addText('B');
+$row1->addCell(500, array('vMerge' => 'restart'))->addText('C');
 
-$table->addCell(2000, $cellRowSpan)->addText('E', null, $cellHCentered);
+$row2 = $table->addRow();
+$row2->addCell(1500, array('gridSpan' => 3))->addText('D');
+$row2->addCell(null, array('vMerge' => 'continue'));
 
-$table->addRow();
-$table->addCell(null, $cellRowContinue);
-$table->addCell(2000, $cellVCentered)->addText('C', null, $cellHCentered);
-$table->addCell(2000, $cellVCentered)->addText('D', null, $cellHCentered);
-$table->addCell(null, $cellRowContinue);
+$row3 = $table->addRow();
+$row3->addCell(500)->addText('E');
+$row3->addCell(500)->addText('F');
+$row3->addCell(500)->addText('G');
+$row3->addCell(null, array('vMerge' => 'continue'));
 
 /*
  *  4. colspan (gridSpan) and rowspan (vMerge)

src/PhpWord/Writer/HTML/Element/Table.php

@@ -65,16 +65,9 @@ public function write()
                     $cellColSpan = $cellStyle->getGridSpan();
                     $cellRowSpan = 1;
                     $cellVMerge = $cellStyle->getVMerge();
-                    // If this is the first cell of the vertical merge, find out how man rows it spans
+                    // If this is the first cell of the vertical merge, find out how many rows it spans
                     if ($cellVMerge === 'restart') {
-                        for ($k = $i + 1; $k < $rowCount; ++$k) {
-                            $kRowCells = $rows[$k]->getCells();
-                            if (isset($kRowCells[$j]) && $kRowCells[$j]->getStyle()->getVMerge() === 'continue') {
-                                ++$cellRowSpan;
-                            } else {
-                                break;
-                            }
-                        }
+                        $cellRowSpan = $this->calculateCellRowSpan($rows, $i, $j);
                     }
                     // Ignore cells that are merged vertically with previous rows
                     if ($cellVMerge !== 'continue') {
@@ -131,4 +124,62 @@ private function getTableStyle($tableStyle = null): string
 
         return ' style="' . $style . '"';
     }
+
+    /**
+     * Calculates cell rowspan.
+     *
+     * @param \PhpOffice\PhpWord\Element\Row[] $rows
+     * @param int $rowIndex
+     * @param int $colIndex
+     *
+     * @return int
+     */
+    private function calculateCellRowSpan(array $rows, int $rowIndex, int $colIndex): int
+    {
+        $currentRow = $rows[$rowIndex];
+        $currentRowCells = $currentRow->getCells();
+        $shiftedColIndex = 0;
+
+        foreach ($currentRowCells as $cell) {
+            if ($cell === $currentRowCells[$colIndex]) {
+                break;
+            }
+
+            $colSpan = 1;
+
+            if ($cell->getStyle()->getGridSpan() !== null) {
+                $colSpan = $cell->getStyle()->getGridSpan();
+            }
+
+            $shiftedColIndex += $colSpan;
+        }
+
+        $rowCount = count($rows);
+        $rowSpan = 1;
+
+        for ($i = $rowIndex + 1; $i < $rowCount; $i++) {
+            $rowCells = $rows[$i]->getCells();
+            $colIndex = 0;
+
+            foreach ($rowCells as $cell) {
+                if ($colIndex === $shiftedColIndex) {
+                    if ($cell->getStyle()->getVMerge() === 'continue') {
+                        $rowSpan++;
+                    }
+
+                    break;
+                }
+
+                $colSpan = 1;
+
+                if ($cell->getStyle()->getGridSpan() !== null) {
+                    $colSpan = $cell->getStyle()->getGridSpan();
+                }
+
+                $colIndex += $colSpan;
+            }
+        }
+
+        return $rowSpan;
+    }
 }

tests/PhpWordTests/Writer/HTML/ElementTest.php

@@ -139,13 +139,41 @@ public function testWriteRowSpan(): void
         self::assertEquals(1, $xpath->query('/html/body/div/table/tr[2]/td')->length);
     }
 
-    private function getAsHTML(PhpWord $phpWord)
+    /**
+     * Tests writing table with rowspan and colspan
+     */
+    public function testWriteRowSpanAndColSpan(): void
     {
-        $htmlWriter = new HTML($phpWord);
-        $dom = new DOMDocument();
-        $dom->loadHTML($htmlWriter->getContent());
+        $phpWord = new PhpWord();
+        $section = $phpWord->addSection();
+        $table = $section->addTable();
 
-        return $dom;
+        $row1 = $table->addRow();
+        $row1->addCell(500)->addText('A');
+        $row1->addCell(1000, array('gridSpan' => 2))->addText('B');
+        $row1->addCell(500, array('vMerge' => 'restart'))->addText('C');
+
+        $row2 = $table->addRow();
+        $row2->addCell(1500, array('gridSpan' => 3))->addText('D');
+        $row2->addCell(null, array('vMerge' => 'continue'));
+
+        $row3 = $table->addRow();
+        $row3->addCell(500)->addText('E');
+        $row3->addCell(500)->addText('F');
+        $row3->addCell(500)->addText('G');
+        $row3->addCell(null, array('vMerge' => 'continue'));
+
+        $dom = $this->getAsHTML($phpWord);
+        $xpath = new \DOMXPath($dom);
+
+        $this->assertEquals(3, $xpath->query('/html/body/table/tr[1]/td')->length);
+        $this->assertEquals('2', $xpath->query('/html/body/table/tr[1]/td[2]')->item(0)->attributes->getNamedItem('colspan')->textContent);
+        $this->assertEquals('3', $xpath->query('/html/body/table/tr[1]/td[3]')->item(0)->attributes->getNamedItem('rowspan')->textContent);
+
+        $this->assertEquals(1, $xpath->query('/html/body/table/tr[2]/td')->length);
+        $this->assertEquals('3', $xpath->query('/html/body/table/tr[2]/td[1]')->item(0)->attributes->getNamedItem('colspan')->textContent);
+
+        $this->assertEquals(3, $xpath->query('/html/body/table/tr[3]/td')->length);
     }
 
     public function testWriteTitleTextRun(): void
@@ -214,4 +242,13 @@ public function testWriteTableLayout(): void
         self::assertEquals('table-layout: fixed;', $xpath->query('/html/body/div/table[1]')->item(0)->attributes->getNamedItem('style')->textContent);
         self::assertEquals('table-layout: auto;', $xpath->query('/html/body/div/table[2]')->item(0)->attributes->getNamedItem('style')->textContent);
     }
+
+    private function getAsHTML(PhpWord $phpWord): DOMDocument
+    {
+        $htmlWriter = new HTML($phpWord);
+        $dom = new DOMDocument();
+        $dom->loadHTML($htmlWriter->getContent());
+
+        return $dom;
+    }
 }