code comment and type hinting added

Author: sujancse

src/Contracts/ExporterContract.php

@@ -5,8 +5,10 @@
 
 
 
+use Generator;
+
 interface ExporterContract
 {
-    public function set();
-    public function get();
+    public function set(): Generator;
+    public function get(): void;
 }

src/Export.php

@@ -4,8 +4,6 @@
 namespace Sujan\Exporter;
 
 
-use Exception;
-use Sujan\Exporter\Contracts\ExporterContract;
 
 class Export
 {
@@ -33,10 +31,13 @@ class Export
      * Array of content types
      */
     private $contentTypes = [
-        '.csv' => 'application/csv',
-        '.xlsx' => 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
+        'csv' => 'application/csv',
+        'xlsx' => 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
     ];
 
+    /*
+     * Content type
+     */
     private $contentType;
 
     /**
@@ -49,14 +50,18 @@ class Export
      */
     protected $delimiter = ";";
 
+    /**
+     * @param array | object $model
+     * @param array $columns
+     * @param string $filename
+     */
     protected function setConfiguration($model, array $columns, string $filename)
     {
         $this->setModel($model);
         $this->setColumns($columns);
         $this->setHeading($columns);
         $this->setFilename($filename);
         $this->setContentType();
-        $this->openOutputStream();
     }
 
     /**
@@ -102,18 +107,27 @@ public function setContentType()
 
         if (!$parts[0]) {
             $this->filename = $this->filename . '.csv';
-            $this->contentType = $this->contentTypes['.csv'];
+            $this->contentType = $this->contentTypes['csv'];
         } else {
-            $this->contentType = $this->contentTypes[strtolower($parts[0])];
+            $this->contentType = $this->contentTypes[trim(strtolower($parts[0]), '.')];
         }
 
         header("Content-Type: {$this->contentType}");
         header("Content-Disposition: attachment; filename={$this->filename};");
     }
 
-    private function openOutputStream()
+    /**
+     * Open the "output" stream
+     */
+    protected function openOutputStream()
     {
-        // open the "output" stream
         $this->file = fopen('php://output', 'w');
     }
+
+    /**
+     * Close output stream
+     */
+    protected function closeOutputStream() {
+        fclose($this->file);
+    }
 }

src/ExportFromArray.php

@@ -4,6 +4,7 @@
 namespace Sujan\Exporter;
 
 
+use Generator;
 use Sujan\Exporter\Contracts\ExporterContract;
 use Sujan\Exporter\Traits\ExportGenerator;
 
@@ -12,28 +13,38 @@ class ExportFromArray extends Export implements ExporterContract
 {
     use ExportGenerator;
 
-    public function __construct($model, $columns, $filename)
+    public function __construct(array $model, array $columns, string $filename)
     {
         $this->setConfiguration($model, $columns, $filename);
     }
 
-    public function set()
+    /**
+     * @return Generator
+     */
+    public function set(): Generator
     {
+        $this->openOutputStream();
+
         foreach ($this->model as $data) {
             $line = $this->getLine($data, $this->columns);
 
             yield fputcsv($this->file, $line, $this->delimiter);
         }
     }
 
-    public function get()
+    /**
+     * Get data out of generator
+     */
+    public function get(): void
     {
         $generator = $this->set();
 
         while ($generator->valid()) {
             $generator->next();
         }
 
+        $this->closeOutputStream();
+
         die();
     }
 }

src/ExportFromPDOStatement.php

@@ -4,6 +4,8 @@
 namespace Sujan\Exporter;
 
 
+use Generator;
+use PDOStatement;
 use Sujan\Exporter\Contracts\ExporterContract;
 use Sujan\Exporter\Traits\ExportGenerator;
 
@@ -12,28 +14,38 @@ class ExportFromPDOStatement extends Export implements ExporterContract
 {
     use ExportGenerator;
 
-    public function __construct($model, $columns, $filename)
+    public function __construct(PDOStatement $model, array $columns, string $filename)
     {
         $this->setConfiguration($model, $columns, $filename);
     }
 
-    public function set()
+    /**
+     * @return Generator
+     */
+    public function set(): Generator
     {
+        $this->openOutputStream();
+
         foreach ($this->model->fetchAll() as $data) {
             $line = $this->getLine($data, $this->columns);
 
             yield fputcsv($this->file, $line, $this->delimiter);
         }
     }
 
-    public function get()
+    /**
+     * Get data from PDO statement
+     */
+    public function get(): void
     {
         $generator = $this->set();
 
         while ($generator->valid()) {
             $generator->next();
         }
 
+        $this->closeOutputStream();
+
         die();
     }
 }

src/ExportFromQueryBuilder.php

@@ -4,6 +4,8 @@
 namespace Sujan\Exporter;
 
 
+use Generator;
+use Illuminate\Database\Eloquent\Builder;
 use Sujan\Exporter\Contracts\ExporterContract;
 use Sujan\Exporter\Traits\ExportGenerator;
 
@@ -12,28 +14,38 @@ class ExportFromQueryBuilder extends Export implements ExporterContract
 {
     use ExportGenerator;
 
-    public function __construct($model, $columns, $filename)
+    public function __construct(Builder $model, array $columns, string $filename)
     {
         $this->setConfiguration($model, $columns, $filename);
     }
 
-    public function set()
+    /**
+     * @return Generator
+     */
+    public function set(): Generator
     {
+        $this->openOutputStream();
+
         foreach ($this->model->get() as $data) {
             $line = $this->getLine($data, $this->columns);
 
             yield fputcsv($this->file, $line, $this->delimiter);
         }
     }
 
-    public function get()
+    /*
+     * Get data from query builder
+     */
+    public function get(): void
     {
         $generator = $this->set();
 
         while ($generator->valid()) {
             $generator->next();
         }
 
+        $this->closeOutputStream();
+
         die();
     }
 }

src/Exporter.php

@@ -33,7 +33,7 @@ public static function export(): void
     }
 
     /**
-     * @param $model
+     * @param array | object $model
      * @param $columns
      * @param $filename
      * @return ExporterContract