Import by sheet name

src/Exceptions/BadCountSheets.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Rap2hpoutre\FastExcel\Exceptions;
+
+use Exception;
+
+class BadCountSheets extends Exception
+{
+    public function __construct()
+    {
+        parent::__construct('You file does not contains more than one sheet.');
+    }
+}

src/Exceptions/SheetNameMissing.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Rap2hpoutre\FastExcel\Exceptions;
+
+use Exception;
+
+class SheetNameMissing extends Exception
+{
+    public function __construct(string $sheetName)
+    {
+        parent::__construct("Sheet name [$sheetName] is missing.");
+    }
+}

src/FastExcel.php

@@ -98,6 +98,18 @@ public function sheet($sheet_number)
         return $this;
     }
 
+    /**
+     * @param $sheet_name
+     *
+     * @return $this
+     */
+    public function sheetName($sheet_name)
+    {
+        $this->sheet_name = $sheet_name;
+
+        return $this;
+    }
+
     /**
      * @return $this
      */

src/Importable.php

@@ -6,7 +6,10 @@
 use Illuminate\Support\Str;
 use OpenSpout\Common\Type;
 use OpenSpout\Reader\Common\Creator\ReaderEntityFactory;
+use OpenSpout\Reader\ReaderInterface;
 use OpenSpout\Reader\SheetInterface;
+use Rap2hpoutre\FastExcel\Exceptions\BadCountSheets;
+use Rap2hpoutre\FastExcel\Exceptions\SheetNameMissing;
 
 /**
  * Trait Importable.
@@ -22,6 +25,11 @@ trait Importable
      */
     private $sheet_number = 1;
 
+    /**
+     * @var string|null
+     */
+    private $sheet_name = null;
+
     /**
      * @param \OpenSpout\Reader\ReaderInterface|\OpenSpout\Writer\WriterInterface $reader_or_writer
      *
@@ -33,16 +41,20 @@ abstract protected function setOptions(&$reader_or_writer);
      * @param string        $path
      * @param callable|null $callback
      *
-     * @throws \OpenSpout\Common\Exception\IOException
      * @throws \OpenSpout\Common\Exception\UnsupportedTypeException
      * @throws \OpenSpout\Reader\Exception\ReaderNotOpenedException
+     * @throws \OpenSpout\Common\Exception\IOException
      *
      * @return Collection
      */
     public function import($path, callable $callback = null)
     {
         $reader = $this->reader($path);
 
+        if ($this->sheet_name !== null) {
+            $this->setSheetIndexByName($reader);
+        }
+
         foreach ($reader->getSheetIterator() as $key => $sheet) {
             if ($this->sheet_number != $key) {
                 continue;
@@ -58,9 +70,9 @@ public function import($path, callable $callback = null)
      * @param string        $path
      * @param callable|null $callback
      *
-     * @throws \OpenSpout\Common\Exception\IOException
      * @throws \OpenSpout\Common\Exception\UnsupportedTypeException
      * @throws \OpenSpout\Reader\Exception\ReaderNotOpenedException
+     * @throws \OpenSpout\Common\Exception\IOException
      *
      * @return Collection
      */
@@ -81,11 +93,33 @@ public function importSheets($path, callable $callback = null)
         return new SheetCollection($collections);
     }
 
+    private function setSheetIndexByName(ReaderInterface $reader)
+    {
+        if (iterator_count($reader->getSheetIterator()) < 2) {
+            throw new BadCountSheets();
+        }
+
+        $sheetIndex = -1;
+
+        foreach ($reader->getSheetIterator() as $key => $sheet) {
+            if ($sheet->getName() == $this->sheet_name) {
+                $sheetIndex = $key;
+                break;
+            }
+        }
+
+        if ($sheetIndex === -1) {
+            throw new SheetNameMissing($this->sheet_name);
+        }
+
+        $this->sheet($sheetIndex);
+    }
+
     /**
      * @param $path
      *
-     * @throws \OpenSpout\Common\Exception\IOException
      * @throws \OpenSpout\Common\Exception\UnsupportedTypeException
+     * @throws \OpenSpout\Common\Exception\IOException
      *
      * @return \OpenSpout\Reader\ReaderInterface
      */

tests/FastExcelTest.php

@@ -4,6 +4,8 @@
 
 use OpenSpout\Common\Entity\Style\Color;
 use OpenSpout\Writer\Common\Creator\Style\StyleBuilder;
+use Rap2hpoutre\FastExcel\Exceptions\BadCountSheets;
+use Rap2hpoutre\FastExcel\Exceptions\SheetNameMissing;
 use Rap2hpoutre\FastExcel\FastExcel;
 use Rap2hpoutre\FastExcel\SheetCollection;
 
@@ -216,4 +218,47 @@ public function testExportWithHeaderStyle()
 
         unlink($file);
     }
+
+    /**
+     * @throws \OpenSpout\Common\Exception\IOException
+     * @throws \OpenSpout\Common\Exception\InvalidArgumentException
+     * @throws \OpenSpout\Common\Exception\UnsupportedTypeException
+     * @throws \OpenSpout\Reader\Exception\ReaderNotOpenedException
+     * @throws \OpenSpout\Writer\Exception\WriterNotOpenedException
+     */
+    public function testImportBySheetNameXLSX()
+    {
+        $collection = (new FastExcel())->sheetName('Sheet 2')->import(__DIR__.'/testMultiSheets.xlsx');
+        $this->assertEquals($this->collection(), $collection);
+    }
+
+    /**
+     * @throws \OpenSpout\Common\Exception\IOException
+     * @throws \OpenSpout\Common\Exception\InvalidArgumentException
+     * @throws \OpenSpout\Common\Exception\UnsupportedTypeException
+     * @throws \OpenSpout\Reader\Exception\ReaderNotOpenedException
+     * @throws \OpenSpout\Writer\Exception\WriterNotOpenedException
+     */
+    public function testSheetNameDoesNotExists()
+    {
+        $this->expectException(SheetNameMissing::class);
+        $this->expectExceptionMessage('Sheet name [Sheet C] is missing.');
+
+        (new FastExcel())->sheetName('Sheet C')->import(__DIR__.'/testMultiSheets.xlsx');
+    }
+
+    /**
+     * @throws \OpenSpout\Common\Exception\IOException
+     * @throws \OpenSpout\Common\Exception\InvalidArgumentException
+     * @throws \OpenSpout\Common\Exception\UnsupportedTypeException
+     * @throws \OpenSpout\Reader\Exception\ReaderNotOpenedException
+     * @throws \OpenSpout\Writer\Exception\WriterNotOpenedException
+     */
+    public function testBadCountSheets()
+    {
+        $this->expectException(BadCountSheets::class);
+        $this->expectExceptionMessage('You file does not contains more than one sheet.');
+
+        (new FastExcel())->sheetName('Sheet C')->import(__DIR__.'/test1.xlsx');
+    }
 }