Merge pull request #192 from amit-roy1999/feature/get-sheet-names

Added getSheets function to get a list of avilabel sheet names.

Author: freekmurze

README.md

@@ -125,6 +125,14 @@ $rows = SimpleExcelReader::create($pathToXlsx)
     ->getRows();
 ```
 
+You can also retrieve all sheet names in a document using the `getSheetNames()` method.
+
+```php
+$sheets = SimpleExcelReader::create($pathToXlsx)
+    ->getSheetNames();
+```    
+
+
 With multiple spreadsheets, you can too select the sheet you want to use with the `fromSheetName()` method to select by name.
 
 ```php

src/SimpleExcelReader.php

@@ -187,6 +187,21 @@ public function take(int $count): SimpleExcelReader
         return $this;
     }
 
+    public function getSheetNames(): array
+    {
+        $this->setReader();
+
+        $this->reader->open($this->path);
+
+        $sheets = [];
+
+        foreach ($this->reader->getSheetIterator() as $sheet) {
+            $sheets[] = $sheet->getName();
+        }
+
+        return $sheets;
+    }
+
     public function hasSheet(string $sheetName): bool
     {
         $this->setReader();

tests/SimpleExcelReaderTest.php

@@ -566,6 +566,17 @@ function () {
     ]);
 });
 
+it('can get multiple sheet names', function () {
+    $reader = SimpleExcelReader::create(getStubPath('multiple_sheets.xlsx'));
+
+    expect(
+        $reader->getSheetNames()
+    )->toEqual([
+        0 => 'sheet1',
+        1 => 'sheet2',
+    ]);
+});
+
 it('will not open non-existing sheets', function () {
     SimpleExcelReader::create(getStubPath('multiple_sheets.xlsx'))
         ->fromSheet(3)