Merge pull request #4404 from oleibman/issue4202

Permit Read to Class Which Extends Spreadsheet

Author: oleibman

CHANGELOG.md

@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org).
 
 - Add ability to add custom functions to Calculation. [PR #4390](https://github.com/PHPOffice/PhpSpreadsheet/pull/4390)
 - Add FormulaRange to IgnoredErrors. [PR #4393](https://github.com/PHPOffice/PhpSpreadsheet/pull/4393)
+- Permit read to class which extends Spreadsheet. [Discussion #4402](https://github.com/PHPOffice/PhpSpreadsheet/discussions/4402) [PR #4404](https://github.com/PHPOffice/PhpSpreadsheet/pull/4404)
 
 ### Removed
 

src/PhpSpreadsheet/Reader/BaseReader.php

@@ -257,4 +257,9 @@ public function setValueBinder(?IValueBinder $valueBinder): self
 
         return $this;
     }
+
+    protected function newSpreadsheet(): Spreadsheet
+    {
+        return new Spreadsheet();
+    }
 }

src/PhpSpreadsheet/Reader/Csv.php

@@ -257,8 +257,7 @@ public function listWorksheetInfo(string $filename): array
      */
     protected function loadSpreadsheetFromFile(string $filename): Spreadsheet
     {
-        // Create new Spreadsheet
-        $spreadsheet = new Spreadsheet();
+        $spreadsheet = $this->newSpreadsheet();
         $spreadsheet->setValueBinder($this->valueBinder);
 
         // Load into this instance
@@ -270,8 +269,7 @@ protected function loadSpreadsheetFromFile(string $filename): Spreadsheet
      */
     public function loadSpreadsheetFromString(string $contents): Spreadsheet
     {
-        // Create new Spreadsheet
-        $spreadsheet = new Spreadsheet();
+        $spreadsheet = $this->newSpreadsheet();
         $spreadsheet->setValueBinder($this->valueBinder);
 
         // Load into this instance

src/PhpSpreadsheet/Reader/Gnumeric.php

@@ -231,8 +231,7 @@ private static function testSimpleXml(mixed $value): SimpleXMLElement
      */
     protected function loadSpreadsheetFromFile(string $filename): Spreadsheet
     {
-        // Create new Spreadsheet
-        $spreadsheet = new Spreadsheet();
+        $spreadsheet = $this->newSpreadsheet();
         $spreadsheet->setValueBinder($this->valueBinder);
         $spreadsheet->removeSheetByIndex(0);
 

src/PhpSpreadsheet/Reader/Html.php

@@ -210,8 +210,7 @@ private static function containsTags(string $data): bool
      */
     public function loadSpreadsheetFromFile(string $filename): Spreadsheet
     {
-        // Create new Spreadsheet
-        $spreadsheet = new Spreadsheet();
+        $spreadsheet = $this->newSpreadsheet();
         $spreadsheet->setValueBinder($this->valueBinder);
 
         // Load into this instance
@@ -826,7 +825,7 @@ public function loadFromString(string $content, ?Spreadsheet $spreadsheet = null
         if ($loaded === false) {
             throw new Exception('Failed to load content as a DOM Document', 0, $e ?? null);
         }
-        $spreadsheet = $spreadsheet ?? new Spreadsheet();
+        $spreadsheet = $spreadsheet ?? $this->newSpreadsheet();
         $spreadsheet->setValueBinder($this->valueBinder);
         self::loadProperties($dom, $spreadsheet);
 
@@ -1225,7 +1224,7 @@ private function setBorderStyle(Style $cellStyle, string $styleValue, string $ty
     public function listWorksheetInfo(string $filename): array
     {
         $info = [];
-        $spreadsheet = new Spreadsheet();
+        $spreadsheet = $this->newSpreadsheet();
         $this->loadIntoExisting($filename, $spreadsheet);
         foreach ($spreadsheet->getAllSheets() as $sheet) {
             $newEntry = ['worksheetName' => $sheet->getTitle()];

src/PhpSpreadsheet/Reader/Ods.php

@@ -229,8 +229,7 @@ public function listWorksheetInfo(string $filename): array
      */
     protected function loadSpreadsheetFromFile(string $filename): Spreadsheet
     {
-        // Create new Spreadsheet
-        $spreadsheet = new Spreadsheet();
+        $spreadsheet = $this->newSpreadsheet();
         $spreadsheet->setValueBinder($this->valueBinder);
         $spreadsheet->removeSheetByIndex(0);
 

src/PhpSpreadsheet/Reader/Slk.php

@@ -144,8 +144,7 @@ public function listWorksheetInfo(string $filename): array
      */
     protected function loadSpreadsheetFromFile(string $filename): Spreadsheet
     {
-        // Create new Spreadsheet
-        $spreadsheet = new Spreadsheet();
+        $spreadsheet = $this->newSpreadsheet();
         $spreadsheet->setValueBinder($this->valueBinder);
 
         // Load into this instance

src/PhpSpreadsheet/Reader/Xls/LoadSpreadsheet.php

@@ -26,7 +26,7 @@ protected function loadSpreadsheetFromFile2(string $filename, Xls $xls): Spreads
         $xls->loadOLE($filename);
 
         // Initialisations
-        $xls->spreadsheet = new Spreadsheet();
+        $xls->spreadsheet = $this->newSpreadsheet();
         $xls->spreadsheet->setValueBinder($this->valueBinder);
         $xls->spreadsheet->removeSheetByIndex(0); // remove 1st sheet
         if (!$xls->readDataOnly) {

src/PhpSpreadsheet/Reader/Xlsx.php

@@ -400,7 +400,7 @@ protected function loadSpreadsheetFromFile(string $filename): Spreadsheet
         File::assertFile($filename, self::INITIAL_FILE);
 
         // Initialisations
-        $excel = new Spreadsheet();
+        $excel = $this->newSpreadsheet();
         $excel->setValueBinder($this->valueBinder);
         $excel->removeSheetByIndex(0);
         $addingFirstCellStyleXf = true;

src/PhpSpreadsheet/Reader/Xml.php

@@ -243,8 +243,7 @@ public function listWorksheetInfo(string $filename): array
      */
     public function loadSpreadsheetFromString(string $contents): Spreadsheet
     {
-        // Create new Spreadsheet
-        $spreadsheet = new Spreadsheet();
+        $spreadsheet = $this->newSpreadsheet();
         $spreadsheet->setValueBinder($this->valueBinder);
         $spreadsheet->removeSheetByIndex(0);
 
@@ -257,8 +256,7 @@ public function loadSpreadsheetFromString(string $contents): Spreadsheet
      */
     protected function loadSpreadsheetFromFile(string $filename): Spreadsheet
     {
-        // Create new Spreadsheet
-        $spreadsheet = new Spreadsheet();
+        $spreadsheet = $this->newSpreadsheet();
         $spreadsheet->setValueBinder($this->valueBinder);
         $spreadsheet->removeSheetByIndex(0);