Generate Table Cell if Row Doesn't Have Any #2516
Conversation
Fix PHPOffice#2505. Word treats file as corrupt if a table row does not contain a cell (documentation for why this is so is included in the issue). Person reporting the issue suggests that dropping such a row from the output file is preferred. However, I think generating an empty cell instead is closer to the user's expectation. For example, as demonstrated in the unit tests added with this PR, if a table has row 1 and 3 which contain cells, but row 2 does not, the table as written to the file will have 3 rows, with the second containing an empty cell.
|
Hi @oleibman , tested locally and LGTM. Thank you. |
| $cells = $row->getCells(); | ||
| if (count($cells) === 0) { | ||
| // issue 2505 - Word treats doc as corrupt if row without cell | ||
| $this->writeCell($xmlWriter, new CellElement()); | ||
| } else { | ||
| foreach ($cells as $cell) { | ||
| $this->writeCell($xmlWriter, $cell); | ||
| } | ||
| } |
There was a problem hiding this comment.
| $cells = $row->getCells(); | |
| if (count($cells) === 0) { | |
| // issue 2505 - Word treats doc as corrupt if row without cell | |
| $this->writeCell($xmlWriter, new CellElement()); | |
| } else { | |
| foreach ($cells as $cell) { | |
| $this->writeCell($xmlWriter, $cell); | |
| } | |
| } | |
| if (count($row->getCells()) === 0) { | |
| // Add a cell if the row has no cells (avoid corrupt file) | |
| $row->addCell(); | |
| } | |
| foreach ($row->getCells() as $cell) { | |
| $this->writeCell($xmlWriter, $cell); | |
| } |
There was a problem hiding this comment.
I'm not sure about this suggestion. The way I have coded it, there is no change to the user's document object after the write. With your suggestion, there will be a new cell added to the user's document object. This seems unexpected. If the user were to write, then add a cell to the row (perhaps user is preparing multiple documents), it would now be in the row's second cell rather than the first. Given that, do you still think this should be recoded?
There was a problem hiding this comment.
This would mutate the document object when writing out a file. As a user I would expect that the document object is not modified.
|
@Progi1984 Change log updated, all your suggestions except one are incorporated; that one needs further discussion, |
Description
Fix #2505. Word treats file as corrupt if a table row does not contain a cell (documentation for why this is so is included in the issue). Person reporting the issue suggests that dropping such a row from the output file is preferred. However, I think generating an empty cell instead is closer to the user's expectation. For example, as demonstrated in the unit tests added with this PR, if a table has row 1 and 3 which contain cells, but row 2 does not, the table as written to the file will have 3 rows, with the second containing an empty cell.
Checklist:
composer run-script check --timeout=0and no errors were reported