type hinting

Author: ibnnajjaar

src/Exceptions/DownloadableImportValidationException.php

@@ -9,20 +9,15 @@
 
 namespace Javaabu\Imports\Exceptions;
 
+use Illuminate\Http\Response;
+use Illuminate\Http\RedirectResponse;
 use Javaabu\Imports\Exports\ErrorsExport;
-use Maatwebsite\Excel\Concerns\Exportable;
 
 class DownloadableImportValidationException extends ImportValidationException
 {
-    /**
-     * @var Exportable
-     */
-    protected $exportable;
+    protected ErrorsExport $exportable;
 
-    /**
-     * @var string
-     */
-    protected $export_file_name;
+    protected string $export_file_name;
 
     /**
      * Constructor
@@ -38,30 +33,24 @@ public function __construct(ErrorsExport $exportable, $export_file_name, array $
 
     /**
      * Get the exportable file name
-     *
-     * @return string
      */
-    public function getExportFileName()
+    public function getExportFileName(): string
     {
         return $this->export_file_name;
     }
 
     /**
      * Get the exportable
-     *
-     * @return Exportable
      */
-    public function getExportable()
+    public function getExportable(): ErrorsExport
     {
         return $this->exportable;
     }
 
     /**
      * Send json response
-     *
-     * @return \Illuminate\Http\RedirectResponse|\Illuminate\Http\Response
      */
-    protected function sendHttpResponse()
+    protected function sendHttpResponse(): Response|RedirectResponse
     {
         return $this->getExportable()->download($this->getExportFileName());
     }

src/Exceptions/ImportValidationException.php

@@ -9,23 +9,16 @@
 
 namespace Javaabu\Imports\Exceptions;
 
+use Illuminate\Http\Response;
 use Illuminate\Http\JsonResponse;
+use Illuminate\Http\RedirectResponse;
 use Javaabu\Helpers\Exceptions\AppException;
 
 class ImportValidationException extends AppException
 {
-    /**
-     * @var array
-     */
-    protected $errors;
+    protected ?array $errors;
 
-    /**
-     * Constructor
-     *
-     * @param  string  $message
-     * @param  string  $name
-     */
-    public function __construct(array $errors, $message = 'Import data is invalid', $name = 'ImportValidationErrors')
+    public function __construct(array $errors, ?string $message = 'Import data is invalid', ?string $name = 'ImportValidationErrors')
     {
         parent::__construct(422, $name, $message);
 
@@ -34,30 +27,24 @@ public function __construct(array $errors, $message = 'Import data is invalid',
 
     /**
      * Get the errors
-     *
-     * @return array
      */
-    public function getErrors()
+    public function getErrors(): ?array
     {
         return $this->errors;
     }
 
     /**
      * Send json response
-     *
-     * @return \Illuminate\Http\RedirectResponse|\Illuminate\Http\Response
      */
-    protected function sendHttpResponse()
+    protected function sendHttpResponse(): Response|RedirectResponse
     {
         return back()->withErrors($this->getErrors(), 'import_errors');
     }
 
     /**
      * Send json response
-     *
-     * @return JsonResponse
      */
-    protected function sendJsonResponse()
+    protected function sendJsonResponse(): JsonResponse
     {
         return response()->json([
             'message' => $this->getMessage(),

src/Exceptions/TooManyRowsException.php

@@ -9,30 +9,23 @@
 
 namespace Javaabu\Imports\Exceptions;
 
+use Illuminate\Http\Response;
 use Illuminate\Http\JsonResponse;
+use Illuminate\Http\RedirectResponse;
 use Javaabu\Helpers\Exceptions\AppException;
 
 class TooManyRowsException extends AppException
 {
-    /**
-     * @var int
-     */
-    protected $count;
+    protected int $count;
 
-    /**
-     * @var string
-     */
-    protected $file_name;
+    protected ?string $file_name;
 
-    /**
-     * Constructor
-     *
-     * @param  string  $file_name
-     * @param  string  $message
-     * @param  string  $name
-     */
-    public function __construct(int $count, $file_name = '', $message = 'The import file contains too many rows to import in one go. The data would be imported in the background and you would be notified via email once the data is imported.', $name = 'TooManyRows')
-    {
+    public function __construct(
+        int $count,
+        ?string $file_name = '',
+        ?string $message = 'The import file contains too many rows to import in one go. The data would be imported in the background and you would be notified via email once the data is imported.',
+        ?string $name = 'TooManyRows'
+    ) {
         parent::__construct(422, $name, $message);
 
         $this->count = $count;
@@ -41,30 +34,24 @@ public function __construct(int $count, $file_name = '', $message = 'The import
 
     /**
      * Get the count
-     *
-     * @return int
      */
-    public function getCount()
+    public function getCount(): int
     {
         return $this->count;
     }
 
     /**
      * Get the filename
-     *
-     * @return int
      */
-    public function getFileName()
+    public function getFileName(): ?string
     {
         return $this->file_name;
     }
 
     /**
      * Send json response
-     *
-     * @return \Illuminate\Http\RedirectResponse|\Illuminate\Http\Response
      */
-    protected function sendHttpResponse()
+    protected function sendHttpResponse(): Response|RedirectResponse
     {
         return back()->with([
             'row_count' => $this->getCount(),
@@ -75,10 +62,8 @@ protected function sendHttpResponse()
 
     /**
      * Send json response
-     *
-     * @return JsonResponse
      */
-    protected function sendJsonResponse()
+    protected function sendJsonResponse(): JsonResponse
     {
         return response()->json([
             'message' => $this->getMessage(),

src/Exports/ErrorsExport.php

@@ -11,24 +11,12 @@ class ErrorsExport implements WithMultipleSheets
 {
     use Exportable;
 
-    /**
-     * @var array
-     */
-    protected $headings;
-
-    /**
-     * @var array
-     */
-    protected $invalid_rows;
-
-    /**
-     * @var array
-     */
-    protected $valid_rows;
-
-    /**
-     * Errors Export constructor.
-     */
+    protected ?array $headings;
+
+    protected ?array $invalid_rows;
+
+    protected ?array $valid_rows;
+
     public function __construct(array $valid_rows, array $invalid_rows, array $headings)
     {
         $this->valid_rows = $valid_rows;

src/Exports/ImportTemplate.php

@@ -11,19 +11,10 @@ class ImportTemplate implements FromArray, ShouldAutoSize, WithHeadings
 {
     use Exportable;
 
-    /**
-     * @var array
-     */
-    protected $headings;
-
-    /**
-     * @var array
-     */
-    protected $dummy_data;
-
-    /**
-     * Create a new vendors export instance.
-     */
+    protected ?array $headings;
+
+    protected ?array $dummy_data;
+
     public function __construct(array $headings, array $dummy_data)
     {
         $this->headings = $headings;

src/Exports/Sheets/InvalidRowsSheet.php

@@ -12,19 +12,10 @@ class InvalidRowsSheet implements FromArray, ShouldAutoSize, WithHeadings, WithT
 {
     use Exportable;
 
-    /**
-     * @var array
-     */
-    protected $headings;
-
-    /**
-     * @var array
-     */
-    protected $data;
-
-    /**
-     * Create a new vendors export instance.
-     */
+    protected ?array $headings;
+
+    protected ?array $data;
+
     public function __construct(array $headings, array $data)
     {
         $this->headings = $headings;

src/Http/Requests/ImportsRequest.php

@@ -16,11 +16,11 @@ public function authorize(): bool
     public function rules(): array
     {
         return [
-            'model' => 'string|required|in:'.implode(',', array_keys(ImportsRepository::getImportablesList($this->user()))),
-            'import_file' => AllowedMimeTypes::getValidationRule('excel').'|required_unless:action,download_template',
-            'action' => 'string|in:download_template',
+            'model'                => 'string|required|in:' . implode(',', array_keys(ImportsRepository::getImportablesList($this->user()))),
+            'import_file'          => AllowedMimeTypes::getValidationRule('excel') . '|required_unless:action,download_template',
+            'action'               => 'string|in:download_template',
             'overwrite_duplicates' => 'boolean',
-            'error_handler' => 'in:download,display',
+            'error_handler'        => 'in:download,display',
         ];
     }
 }