Expose Sheet::isActive() to provide info about the last active sheet (#405)

src/Spout/Reader/XLSX/Helper/SheetHelper.php

@@ -53,12 +53,18 @@ class SheetHelper
     {
         $sheets = [];
         $sheetIndex = 0;
+        $activeSheetIndex = 0; // By default, the first sheet is active
 
         $xmlReader = new XMLReader();
         if ($xmlReader->openFileInZip($this->filePath, self::WORKBOOK_XML_FILE_PATH)) {
             while ($xmlReader->read()) {
-                if ($xmlReader->isPositionedOnStartingNode('sheet')) {
-                    $sheets[] = $this->getSheetFromSheetXMLNode($xmlReader, $sheetIndex);
+                if ($xmlReader->isPositionedOnStartingNode('workbookView')) {
+                    // The "workbookView" node is located before "sheet" nodes, ensuring that
+                    // the active sheet is known before parsing sheets data.
+                    $activeSheetIndex = (int) $xmlReader->getAttribute('activeTab');
+                } else if ($xmlReader->isPositionedOnStartingNode('sheet')) {
+                    $isSheetActive = ($sheetIndex === $activeSheetIndex);
+                    $sheets[] = $this->getSheetFromSheetXMLNode($xmlReader, $sheetIndex, $isSheetActive);
                     $sheetIndex++;
                 } else if ($xmlReader->isPositionedOnEndingNode('sheets')) {
                     // stop reading once all sheets have been read
@@ -79,9 +85,10 @@ class SheetHelper
      *
      * @param \Box\Spout\Reader\Wrapper\XMLReader $xmlReaderOnSheetNode XML Reader instance, pointing on the node describing the sheet, as defined in "workbook.xml"
      * @param int $sheetIndexZeroBased Index of the sheet, based on order of appearance in the workbook (zero-based)
+     * @param bool $isSheetActive Whether this sheet was defined as active
      * @return \Box\Spout\Reader\XLSX\Sheet Sheet instance
      */
-    protected function getSheetFromSheetXMLNode($xmlReaderOnSheetNode, $sheetIndexZeroBased)
+    protected function getSheetFromSheetXMLNode($xmlReaderOnSheetNode, $sheetIndexZeroBased, $isSheetActive)
     {
         $sheetId = $xmlReaderOnSheetNode->getAttribute('r:id');
         $escapedSheetName = $xmlReaderOnSheetNode->getAttribute('name');
@@ -92,7 +99,11 @@ class SheetHelper
 
         $sheetDataXMLFilePath = $this->getSheetDataXMLFilePathForSheetId($sheetId);
 
-        return new Sheet($this->filePath, $sheetDataXMLFilePath, $sheetIndexZeroBased, $sheetName, $this->options, $this->sharedStringsHelper);
+        return new Sheet(
+            $this->filePath, $sheetDataXMLFilePath,
+            $sheetIndexZeroBased, $sheetName, $isSheetActive,
+            $this->options, $this->sharedStringsHelper
+        );
     }
 
     /**

src/Spout/Reader/XLSX/Sheet.php

@@ -21,19 +21,24 @@ class Sheet implements SheetInterface
     /** @var string Name of the sheet */
     protected $name;
 
+    /** @var bool Whether the sheet was the active one */
+    protected $isActive;
+
     /**
      * @param string $filePath Path of the XLSX file being read
      * @param string $sheetDataXMLFilePath Path of the sheet data XML file as in [Content_Types].xml
      * @param int $sheetIndex Index of the sheet, based on order in the workbook (zero-based)
      * @param string $sheetName Name of the sheet
+     * @param bool $isSheetActive Whether the sheet was defined as active
      * @param \Box\Spout\Reader\XLSX\ReaderOptions $options Reader's current options
      * @param Helper\SharedStringsHelper Helper to work with shared strings
      */
-    public function __construct($filePath, $sheetDataXMLFilePath, $sheetIndex, $sheetName, $options, $sharedStringsHelper)
+    public function __construct($filePath, $sheetDataXMLFilePath, $sheetIndex, $sheetName, $isSheetActive, $options, $sharedStringsHelper)
     {
         $this->rowIterator = new RowIterator($filePath, $sheetDataXMLFilePath, $options, $sharedStringsHelper);
         $this->index = $sheetIndex;
         $this->name = $sheetName;
+        $this->isActive = $isSheetActive;
     }
 
     /**
@@ -62,4 +67,13 @@ class Sheet implements SheetInterface
     {
         return $this->name;
     }
+
+    /**
+     * @api
+     * @return bool Whether the sheet was defined as active
+     */
+    public function isActive()
+    {
+        return $this->isActive;
+    }
 }