Merge pull request #117 from SpyBott/Spybott/upgrade/fromSheetName

Add function fromSheetName to read on specific spreasheet name

Author: freekmurze

README.md

@@ -128,14 +128,22 @@ If your file does not contain a header row, you should also use `noHeaderRow()`,
 
 ### Working with multiple sheet documents
 
-Excel files can include multiple spreadsheets. You can select the sheet you want to use with the `fromSheet()` method.
+Excel files can include multiple spreadsheets. You can select the sheet you want to use with the `fromSheet()` method to select by index.
 
 ```php
 $rows = SimpleExcelReader::create($pathToXlsx)
     ->fromSheet(3)
     ->getRows();
 ```
 
+With multiple spreadsheets, you can too select the sheet you want to use with the `fromSheetName()` method to select by name.
+
+```php
+$rows = SimpleExcelReader::create($pathToXlsx)
+    ->fromSheetName("sheet1")
+    ->getRows();
+```
+
 #### Retrieving header row values
 
 If you would like to retrieve the header row as an array, you can use the `getHeaders()` method.

src/SimpleExcelReader.php

@@ -1,5 +1,4 @@
 <?php
-
 namespace Spatie\SimpleExcel;
 
 use Illuminate\Support\LazyCollection;
@@ -14,36 +13,24 @@
 
 class SimpleExcelReader
 {
-    protected string $path;
 
+    protected string $path;
     protected string $type;
-
     protected ReaderInterface $reader;
-
     protected IteratorInterface $rowIterator;
-
     protected int $sheetNumber = 1;
-
+    protected string $sheetName = "";
+    protected bool $searchSheetByName = false;
     protected bool $processHeader = true;
-
     protected bool $trimHeader = false;
-
     protected bool $headersToSnakeCase = false;
-
     protected ?string $trimHeaderCharacters = null;
-
     protected mixed $formatHeadersUsing = null;
-
     protected ?array $headers = null;
-
     protected int $headerOnRow = 0;
-
     protected ?array $customHeaders = [];
-
     protected int $skip = 0;
-
     protected int $limit = 0;
-
     protected bool $useLimit = false;
 
     public static function create(string $file, string $type = '')
@@ -150,7 +137,15 @@ public function fromSheet(int $sheetNumber): SimpleExcelReader
     {
         $this->sheetNumber = $sheetNumber;
         $this->headers = null;
+        $this->searchSheetByName = false;
+        return $this;
+    }
 
+    public function fromSheetName(string $sheetName): SimpleExcelReader
+    {
+        $this->searchSheetByName = true;
+        $this->sheetName = $sheetName;
+        $this->headers = null;
         return $this;
     }
 
@@ -168,22 +163,22 @@ public function getRows(): LazyCollection
         }
 
         return LazyCollection::make(function () {
-            while ($this->rowIterator->valid() && $this->skip && $this->skip--) {
-                $this->rowIterator->next();
-            }
-            while ($this->rowIterator->valid() && (! $this->useLimit || $this->limit--)) {
-                $row = $this->rowIterator->current();
+                while ($this->rowIterator->valid() && $this->skip && $this->skip--) {
+                    $this->rowIterator->next();
+                }
+                while ($this->rowIterator->valid() && (!$this->useLimit || $this->limit--)) {
+                    $row = $this->rowIterator->current();
 
-                yield $this->getValueFromRow($row);
+                    yield $this->getValueFromRow($row);
 
-                $this->rowIterator->next();
-            }
-        });
+                    $this->rowIterator->next();
+                }
+            });
     }
 
     public function getHeaders(): ?array
     {
-        if (! $this->processHeader) {
+        if (!$this->processHeader) {
             if ($this->customHeaders) {
                 return $this->customHeaders;
             }
@@ -273,7 +268,7 @@ protected function trim(string $header): string
     {
         $arguments[] = $header;
 
-        if (! is_null($this->trimHeaderCharacters)) {
+        if (!is_null($this->trimHeaderCharacters)) {
             $arguments[] = $this->trimHeaderCharacters;
         }
 
@@ -296,7 +291,7 @@ protected function getValueFromRow(Row $row): array
 
         $headers = $this->customHeaders ?: $this->headers;
 
-        if (! $headers) {
+        if (!$headers) {
             return $values;
         }
 
@@ -312,17 +307,33 @@ protected function getValueFromRow(Row $row): array
     protected function getSheet(): SheetInterface
     {
         $this->reader->open($this->path);
+        $sheet = ($this->searchSheetByName) ? $this->getActiveSheetByName() : $this->getActiveSheetByIndex();
+        return $sheet;
+    }
 
+    protected function getActiveSheetByName(): SheetInterface
+    {
         foreach ($this->reader->getSheetIterator() as $key => $sheet) {
-            if ($key === $this->sheetNumber) {
+            if ($this->sheetName != "" && $this->sheetName === $sheet->getName()) {
                 break;
             }
         }
+        if ($this->sheetName != "" && $this->sheetName !== $sheet->getName()) {
+            throw new InvalidArgumentException("Sheet name {$this->sheetName} does not exist in {$this->path}.");
+        }
+        return $sheet;
+    }
 
+    protected function getActiveSheetByIndex(): SheetInterface
+    {
+        foreach ($this->reader->getSheetIterator() as $key => $sheet) {
+            if ($key === $this->sheetNumber) {
+                break;
+            }
+        }
         if ($this->sheetNumber !== $key) {
-            throw new InvalidArgumentException("Sheet {$key} does not exist in {$this->path}.");
+            throw new InvalidArgumentException("Sheet Index {$key} does not exist in {$this->path}.");
         }
-
         return $sheet;
     }
 

tests/SimpleExcelReaderTest.php

@@ -655,4 +655,30 @@ public function it_will_not_open_non_existing_sheets()
             ->fromSheet(3)
             ->getHeaders();
     }
+	
+	/** @test */
+	public function it_can_select_the_sheet_of_an_excel_file_by_name()
+	{
+		$reader = SimpleExcelReader::create($this->getStubPath('multiple_sheets.xlsx'));
+
+        $this->assertEquals([
+            0 => 'firstname',
+            1 => 'lastname',
+        ], $reader->fromSheetName("sheet1")->getHeaders());
+
+        $this->assertEquals([
+            0 => 'contact',
+            1 => 'email',
+        ], $reader->fromSheetName("sheet2")->getHeaders());
+	}
+	
+    /** @test */
+    public function it_will_not_open_non_existing_sheets_by_name()
+    {
+        $this->expectException(InvalidArgumentException::class);
+
+        SimpleExcelReader::create($this->getStubPath('multiple_sheets.xlsx'))
+            ->fromSheetName("sheetNotExists")
+            ->getHeaders();
+    }
 }