Rename *Number to *Index

src/Spout/Reader/AbstractReader.php

@@ -14,7 +14,7 @@ use Box\Spout\Reader\Exception\EndOfFileReachedException;
  */
 abstract class AbstractReader implements ReaderInterface
 {
-    /** @var int Used to keep track of the row number */
+    /** @var int Used to keep track of the row index */
     protected $currentRowIndex = 0;
 
     /** @var bool Indicates whether the stream is currently open */

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

@@ -91,12 +91,12 @@ class WorksheetHelper
      * default to the data sheet XML file name ("xl/worksheets/sheet2.xml" => "sheet2").
      *
      * @param string $sheetDataXMLFilePath Path of the sheet data XML file as in [Content_Types].xml
-     * @param int $sheetNumberZeroBased Index of the sheet, based on order in [Content_Types].xml (zero-based)
+     * @param int $sheetIndexZeroBased Index of the sheet, based on order in [Content_Types].xml (zero-based)
      * @return \Box\Spout\Reader\Sheet Sheet instance
      */
-    protected function getSheet($sheetDataXMLFilePath, $sheetNumberZeroBased)
+    protected function getSheet($sheetDataXMLFilePath, $sheetIndexZeroBased)
     {
-        $sheetId = $sheetNumberZeroBased + 1;
+        $sheetId = $sheetIndexZeroBased + 1;
         $sheetName = $this->getDefaultSheetName($sheetDataXMLFilePath);
 
         /*
@@ -126,7 +126,7 @@ class WorksheetHelper
             }
         }
 
-        return new Sheet($sheetId, $sheetNumberZeroBased, $sheetName);
+        return new Sheet($sheetId, $sheetIndexZeroBased, $sheetName);
     }
 
     /**
@@ -204,6 +204,6 @@ class WorksheetHelper
      */
     public function hasNextWorksheet($currentWorksheet, $allWorksheets)
     {
-        return ($currentWorksheet === null || ($currentWorksheet->getWorksheetNumber() + 1 < count($allWorksheets)));
+        return ($currentWorksheet === null || ($currentWorksheet->getWorksheetIndex() + 1 < count($allWorksheets)));
     }
 }

src/Spout/Reader/Internal/XLSX/Worksheet.php

@@ -13,21 +13,21 @@ class Worksheet
     /** @var \Box\Spout\Reader\Sheet The "external" sheet */
     protected $externalSheet;
 
-    /** @var int Worksheet number, based on the order of appareance in [Content_Types].xml (zero-based) */
-    protected $worksheetNumber;
+    /** @var int Worksheet index, based on the order of appareance in [Content_Types].xml (zero-based) */
+    protected $worksheetIndex;
 
     /** @var string Path of the XML file containing the worksheet data */
     protected $dataXmlFilePath;
 
     /**\
      * @param \Box\Spout\Reader\Sheet $externalSheet The associated "external" sheet
-     * @param int $worksheetNumber Worksheet number, based on the order of appareance in [Content_Types].xml (zero-based)
+     * @param int $worksheetIndex Worksheet index, based on the order of appareance in [Content_Types].xml (zero-based)
      * @param string $dataXmlFilePath Path of the XML file containing the worksheet data
      */
-    public function __construct($externalSheet, $worksheetNumber, $dataXmlFilePath)
+    public function __construct($externalSheet, $worksheetIndex, $dataXmlFilePath)
     {
         $this->externalSheet = $externalSheet;
-        $this->worksheetNumber = $worksheetNumber;
+        $this->worksheetIndex = $worksheetIndex;
         $this->dataXmlFilePath = $dataXmlFilePath;
     }
 
@@ -50,8 +50,8 @@ class Worksheet
     /**
      * @return int
      */
-    public function getWorksheetNumber()
+    public function getWorksheetIndex()
     {
-        return $this->worksheetNumber;
+        return $this->worksheetIndex;
     }
 }

src/Spout/Reader/Sheet.php

@@ -13,21 +13,21 @@ class Sheet
     /** @var int ID of the sheet */
     protected $id;
 
-    /** @var int Number of the sheet, based on order of creation (zero-based) */
-    protected $number;
+    /** @var int Index of the sheet, based on order of creation (zero-based) */
+    protected $index;
 
     /** @var string Name of the sheet */
     protected $name;
 
     /**
      * @param int $sheetId ID of the sheet
-     * @param int $sheetNumber Number of the sheet, based on order of creation (zero-based)
+     * @param int $sheetIndex Index of the sheet, based on order of creation (zero-based)
      * @param string $sheetName Name of the sheet
      */
-    function __construct($sheetId, $sheetNumber, $sheetName)
+    function __construct($sheetId, $sheetIndex, $sheetName)
     {
         $this->id = $sheetId;
-        $this->number = $sheetNumber;
+        $this->index = $sheetIndex;
         $this->name = $sheetName;
     }
 
@@ -40,11 +40,11 @@ class Sheet
     }
 
     /**
-     * @return int Number of the sheet, based on order of creation (zero-based)
+     * @return int Index of the sheet, based on order of creation (zero-based)
      */
-    public function getNumber()
+    public function getIndex()
     {
-        return $this->number;
+        return $this->index;
     }
 
     /**

src/Spout/Reader/XLSX.php

@@ -132,8 +132,8 @@ class XLSX extends AbstractReader
         if ($this->currentWorksheet === null) {
             $nextWorksheet = $this->worksheets[0];
         } else {
-            $currentWorksheetNumber = $this->currentWorksheet->getWorksheetNumber();
-            $nextWorksheet = $this->worksheets[$currentWorksheetNumber + 1];
+            $currentWorksheetIndex = $this->currentWorksheet->getWorksheetIndex();
+            $nextWorksheet = $this->worksheets[$currentWorksheetIndex + 1];
         }
 
         $this->initXmlReaderForWorksheetData($nextWorksheet);