getHeaders()

README.md

@@ -100,6 +100,17 @@ $rows = SimpleExcelReader::create($pathToCsv)
 });
 ```
 
+#### Retrieving Header Row values
+
+If you would like to retrieve the header row as an array, you can use the `getHeaders()` method.
+
+```php
+$headers = SimpleExcelReader::create($pathToCsv)->getHeaders();
+
+// $headers will contain
+// [ 'email', 'first_name' ]
+```
+
 #### Trimming Header Row values
 
 If the file you are reading contains a title row, but you need to trim additional characters on the title values, then you should use the `trimHeaderRow()` method.

src/SimpleExcelReader.php

@@ -14,6 +14,8 @@ class SimpleExcelReader
 {
     protected string $path;
 
+    protected string $type;
+
     protected ReaderInterface $reader;
 
     protected IteratorInterface $rowIterator;
@@ -28,6 +30,8 @@ class SimpleExcelReader
 
     protected ?Closure $formatHeadersUsing = null;
 
+    protected ?array $headers = null;
+
     protected int $skip = 0;
 
     protected int $limit = 0;
@@ -43,6 +47,8 @@ public function __construct(string $path, string $type = '')
     {
         $this->path = $path;
 
+        $this->type = $type;
+
         $this->reader = $type ?
             ReaderFactory::createFromType($type) :
             ReaderEntityFactory::createReaderFromFile($this->path);
@@ -137,6 +143,7 @@ public function getRows(): LazyCollection
 
         if ($this->processHeader) {
             $this->headers = $this->processHeaderRow($firstRow->toArray());
+
             $this->rowIterator->next();
         }
 
@@ -154,6 +161,31 @@ public function getRows(): LazyCollection
         });
     }
 
+    public function getHeaders(): ?array
+    {
+        if ($this->processHeader && ! $this->headers) {
+            $reader = $this->type ?
+                ReaderFactory::createFromType($this->type) :
+                ReaderEntityFactory::createReaderFromFile($this->path);
+
+            $reader->open($this->path);
+
+            $reader->getSheetIterator()->rewind();
+
+            $sheet = $reader->getSheetIterator()->current();
+
+            $this->rowIterator = $sheet->getRowIterator();
+
+            $this->rowIterator->rewind();
+
+            /** @var \Box\Spout\Common\Entity\Row $firstRow */
+            $firstRow = $this->rowIterator->current();
+
+            $this->headers = $this->processHeaderRow($firstRow->toArray());
+        }
+        return $this->headers;
+    }
+
     public function close()
     {
         $this->reader->close();

tests/SimpleExcelReaderTest.php

@@ -78,6 +78,19 @@ public function it_can_work_with_a_file_where_the_row_is_too_short()
         ], $rows);
     }
 
+    /** @test */
+    public function it_can_retrieve_the_headers()
+    {
+        $headers = SimpleExcelReader::create($this->getStubPath('header-and-rows.csv'))
+            ->getHeaders();
+
+        $this->assertEquals([
+            0 => 'email',
+            1 => 'first_name',
+            2 => 'last_name'
+        ], $headers);
+    }
+
     /** @test */
     public function it_can_ignore_the_headers()
     {
@@ -105,6 +118,16 @@ public function it_can_ignore_the_headers()
         ], $rows);
     }
 
+    /** @test */
+    public function it_doesnt_return_headers_when_headers_are_ignored()
+    {
+        $headers = SimpleExcelReader::create($this->getStubPath('header-and-rows.csv'))
+            ->noHeaderRow()
+            ->getHeaders();
+
+        $this->assertEquals(null, $headers);
+    }
+
     /** @test */
     public function it_can_use_an_alternative_delimiter()
     {
@@ -197,6 +220,35 @@ public function it_can_call_getRows_twice()
         $this->assertNotNull($firstRowAgain);
     }
 
+    /** @test */
+    public function it_can_call_getRows_after_getHeaders()
+    {
+        $reader = SimpleExcelReader::create($this->getStubPath('header-and-rows.csv'));
+
+        $headers = $reader->getHeaders();
+
+        $this->assertEquals([
+            0 => 'email',
+            1 => 'first_name',
+            2 => 'last_name'
+        ], $headers);
+
+        $rows = $reader->getRows()->toArray();
+
+        $this->assertEquals([
+            [
+                'email' => '[email protected]',
+                'first_name' => 'john',
+                'last_name' => 'doe',
+            ],
+            [
+                'email' => '[email protected]',
+                'first_name' => 'mary jane',
+                'last_name' => 'doe',
+            ],
+        ], $rows);
+    }
+
     /** @test */
     public function it_can_call_first_on_the_collection_twice()
     {
@@ -239,6 +291,20 @@ public function it_can_trim_the_header_row_names()
         ], $rows);
     }
 
+    /** @test */
+    public function it_can_retrieve_trimmed_header_row_names()
+    {
+        $headers = SimpleExcelReader::create($this->getStubPath('header-with-spaces.csv'))
+            ->trimHeaderRow()
+            ->getHeaders();
+
+        $this->assertEquals([
+            0 => 'email',
+            1 => 'first_name',
+            2 => 'last_name',
+        ], $headers);
+    }
+
     /** @test */
     public function it_can_trim_the_header_row_names_with_alternate_characters()
     {
@@ -285,6 +351,21 @@ public function it_can_convert_headers_to_snake_case()
         ], $rows);
     }
 
+    /** @test */
+    public function it_can_retrieve_headers_converted_to_snake_case()
+    {
+        $headers = SimpleExcelReader::create($this->getStubPath('headers-not-snake-case.csv'))
+            ->headersToSnakeCase()
+            ->getHeaders();
+
+        $this->assertEquals([
+            0 => 'email',
+            1 => 'first_name',
+            2 => 'last_name',
+            3 => 'job_title',
+        ], $headers);
+    }
+
     /** @test */
     public function it_can_use_custom_header_row_formatter()
     {
@@ -308,4 +389,20 @@ public function it_can_use_custom_header_row_formatter()
             ],
         ], $rows);
     }
+
+    /** @test */
+    public function it_can_retrieve_headers_with_a_custom_formatter()
+    {
+        $headers = SimpleExcelReader::create($this->getStubPath('header-and-rows.csv'))
+            ->formatHeadersUsing(function ($header) {
+                return $header . '_suffix';
+            })
+            ->getHeaders();
+
+        $this->assertEquals([
+            0 => 'email_suffix',
+            1 => 'first_name_suffix',
+            2 => 'last_name_suffix',
+        ], $headers);
+    }
 }