replace excel with spreadsheet as the underlying lib supports different spreadsheet formats

Author: lsmith77

src/SpreadsheetReader.php

@@ -34,8 +34,7 @@
  *
  * @author David de Boer <[email protected]>
  *
- * @see http://phpexcel.codeplex.com/
- * @see https://github.com/logiQ/PHPSpreadsheet
+ * @see https://github.com/PHPOffice/PhpSpreadsheet
  */
 class SpreadsheetReader implements CountableReader, \SeekableIterator
 {
@@ -71,29 +70,29 @@ class SpreadsheetReader implements CountableReader, \SeekableIterator
      * @param \SplFileObject $file            Spreadsheet file
      * @param int            $headerRowNumber Optional number of header row
      * @param int            $activeSheet     Index of active sheet to read from
-     * @param bool           $readOnly        If set to false, the reader take care of the excel formatting (slow)
+     * @param bool           $readOnly        If set to false, the reader take care of the spreadsheet formatting (slow)
      * @param int            $maxRows         Maximum number of rows to read
      */
     public function __construct(\SplFileObject $file, $headerRowNumber = null, $activeSheet = null, $readOnly = true, $maxRows = null)
     {
         // phpcs:enable Generic.Files.LineLength.MaxExceeded
         $reader = IOFactory::createReaderForFile($file->getPathName());
         $reader->setReadDataOnly($readOnly);
-        /** @var Spreadsheet $excel */
-        $excel = $reader->load($file->getPathname());
+        /** @var Spreadsheet $spreadsheet */
+        $spreadsheet = $reader->load($file->getPathname());
 
         if (null !== $activeSheet) {
-            $excel->setActiveSheetIndex($activeSheet);
+            $spreadsheet->setActiveSheetIndex($activeSheet);
         }
 
         /** @var Worksheet $sheet */
-        $sheet = $excel->getActiveSheet();
+        $sheet = $spreadsheet->getActiveSheet();
 
         if ($maxRows && $maxRows < $sheet->getHighestDataRow()) {
             $maxColumn       = $sheet->getHighestDataColumn();
             $this->worksheet = $sheet->rangeToArray('A1:'.$maxColumn.$maxRows);
         } else {
-            $this->worksheet = $excel->getActiveSheet()->toArray();
+            $this->worksheet = $spreadsheet->getActiveSheet()->toArray();
         }
 
         if (null !== $headerRowNumber) {
@@ -127,7 +126,7 @@ public function current()
     {
         $row = $this->worksheet[$this->pointer];
 
-        // If the excel file has column headers, use them to construct an associative
+        // If the spreadsheet file has column headers, use them to construct an associative
         // array for the columns in this line
         if (count($this->columnHeaders) === count($row)) {
             return array_combine(array_values($this->columnHeaders), $row);

src/SpreadsheetWriter.php

@@ -38,7 +38,7 @@ class SpreadsheetWriter implements Writer
     /**
      * @var Spreadsheet
      */
-    protected $excel;
+    protected $spreadsheet;
 
     /**
      * @var string
@@ -86,7 +86,7 @@ public function __construct(\SplFileObject $file, $sheet = null, $type = 'Xlsx',
      */
     public function finish()
     {
-        $writer = IOFactory::createWriter($this->excel, $this->type);
+        $writer = IOFactory::createWriter($this->spreadsheet, $this->type);
         $writer->save($this->filename);
     }
 
@@ -99,16 +99,16 @@ public function prepare()
     {
         $reader = IOFactory::createReader($this->type);
         if ($reader->canRead($this->filename)) {
-            $this->excel = $reader->load($this->filename);
+            $this->spreadsheet = $reader->load($this->filename);
         } else {
-            $this->excel = new Spreadsheet();
+            $this->spreadsheet = new Spreadsheet();
         }
 
         if (null !== $this->sheet) {
-            if (!$this->excel->sheetNameExists($this->sheet)) {
-                $this->excel->createSheet()->setTitle($this->sheet);
+            if (!$this->spreadsheet->sheetNameExists($this->sheet)) {
+                $this->spreadsheet->createSheet()->setTitle($this->sheet);
             }
-            $this->excel->setActiveSheetIndexByName($this->sheet);
+            $this->spreadsheet->setActiveSheetIndexByName($this->sheet);
         }
     }
 
@@ -127,15 +127,15 @@ public function writeItem(array $item)
             $headers = array_keys($item);
 
             for ($i = 0; $i < $count; $i++) {
-                $this->excel->getActiveSheet()->setCellValueByColumnAndRow($i + 1, $this->row, $headers[$i]);
+                $this->spreadsheet->getActiveSheet()->setCellValueByColumnAndRow($i + 1, $this->row, $headers[$i]);
             }
             $this->row++;
         }
 
         $values = array_values($item);
 
         for ($i = 0; $i < $count; $i++) {
-            $this->excel->getActiveSheet()->setCellValueByColumnAndRow($i + 1, $this->row, $values[$i]);
+            $this->spreadsheet->getActiveSheet()->setCellValueByColumnAndRow($i + 1, $this->row, $values[$i]);
         }
 
         $this->row++;