Merge pull request #4404 from oleibman/issue4202

oleibman · web-flow · commit bb3d5fa51001 · 2025-03-16T04:52:04.000Z
Permit Read to Class Which Extends Spreadsheet
diff --git a/CHANGELOG.md b/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
 
diff --git a/src/PhpSpreadsheet/Reader/BaseReader.php b/src/PhpSpreadsheet/Reader/BaseReader.php
@@ -257,4 +257,9 @@ public function setValueBinder(?IValueBinder $valueBinder): self
 
         return $this;
     }
+
+    protected function newSpreadsheet(): Spreadsheet
+    {
+        return new Spreadsheet();
+    }
 }
diff --git a/src/PhpSpreadsheet/Reader/Csv.php b/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
diff --git a/src/PhpSpreadsheet/Reader/Gnumeric.php b/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);
 
diff --git a/src/PhpSpreadsheet/Reader/Html.php b/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()];
diff --git a/src/PhpSpreadsheet/Reader/Ods.php b/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);
 
diff --git a/src/PhpSpreadsheet/Reader/Slk.php b/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
diff --git a/src/PhpSpreadsheet/Reader/Xls/LoadSpreadsheet.php b/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) {
diff --git a/src/PhpSpreadsheet/Reader/Xlsx.php b/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;
diff --git a/src/PhpSpreadsheet/Reader/Xml.php b/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);
 
diff --git a/tests/PhpSpreadsheetTests/Reader/Xlsx/MySpreadsheet.php b/tests/PhpSpreadsheetTests/Reader/Xlsx/MySpreadsheet.php
@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpOffice\PhpSpreadsheetTests\Reader\Xlsx;
+
+use PhpOffice\PhpSpreadsheet\Spreadsheet;
+
+class MySpreadsheet extends Spreadsheet
+{
+    public function calcSquare(string $cellAddress): float|int|string
+    {
+        $value = $this->getActiveSheet()
+            ->getCell($cellAddress)
+            ->getValue();
+        if (is_numeric($value)) {
+            return $value * $value;
+        }
+
+        return '#VALUE!';
+    }
+}
diff --git a/tests/PhpSpreadsheetTests/Reader/Xlsx/MyXlsxReader.php b/tests/PhpSpreadsheetTests/Reader/Xlsx/MyXlsxReader.php
@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpOffice\PhpSpreadsheetTests\Reader\Xlsx;
+
+use PhpOffice\PhpSpreadsheet\Reader\Xlsx as XlsxReader;
+use PhpOffice\PhpSpreadsheet\Spreadsheet;
+
+class MyXlsxReader extends XlsxReader
+{
+    protected function newSpreadsheet(): Spreadsheet
+    {
+        return new MySpreadsheet();
+    }
+}
diff --git a/tests/PhpSpreadsheetTests/Reader/Xlsx/MyXlsxTest.php b/tests/PhpSpreadsheetTests/Reader/Xlsx/MyXlsxTest.php
@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpOffice\PhpSpreadsheetTests\Reader\Xlsx;
+
+use PHPUnit\Framework\TestCase;
+
+class MyXlsxTest extends TestCase
+{
+    public function testCustomSpreadsheetCustomLoader(): void
+    {
+        $reader = new MyXlsxReader();
+        $infile = 'tests/data/Reader/XLSX/colorscale.xlsx';
+        /** @var MySpreadsheet */
+        $mySpreadsheet = $reader->load($infile);
+        self::assertSame(64, $mySpreadsheet->calcSquare('A3'));
+        $mySpreadsheet->disconnectWorksheets();
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -257,4 +257,9 @@ public function setValueBinder(?IValueBinder $valueBinder): self`
`257`	`257`
`258`	`258`	`return $this;`
`259`	`259`	`}`
	`260`	`+`
	`261`	`+ protected function newSpreadsheet(): Spreadsheet`
	`262`	`+ {`
	`263`	`+ return new Spreadsheet();`
	`264`	`+ }`
`260`	`265`	`}`
Original file line number	Diff line number	Diff line change
`@@ -231,8 +231,7 @@ private static function testSimpleXml(mixed $value): SimpleXMLElement`
`231`	`231`	`*/`
`232`	`232`	`protected function loadSpreadsheetFromFile(string $filename): Spreadsheet`
`233`	`233`	`{`
`234`		`- // Create new Spreadsheet`
`235`		`- $spreadsheet = new Spreadsheet();`
	`234`	`+ $spreadsheet = $this->newSpreadsheet();`
`236`	`235`	`$spreadsheet->setValueBinder($this->valueBinder);`
`237`	`236`	`$spreadsheet->removeSheetByIndex(0);`
`238`	`237`
Original file line number	Diff line number	Diff line change
`@@ -229,8 +229,7 @@ public function listWorksheetInfo(string $filename): array`
`229`	`229`	`*/`
`230`	`230`	`protected function loadSpreadsheetFromFile(string $filename): Spreadsheet`
`231`	`231`	`{`
`232`		`- // Create new Spreadsheet`
`233`		`- $spreadsheet = new Spreadsheet();`
	`232`	`+ $spreadsheet = $this->newSpreadsheet();`
`234`	`233`	`$spreadsheet->setValueBinder($this->valueBinder);`
`235`	`234`	`$spreadsheet->removeSheetByIndex(0);`
`236`	`235`
Original file line number	Diff line number	Diff line change
`@@ -144,8 +144,7 @@ public function listWorksheetInfo(string $filename): array`
`144`	`144`	`*/`
`145`	`145`	`protected function loadSpreadsheetFromFile(string $filename): Spreadsheet`
`146`	`146`	`{`
`147`		`- // Create new Spreadsheet`
`148`		`- $spreadsheet = new Spreadsheet();`
	`147`	`+ $spreadsheet = $this->newSpreadsheet();`
`149`	`148`	`$spreadsheet->setValueBinder($this->valueBinder);`
`150`	`149`
`151`	`150`	`// Load into this instance`