Ods Writer Master Page Name

PR PHPOffice#2850 and PR PHPOffice#2851 added support for Worksheet Visibility to ODS. They work well when LibreOffice is used to open the spreadsheet. However, when Excel tries to open it, it reports corruption. Strictly speaking, this is not a PhpSpreadsheet problem, but, if we can fix it, we should.

It took a while to figure out what's bothering Excel. I'm not sure that all of what follows is necessary, but it works. It appears that it wants the content.xml `style:automatic-styles` definition for the `table` (i.e. worksheet) to include a `style:master-page-name` attribute. That attribute requires a corresponding definition in the `office:master-styles` section in styles.xml, and that attribute likewise requires a definition in `office:automatic-styles`.

The new entries in styles.xml can be used to specify things like header and footer. However, the ways that these are specified is distinctly different from what Excel (and therefore PhpSpreadsheet) does. Implementing that will be a good future project. However, for now, they will remain unsupported for Ods.

src/PhpSpreadsheet/Writer/Ods/Cell/Style.php

@@ -289,6 +289,7 @@ public function writeTableStyle(Worksheet $worksheet, int $sheetId): void
             'style:name',
             sprintf('%s%d', self::TABLE_STYLE_PREFIX, $sheetId)
         );
+        $this->writer->writeAttribute('style:master-page-name', 'Default');
 
         $this->writer->startElement('style:table-properties');
 

src/PhpSpreadsheet/Writer/Ods/Styles.php

@@ -56,8 +56,17 @@ public function write(): string
 
         $objWriter->writeElement('office:font-face-decls');
         $objWriter->writeElement('office:styles');
-        $objWriter->writeElement('office:automatic-styles');
-        $objWriter->writeElement('office:master-styles');
+        $objWriter->startElement('office:automatic-styles');
+        $objWriter->startElement('style:page-layout');
+        $objWriter->writeAttribute('style:name', 'Mpm1');
+        $objWriter->endElement(); // style:page-layout
+        $objWriter->endElement(); // office:automatic-styles
+        $objWriter->startElement('office:master-styles');
+        $objWriter->startElement('style:master-page');
+        $objWriter->writeAttribute('style:name', 'Default');
+        $objWriter->writeAttribute('style:page-layout-name', 'Mpm1');
+        $objWriter->endElement(); //style:master-page
+        $objWriter->endElement(); //office:master-styles
         $objWriter->endElement();
 
         return $objWriter->getData();

tests/data/Writer/Ods/content-arrays.xml

