Merge pull request #158 from pascallieverse/main

Add the option to check if a sheet exists by name

Author: freekmurze

README.md

@@ -133,6 +133,13 @@ $rows = SimpleExcelReader::create($pathToXlsx)
     ->getRows();
 ```
 
+if you want to check if a sheet exists, you can use the `sheetExists()` method.
+
+```php  
+$sheetExists = SimpleExcelReader::create($pathToXlsx)
+    ->sheetExists("sheet1");
+```
+
 #### 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

@@ -152,6 +152,20 @@ public function take(int $count): SimpleExcelReader
         return $this;
     }
 
+    public function hasSheet(string $sheetName) : bool
+    {
+        $this->setReader();
+
+        $this->reader->open($this->path);
+
+        foreach ($this->reader->getSheetIterator() as $sheet) {
+            if ($sheetName != "" && $sheetName === $sheet->getName()) {
+                return true;
+            }
+        }
+        return false;
+    }
+
     public function fromSheet(int $sheetNumber): SimpleExcelReader
     {
         $this->sheetNumber = $sheetNumber;

tests/SimpleExcelReaderTest.php

@@ -590,6 +590,18 @@ function () {
     ]);
 });
 
+it('Can check if a sheet exists by name', function () {
+    $reader = SimpleExcelReader::create(getStubPath('multiple_sheets.xlsx'));
+
+    expect($reader->hasSheet("sheet1"))->toBeTrue();
+});
+
+it('Can check if a sheet doesn\'t exists by name', function () {
+    $reader = SimpleExcelReader::create(getStubPath('multiple_sheets.xlsx'));
+
+    expect($reader->hasSheet("sheet0"))->toBeFalse();
+});
+
 it('will not open non-existing sheets by name', function () {
     SimpleExcelReader::create(getStubPath('multiple_sheets.xlsx'))
         ->fromSheetName("sheetNotExists")