Merge pull request #125 from bedus-creation/feature/add-header-from-array

Added addHeaderFromArray method to the SimpleWriter

Author: freekmurze

README.md

@@ -311,6 +311,19 @@ John,Doe
 Jane,Doe
 ```
 
+#### Manually set the header from array
+
+Instead of automatically let the package dedecting a header row, you can set it manually.
+
+```php
+use Spatie\SimpleExcel\SimpleExcelWriter;
+
+$writer = SimpleExcelWriter::create($pathToCsv)
+    ->addHeader(['first_name', 'last_name'])
+    ->addRow(['John', 'Doe'])
+    ->addRow(['Jane', 'Doe'])
+```
+
 #### Writing an Excel file
 
 Writing an Excel file is identical to writing a csv. Just make sure that the path given to the `create` method of `SimpleExcelWriter` ends with `xlsx`.

src/SimpleExcelWriter.php

@@ -127,6 +127,18 @@ public function addRows(iterable $rows, Style $style = null)
         return $this;
     }
 
+    public function addHeader(array $header): self
+    {
+        $headerRow = WriterEntityFactory::createRowFromArray($header, $this->headerStyle);
+
+        $this->writer->addRow($headerRow);
+        $this->numberOfRows++;
+
+        $this->processingFirstRow = false;
+
+        return $this;
+    }
+
     protected function writeHeaderFromRow(array $row)
     {
         $headerValues = array_keys($row);

tests/SimpleExcelWriterTest.php

@@ -60,6 +60,16 @@
     assertMatchesFileSnapshot($this->pathToCsv);
 });
 
+it('can write the header from array', function () {
+    $writerWithAutomaticHeader = SimpleExcelWriter::create($this->pathToCsv)
+        ->addHeader(['first_name', 'last_name'])
+        ->addRow(['John', 'Doe']);
+
+    expect($writerWithAutomaticHeader->getNumberOfRows())->toEqual(2);
+
+    assertMatchesFileSnapshot($this->pathToCsv);
+});
+
 it('can write a CSV without a header', function () {
     SimpleExcelWriter::create($this->pathToCsv)
         ->noHeaderRow()