Cell object formulaAttributes property stores SimpleXMLElement preventing serialization

[tristanleboss]

This is:

- [ ] a bug report
- [X] a feature request
- [X] **not** a usage question (ask them on https://stackoverflow.com/questions/tagged/phpspreadsheet or https://gitter.im/PHPOffice/PhpSpreadsheet)

What is the expected behavior?

For example, if you want to cache a PhpSpreadsheet object using redis or apcu to avoid re-reading an excel file again and again, you need to be able to serialize a PhpSpreadsheet object. Unfortunately, PHP can't serialize a SimpleXMLElement and you will receive an exception Serialization of 'SimpleXMLElement' is not allowed.

The culprit is the formulaAttributes private property of class PhpOffice\PhpSpreadsheet\Cell\Cell.
This property is used by a getter and a setter in this class but doesn't really seems to be used (yet!) anywhere else in the project.

There is just one use of the setter in the Xslx reader and some commented code in the Worksheet class in writeCellFormula method.

What is the current behavior?

I think it would be a good idea to transform this SimpleXMLElement object containing the attributes of the c (cell) XML tag into a real basic PHP array. So, the formulaAttributes property would be a basic array instead of a SimpleXMLElement.

What are the steps to reproduce?

Create an excel file with value 1 in A1 and =A1+1 formula in A2, then extend the formula to 10 rows.
This will create a shared formula. This way some c XML tag will have both t="shared" and s="(int)" attributes.

Then, read the Excel file and try to serialize the resulting PhpOffice\PhpSpreadsheet\Spreadsheet object with:

serialize($spreadsheet)

Which versions of PhpSpreadsheet and PHP are affected?

1.15.0

[tristanleboss]

The code in the load method of class PhpSpreadsheet\Reader\Xlsx.php stores the full XML node and not just the attributes.

                                                    if (isset($c->f['t'])) {
                                                        $att = $c->f;
                                                        $docSheet->getCell($r)->setFormulaAttributes($att);
                                                    }

It seems it's possible to get attributes as a real basic PHP array with:

$att = $c->f['@attributes'];

or by looping:

$att = array();
$attr = $c->f->attributes();

foreach($attr as $key=>$val){
    $att[(string)$key] = (string)$val;
}

[oleibman]

Closing. PR #3199 (November 2022) will throw an exception whenever an attempt is made to serialize the spreadsheet, whether or not formulaAttributes in part of it.