Skip to content

Fix rowspans for tables in HTML Writer #2163

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Fix rowspans for tables in HTML Writer #2163

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 21 additions & 29 deletions samples/Sample_09_Tables.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,46 +55,38 @@

/*
* 3. colspan (gridSpan) and rowspan (vMerge)
* ---------------------
* | | B | |
* | A |--------| E |
* | | C | D | |
* ---------------------
* -------------------------
* | A | B | C |
* |-----|-----------| |
* | D | |
* ------|-----------| |
* | E | F | G | |
* -------------------------
*/

$section->addPageBreak();
$section->addText('Table with colspan and rowspan', $header);

$fancyTableStyle = array('borderSize' => 6, 'borderColor' => '999999');
$cellRowSpan = array('vMerge' => 'restart', 'valign' => 'center', 'bgColor' => 'FFFF00');
$cellRowContinue = array('vMerge' => 'continue');
$cellColSpan = array('gridSpan' => 2, 'valign' => 'center');
$cellHCentered = array('alignment' => \PhpOffice\PhpWord\SimpleType\Jc::CENTER);
$cellVCentered = array('valign' => 'center');
$styleTable = array('borderSize' => 6, 'borderColor' => '999999');

$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)
Expand Down
73 changes: 60 additions & 13 deletions src/PhpWord/Writer/HTML/Element/Table.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,20 +63,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])) {
if ($kRowCells[$j]->getStyle()->getVMerge() === 'continue') {
$cellRowSpan++;
} else {
break;
}
} else {
break;
}
}
$cellRowSpan = $this->calculateCellRowSpan($rows, $i, $j);
}
// Ignore cells that are merged vertically with previous rows
if ($cellVMerge !== 'continue') {
Expand Down Expand Up @@ -139,4 +128,62 @@ private function getTableStyle($tableStyle = null)

return $style . '"';
}

/**
* Calculates cell rowspan.
*
* @param \PhpOffice\PhpWord\Element\Row[] $rows
* @param int $rowIndex
* @param int $colIndex
*
* @return int
*/
private function calculateCellRowSpan($rows, $rowIndex, $colIndex)
{
$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;
}
}
37 changes: 37 additions & 0 deletions tests/PhpWord/Writer/HTML/ElementTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,43 @@ public function testWriteRowSpan()
$this->assertEquals(1, $xpath->query('/html/body/table/tr[2]/td')->length);
}

/**
* Tests writing table with rowspan and colspan
*/
public function testWriteRowSpanAndColSpan()
{
$phpWord = new PhpWord();
$section = $phpWord->addSection();
$table = $section->addTable();

$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);
}

private function getAsHTML(PhpWord $phpWord)
{
$htmlWriter = new HTML($phpWord);
Expand Down