@@ -1,2 +1,49 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<office:document-content xmlns:office="urn:oasis:names:tc:opendocument:xmlns:office:1.0" xmlns:style="urn:oasis:names:tc:opendocument:xmlns:style:1.0" xmlns:text="urn:oasis:names:tc:opendocument:xmlns:text:1.0" xmlns:table="urn:oasis:names:tc:opendocument:xmlns:table:1.0" xmlns:draw="urn:oasis:names:tc:opendocument:xmlns:drawing:1.0" xmlns:fo="urn:oasis:names:tc:opendocument:xmlns:xsl-fo-compatible:1.0" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:meta="urn:oasis:names:tc:opendocument:xmlns:meta:1.0" xmlns:number="urn:oasis:names:tc:opendocument:xmlns:datastyle:1.0" xmlns:presentation="urn:oasis:names:tc:opendocument:xmlns:presentation:1.0" xmlns:svg="urn:oasis:names:tc:opendocument:xmlns:svg-compatible:1.0" xmlns:chart="urn:oasis:names:tc:opendocument:xmlns:chart:1.0" xmlns:dr3d="urn:oasis:names:tc:opendocument:xmlns:dr3d:1.0" xmlns:math="http://www.w3.org/1998/Math/MathML" xmlns:form="urn:oasis:names:tc:opendocument:xmlns:form:1.0" xmlns:script="urn:oasis:names:tc:opendocument:xmlns:script:1.0" xmlns:ooo="http://openoffice.org/2004/office" xmlns:ooow="http://openoffice.org/2004/writer" xmlns:oooc="http://openoffice.org/2004/calc" xmlns:dom="http://www.w3.org/2001/xml-events" xmlns:xforms="http://www.w3.org/2002/xforms" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:rpt="http://openoffice.org/2005/report" xmlns:of="urn:oasis:names:tc:opendocument:xmlns:of:1.2" xmlns:xhtml="http://www.w3.org/1999/xhtml" xmlns:grddl="http://www.w3.org/2003/g/data-view#" xmlns:tableooo="http://openoffice.org/2009/table" xmlns:field="urn:openoffice:names:experimental:ooo-ms-interop:xmlns:field:1.0" xmlns:formx="urn:openoffice:names:experimental:ooxml-odf-interop:xmlns:form:1.0" xmlns:css3t="http://www.w3.org/TR/css3-text/" office:version="1.2"><office:scripts/><office:font-face-decls/><office:automatic-styles><style:style style:family="table" style:name="ta1"><style:table-properties table:display="true"/></style:style><style:style style:name="ce0" style:family="table-cell" style:parent-style-name="Default"><style:table-cell-properties style:vertical-align="bottom" style:rotation-align="none"/><style:paragraph-properties fo:text-align="start"/><style:text-properties fo:color="#000000" fo:font-family="Calibri" fo:font-size="11.0pt"/></style:style></office:automatic-styles><office:body><office:spreadsheet><table:calculation-settings/><table:table table:name="Worksheet" table:style-name="ta1"><office:forms/><table:table-row><table:table-cell table:style-name="ce0" office:value-type="float" office:value="1"><text:p>1</text:p></table:table-cell><table:table-cell table:style-name="ce0" table:number-matrix-columns-spanned="1" table:number-matrix-rows-spanned="2" table:formula="of:=UNIQUE([.A1:.A3])" office:value-type="float" office:value="1"><text:p>1</text:p></table:table-cell><table:table-cell table:number-columns-repeated="1022"/></table:table-row><table:table-row><table:table-cell table:style-name="ce0" office:value-type="float" office:value="1"><text:p>1</text:p></table:table-cell><table:table-cell table:style-name="ce0" office:value-type="float" office:value="3"><text:p>3</text:p></table:table-cell><table:table-cell table:number-columns-repeated="1022"/></table:table-row><table:table-row><table:table-cell table:style-name="ce0" office:value-type="float" office:value="3"><text:p>3</text:p></table:table-cell><table:table-cell table:style-name="ce0"/><table:table-cell table:number-columns-repeated="1022"/></table:table-row></table:table><table:named-expressions/></office:spreadsheet></office:body></office:document-content>
+<office:document-content xmlns:office="urn:oasis:names:tc:opendocument:xmlns:office:1.0" xmlns:style="urn:oasis:names:tc:opendocument:xmlns:style:1.0" xmlns:text="urn:oasis:names:tc:opendocument:xmlns:text:1.0" xmlns:table="urn:oasis:names:tc:opendocument:xmlns:table:1.0" xmlns:draw="urn:oasis:names:tc:opendocument:xmlns:drawing:1.0" xmlns:fo="urn:oasis:names:tc:opendocument:xmlns:xsl-fo-compatible:1.0" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:meta="urn:oasis:names:tc:opendocument:xmlns:meta:1.0" xmlns:number="urn:oasis:names:tc:opendocument:xmlns:datastyle:1.0" xmlns:presentation="urn:oasis:names:tc:opendocument:xmlns:presentation:1.0" xmlns:svg="urn:oasis:names:tc:opendocument:xmlns:svg-compatible:1.0" xmlns:chart="urn:oasis:names:tc:opendocument:xmlns:chart:1.0" xmlns:dr3d="urn:oasis:names:tc:opendocument:xmlns:dr3d:1.0" xmlns:math="http://www.w3.org/1998/Math/MathML" xmlns:form="urn:oasis:names:tc:opendocument:xmlns:form:1.0" xmlns:script="urn:oasis:names:tc:opendocument:xmlns:script:1.0" xmlns:ooo="http://openoffice.org/2004/office" xmlns:ooow="http://openoffice.org/2004/writer" xmlns:oooc="http://openoffice.org/2004/calc" xmlns:dom="http://www.w3.org/2001/xml-events" xmlns:xforms="http://www.w3.org/2002/xforms" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:rpt="http://openoffice.org/2005/report" xmlns:of="urn:oasis:names:tc:opendocument:xmlns:of:1.2" xmlns:xhtml="http://www.w3.org/1999/xhtml" xmlns:grddl="http://www.w3.org/2003/g/data-view#" xmlns:tableooo="http://openoffice.org/2009/table" xmlns:field="urn:openoffice:names:experimental:ooo-ms-interop:xmlns:field:1.0" xmlns:formx="urn:openoffice:names:experimental:ooxml-odf-interop:xmlns:form:1.0" xmlns:css3t="http://www.w3.org/TR/css3-text/" office:version="1.2">
+<office:scripts/>
+<office:font-face-decls/>
+<office:automatic-styles>
+<style:style style:master-page-name="Default" style:family="table" style:name="ta1">
+<style:table-properties table:display="true"/>
+</style:style>
+<style:style style:name="ce0" style:family="table-cell" style:parent-style-name="Default">
+<style:table-cell-properties style:vertical-align="bottom" style:rotation-align="none"/>
+<style:paragraph-properties fo:text-align="start"/>
+<style:text-properties fo:color="#000000" fo:font-family="Calibri" fo:font-size="11.0pt"/>
+</style:style>
+</office:automatic-styles>
+<office:body>
+<office:spreadsheet>
+<table:calculation-settings/>
+<table:table table:name="Worksheet" table:style-name="ta1">
+<office:forms/>
+<table:table-row>
+<table:table-cell table:style-name="ce0" office:value-type="float" office:value="1">
+<text:p>1</text:p>
+</table:table-cell>
+<table:table-cell table:style-name="ce0" table:number-matrix-columns-spanned="1" table:number-matrix-rows-spanned="2" table:formula="of:=UNIQUE([.A1:.A3])" office:value-type="float" office:value="1">
+<text:p>1</text:p>
+</table:table-cell>
+<table:table-cell table:number-columns-repeated="1022"/>
+</table:table-row>
+<table:table-row>
+<table:table-cell table:style-name="ce0" office:value-type="float" office:value="1">
+<text:p>1</text:p>
+</table:table-cell>
+<table:table-cell table:style-name="ce0" office:value-type="float" office:value="3">
+<text:p>3</text:p>
+</table:table-cell>
+<table:table-cell table:number-columns-repeated="1022"/>
+</table:table-row>
+<table:table-row>
+<table:table-cell table:style-name="ce0" office:value-type="float" office:value="3">
+<text:p>3</text:p>
+</table:table-cell>
+<table:table-cell table:style-name="ce0"/>
+<table:table-cell table:number-columns-repeated="1022"/>
+</table:table-row>
+</table:table>
+<table:named-expressions/>
+</office:spreadsheet>
+</office:body>
+</office:document-content>

