Skip to content
This repository has been archived by the owner on May 26, 2022. It is now read-only.

Commit

Permalink
Add support for cells in error when writing XLSX and ODS
Browse files Browse the repository at this point in the history
When appending data to an existing sheet, it was possible to get cells in error when reading (DIV/0 for instance). When trying to write them back, `addRow` would throw because `Cell`s in error were not supported by the writers.
  • Loading branch information
adrilo committed Dec 2, 2019
1 parent eb88bb4 commit 7964dad
Show file tree
Hide file tree
Showing 5 changed files with 53 additions and 0 deletions.
8 changes: 8 additions & 0 deletions src/Spout/Common/Entity/Cell.php
Expand Up @@ -91,6 +91,14 @@ public function getValue()
return !$this->isError() ? $this->value : null;
}

/**
* @return mixed
*/
public function getValueEvenIfError()
{
return $this->value;
}

/**
* @param Style|null $style
*/
Expand Down
5 changes: 5 additions & 0 deletions src/Spout/Writer/ODS/Manager/WorksheetManager.php
Expand Up @@ -204,6 +204,11 @@ private function getCellXML(Cell $cell, $styleIndex, $numTimesValueRepeated)
$data .= ' office:value-type="float" calcext:value-type="float" office:value="' . $cell->getValue() . '">';
$data .= '<text:p>' . $cell->getValue() . '</text:p>';
$data .= '</table:table-cell>';
} elseif ($cell->isError() && is_string($cell->getValueEvenIfError())) {
// only writes the error value if it's a string
$data .= ' office:value-type="string" calcext:value-type="error" office:value="">';
$data .= '<text:p>' . $cell->getValueEvenIfError() . '</text:p>';
$data .= '</table:table-cell>';
} elseif ($cell->isEmpty()) {
$data .= '/>';
} else {
Expand Down
3 changes: 3 additions & 0 deletions src/Spout/Writer/XLSX/Manager/WorksheetManager.php
Expand Up @@ -218,6 +218,9 @@ private function getCellXML($rowIndexOneBased, $columnIndexZeroBased, Cell $cell
$cellXML .= ' t="b"><v>' . (int) ($cell->getValue()) . '</v></c>';
} elseif ($cell->isNumeric()) {
$cellXML .= '><v>' . $cell->getValue() . '</v></c>';
} elseif ($cell->isError() && is_string($cell->getValueEvenIfError())) {
// only writes the error value if it's a string
$cellXML .= ' t="e"><v>' . $cell->getValueEvenIfError() . '</v></c>';
} elseif ($cell->isEmpty()) {
if ($this->styleManager->shouldApplyStyleOnEmptyCell($styleId)) {
$cellXML .= '/>';
Expand Down
19 changes: 19 additions & 0 deletions tests/Spout/Writer/ODS/WriterTest.php
Expand Up @@ -2,6 +2,7 @@

namespace Box\Spout\Writer\ODS;

use Box\Spout\Common\Entity\Cell;
use Box\Spout\Common\Entity\Row;
use Box\Spout\Common\Exception\InvalidArgumentException;
use Box\Spout\Common\Exception\IOException;
Expand Down Expand Up @@ -321,6 +322,24 @@ public function testAddRowShouldUseNumberColumnsRepeatedForRepeatedValues($dataR
}
}

/**
* @return void
*/
public function testAddRowShouldSupportCellInError()
{
$fileName = 'test_add_row_should_support_cell_in_error.ods';

$cell = WriterEntityFactory::createCell('#DIV/0');
$cell->setType(Cell::TYPE_ERROR);

$row = WriterEntityFactory::createRow([$cell]);

$this->writeToODSFile([$row], $fileName);

$this->assertValueWasWritten($fileName, 'calcext:value-type="error"');
$this->assertValueWasWritten($fileName, '<text:p>#DIV/0</text:p>');
}

/**
* @return void
*/
Expand Down
18 changes: 18 additions & 0 deletions tests/Spout/Writer/XLSX/WriterTest.php
Expand Up @@ -2,6 +2,7 @@

namespace Box\Spout\Writer\XLSX;

use Box\Spout\Common\Entity\Cell;
use Box\Spout\Common\Entity\Row;
use Box\Spout\Common\Exception\InvalidArgumentException;
use Box\Spout\Common\Exception\IOException;
Expand Down Expand Up @@ -375,6 +376,23 @@ public function testAddRowShouldSupportMultipleTypesOfData()
$this->assertInlineDataWasWrittenToSheet($fileName, 1, 10.2);
}

/**
* @return void
*/
public function testAddRowShouldSupportCellInError()
{
$fileName = 'test_add_row_should_support_cell_in_error.xlsx';

$cell = WriterEntityFactory::createCell('#DIV/0');
$cell->setType(Cell::TYPE_ERROR);

$row = WriterEntityFactory::createRow([$cell]);

$this->writeToXLSXFile([$row], $fileName);

$this->assertInlineDataWasWrittenToSheet($fileName, 1, 't="e"><v>#DIV/0</v>');
}

/**
* @return void
*/
Expand Down

0 comments on commit 7964dad

Please sign in to comment.