code comment and type hinting added

sujancse · sujancse · commit bb4ac7a62f12 · 2020-01-20T18:19:49.000+06:00
diff --git a/src/Contracts/ExporterContract.php b/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;
 }
diff --git a/src/Export.php b/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);
+    }
 }
diff --git a/src/ExportFromArray.php b/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();
     }
 }
diff --git a/src/ExportFromPDOStatement.php b/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();
     }
 }
diff --git a/src/ExportFromQueryBuilder.php b/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();
     }
 }
diff --git a/src/Exporter.php b/src/Exporter.php
@@ -33,7 +33,7 @@ public static function export(): void
     }
 
     /**
-     * @param $model
+     * @param array | object $model
      * @param $columns
      * @param $filename
      * @return ExporterContract

Original file line number	Diff line number	Diff line change
`@@ -5,8 +5,10 @@`
`5`	`5`
`6`	`6`
`7`	`7`
	`8`	`+use Generator;`
	`9`	`+`
`8`	`10`	`interface ExporterContract`
`9`	`11`	`{`
`10`		`- public function set();`
`11`		`- public function get();`
	`12`	`+ public function set(): Generator;`
	`13`	`+ public function get(): void;`
`12`	`14`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@`
`4`	`4`	`namespace Sujan\Exporter;`
`5`	`5`
`6`	`6`
	`7`	`+use Generator;`
`7`	`8`	`use Sujan\Exporter\Contracts\ExporterContract;`
`8`	`9`	`use Sujan\Exporter\Traits\ExportGenerator;`
`9`	`10`
`@@ -12,28 +13,38 @@ class ExportFromArray extends Export implements ExporterContract`
`12`	`13`	`{`
`13`	`14`	`use ExportGenerator;`
`14`	`15`
`15`		`- public function __construct($model, $columns, $filename)`
	`16`	`+ public function __construct(array $model, array $columns, string $filename)`
`16`	`17`	`{`
`17`	`18`	`$this->setConfiguration($model, $columns, $filename);`
`18`	`19`	`}`
`19`	`20`
`20`		`- public function set()`
	`21`	`+ /**`
	`22`	`+ * @return Generator`
	`23`	`+ */`
	`24`	`+ public function set(): Generator`
`21`	`25`	`{`
	`26`	`+ $this->openOutputStream();`
	`27`	`+`
`22`	`28`	`foreach ($this->model as $data) {`
`23`	`29`	`$line = $this->getLine($data, $this->columns);`
`24`	`30`
`25`	`31`	`yield fputcsv($this->file, $line, $this->delimiter);`
`26`	`32`	`}`
`27`	`33`	`}`
`28`	`34`
`29`		`- public function get()`
	`35`	`+ /**`
	`36`	`+ * Get data out of generator`
	`37`	`+ */`
	`38`	`+ public function get(): void`
`30`	`39`	`{`
`31`	`40`	`$generator = $this->set();`
`32`	`41`
`33`	`42`	`while ($generator->valid()) {`
`34`	`43`	`$generator->next();`
`35`	`44`	`}`
`36`	`45`
	`46`	`+ $this->closeOutputStream();`
	`47`	`+`
`37`	`48`	`die();`
`38`	`49`	`}`
`39`	`50`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,8 @@`
`4`	`4`	`namespace Sujan\Exporter;`
`5`	`5`
`6`	`6`
	`7`	`+use Generator;`
	`8`	`+use PDOStatement;`
`7`	`9`	`use Sujan\Exporter\Contracts\ExporterContract;`
`8`	`10`	`use Sujan\Exporter\Traits\ExportGenerator;`
`9`	`11`
`@@ -12,28 +14,38 @@ class ExportFromPDOStatement extends Export implements ExporterContract`
`12`	`14`	`{`
`13`	`15`	`use ExportGenerator;`
`14`	`16`
`15`		`- public function __construct($model, $columns, $filename)`
	`17`	`+ public function __construct(PDOStatement $model, array $columns, string $filename)`
`16`	`18`	`{`
`17`	`19`	`$this->setConfiguration($model, $columns, $filename);`
`18`	`20`	`}`
`19`	`21`
`20`		`- public function set()`
	`22`	`+ /**`
	`23`	`+ * @return Generator`
	`24`	`+ */`
	`25`	`+ public function set(): Generator`
`21`	`26`	`{`
	`27`	`+ $this->openOutputStream();`
	`28`	`+`
`22`	`29`	`foreach ($this->model->fetchAll() as $data) {`
`23`	`30`	`$line = $this->getLine($data, $this->columns);`
`24`	`31`
`25`	`32`	`yield fputcsv($this->file, $line, $this->delimiter);`
`26`	`33`	`}`
`27`	`34`	`}`
`28`	`35`
`29`		`- public function get()`
	`36`	`+ /**`
	`37`	`+ * Get data from PDO statement`
	`38`	`+ */`
	`39`	`+ public function get(): void`
`30`	`40`	`{`
`31`	`41`	`$generator = $this->set();`
`32`	`42`
`33`	`43`	`while ($generator->valid()) {`
`34`	`44`	`$generator->next();`
`35`	`45`	`}`
`36`	`46`
	`47`	`+ $this->closeOutputStream();`
	`48`	`+`
`37`	`49`	`die();`
`38`	`50`	`}`
`39`	`51`	`}`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ public static function export(): void`
`33`	`33`	`}`
`34`	`34`
`35`	`35`	`/**`
`36`		`- * @param $model`
	`36`	`+ * @param array \| object $model`
`37`	`37`	`* @param $columns`
`38`	`38`	`* @param $filename`
`39`	`39`	`* @return ExporterContract`