Xls Reader Vertical Break and Writer Page Order (#3306)

Fix #3055. Xls Reader can set vertical break specifying row 0, causing an exception. It is doubtful that Excel needs a row for a vertical break; code is changed to use row 1 if the input file specifies row 0 (or lower). Code in question has not been exercised in unit test suite. Similarly, code to set horizontal break (which probably does not have a bug) is not exercised in test suite. Finally, page order in Writer incorrectly uses value in opposite way that Reader does. A new sample is added to illustrate that these are all handled correctly; it is easier to verify this by visually comparing the source spreadsheet and the copy made from it. A unit test is also added for the same spreadsheet to formally assert that the 3 properties in question are both read and written correctly.

Author: oleibman

samples/Basic/50_xlsverticalbreak.php

@@ -0,0 +1,13 @@
+<?php
+
+require __DIR__ . '/../Header.php';
+
+use PhpOffice\PhpSpreadsheet\Reader\Xls;
+
+$helper->log('Read spreadsheet');
+$reader = new Xls();
+$spreadsheet = $reader->load(__DIR__ . '/../templates/50_xlsverticalbreak.xls');
+
+// Save
+$helper->write($spreadsheet, __FILE__, ['Xls']);
+$spreadsheet->disconnectWorksheets();

samples/templates/50_xlsverticalbreak.xls

@@ -3211,10 +3211,10 @@ private function readVerticalPageBreaks(): void
             for ($i = 0; $i < $nm; ++$i) {
                 $c = self::getUInt2d($recordData, 2 + 6 * $i);
                 $rf = self::getUInt2d($recordData, 2 + 6 * $i + 2);
-                $rl = self::getUInt2d($recordData, 2 + 6 * $i + 4);
+                //$rl = self::getUInt2d($recordData, 2 + 6 * $i + 4);
 
                 // not sure why two row indexes are necessary?
-                $this->phpSheet->setBreak([$c + 1, $rf], Worksheet::BREAK_COLUMN);
+                $this->phpSheet->setBreak([$c + 1, ($rf > 0) ? $rf : 1], Worksheet::BREAK_COLUMN);
             }
         }
     }

src/PhpSpreadsheet/Reader/Xls.php

@@ -1677,7 +1677,7 @@ private function writeSetup(): void
 
         // Order of printing pages
         $fLeftToRight = $this->phpSheet->getPageSetup()->getPageOrder() === PageSetup::PAGEORDER_DOWN_THEN_OVER
-            ? 0x1 : 0x0;
+            ? 0x0 : 0x1;
         // Page orientation
         $fLandscape = ($this->phpSheet->getPageSetup()->getOrientation() == PageSetup::ORIENTATION_LANDSCAPE)
             ? 0x0 : 0x1;

src/PhpSpreadsheet/Writer/Xls/Worksheet.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace PhpOffice\PhpSpreadsheetTests\Reader\Xls;
+
+use PhpOffice\PhpSpreadsheet\Reader\Xls;
+use PhpOffice\PhpSpreadsheet\Worksheet\PageSetup;
+use PhpOffice\PhpSpreadsheet\Worksheet\Worksheet;
+use PhpOffice\PhpSpreadsheetTests\Functional\AbstractFunctional;
+
+class PageBreakTest extends AbstractFunctional
+{
+    public function testPageBreak(): void
+    {
+        $filename = 'samples/templates/50_xlsverticalbreak.xls';
+        $reader = new Xls();
+        $spreadsheet = $reader->load($filename);
+        $sheet = $spreadsheet->getActiveSheet();
+        $pageSetup = $sheet->getPageSetup();
+        self::assertSame(PageSetup::PAGEORDER_DOWN_THEN_OVER, $pageSetup->getPageOrder());
+        $breaks = $sheet->getBreaks();
+        self::assertCount(2, $breaks);
+        self::assertSame(Worksheet::BREAK_ROW, $breaks['A5']);
+        self::assertSame(Worksheet::BREAK_COLUMN, $breaks['H1']);
+        $newSpreadsheet = $this->writeAndReload($spreadsheet, 'Xls');
+        $spreadsheet->disconnectWorksheets();
+
+        $newSheet = $newSpreadsheet->getActiveSheet();
+        $newPageSetup = $newSheet->getPageSetup();
+        self::assertSame(PageSetup::PAGEORDER_DOWN_THEN_OVER, $newPageSetup->getPageOrder());
+        $newBreaks = $newSheet->getBreaks();
+        self::assertCount(2, $newBreaks);
+        self::assertSame(Worksheet::BREAK_ROW, $newBreaks['A5']);
+        self::assertSame(Worksheet::BREAK_COLUMN, $newBreaks['H1']);
+        $newSpreadsheet->disconnectWorksheets();
+    }
+}