tests/data/Writer/Ods/content-empty.xml

@@ -3,7 +3,7 @@
     <office:scripts />
     <office:font-face-decls />
     <office:automatic-styles>
-        <style:style style:family="table" style:name="ta1">
+        <style:style style:family="table" style:master-page-name="Default" style:name="ta1">
             <style:table-properties table:display="true" />
         </style:style>
         <style:style style:name="ce0" style:family="table-cell" style:parent-style-name="Default">

tests/data/Writer/Ods/content-hidden-worksheet.xml

@@ -3,10 +3,10 @@
     <office:scripts />
     <office:font-face-decls />
     <office:automatic-styles>
-        <style:style style:family="table" style:name="ta1">
+        <style:style style:family="table" style:master-page-name="Default" style:name="ta1">
             <style:table-properties table:display="true" />
         </style:style>
-        <style:style style:family="table" style:name="ta2">
+        <style:style style:family="table" style:master-page-name="Default" style:name="ta2">
             <style:table-properties table:display="false"/>
         </style:style>
         <style:style style:name="ce0" style:family="table-cell" style:parent-style-name="Default">

tests/data/Writer/Ods/content-with-data.xml

@@ -3,10 +3,10 @@
     <office:scripts/>
     <office:font-face-decls/>
     <office:automatic-styles>
-        <style:style style:family="table" style:name="ta1">
+        <style:style style:family="table" style:master-page-name="Default" style:name="ta1">
             <style:table-properties table:display="true" />
         </style:style>
-        <style:style style:family="table" style:name="ta2">
+        <style:style style:family="table" style:master-page-name="Default" style:name="ta2">
             <style:table-properties table:display="true" />
         </style:style>
         <style:style style:family="table-cell" style:name="ce0" style:parent-style-name="Default">