style(phpstan): add phpdoc

thomascombe · Nov 28, 2024 · 0de99a0 · 0de99a0
1 parent daed6dd
commit 0de99a0
Show file tree

Hide file tree

Showing 7 changed files with 24 additions and 4 deletions.
diff --git a/src/Http/Controllers/Admin/Interfaces/ExportableCrud.php b/src/Http/Controllers/Admin/Interfaces/ExportableCrud.php
@@ -8,5 +8,8 @@ interface ExportableCrud
 {
     public function getExport(): ImportExport;
 
+    /**
+     * @return array<string, mixed>
+     */
     public function getExportParameters(): array;
 }
diff --git a/src/Http/Controllers/Admin/Interfaces/ImportableCrud.php b/src/Http/Controllers/Admin/Interfaces/ImportableCrud.php
@@ -8,5 +8,8 @@ interface ImportableCrud
 {
     public function getImport(): ImportExport;
 
+    /**
+     * @return array<string, mixed>
+     */
     public function getImportParameters(): array;
 }
diff --git a/src/Http/Controllers/Admin/Interfaces/MultiExportableCrud.php b/src/Http/Controllers/Admin/Interfaces/MultiExportableCrud.php
@@ -7,5 +7,8 @@ interface MultiExportableCrud
     public const QUERY_PARAM = 'export';
     public const DEFAULT_EXPORT_NAME = 'default';
 
+    /**
+     * @return array<string, mixed>
+     */
     public function getAvailableExports(): array;
 }
diff --git a/src/Http/Requests/ImportRequest.php b/src/Http/Requests/ImportRequest.php
@@ -8,6 +8,9 @@ class ImportRequest extends FormRequest
 {
     const PARAM_FILE = 'file';
 
+    /**
+     * @return array<string, mixed>
+     */
     public function rules(): array
     {
         return [

diff --git a/src/Jobs/ExportJob.php b/src/Jobs/ExportJob.php
@@ -26,9 +26,11 @@ class ExportJob implements ShouldQueue
     use SerializesModels;
 
     private ImportExport $export;
-    private array $exportParameters;
 
-    public function __construct(ImportExport $export, array $exportParameters)
+    /**
+     * @param  array<string, mixed> $exportParameters
+     */
+    public function __construct(ImportExport $export, private array $exportParameters)
     {
         $this->export = $export;
         $this->exportParameters = $exportParameters;

diff --git a/src/Jobs/ImportJob.php b/src/Jobs/ImportJob.php
@@ -21,6 +21,9 @@ class ImportJob implements ShouldQueue
     use Queueable;
     use SerializesModels;
 
+    /**
+     * @param  array<string, mixed> $exportParameters
+     */
     public function __construct(
         private ImportExport $export,
         private array $exportParameters

diff --git a/src/Models/ImportExport.php b/src/Models/ImportExport.php
@@ -59,6 +59,9 @@ class ImportExport extends Model implements ImportExportInterface
         self::COLUMN_STATUS => ImportExportStatus::class,
     ];
 
+    /**
+     * @var array|string[]
+     */
     protected array $dates = [
         self::COLUMN_COMPLETED_AT,
     ];
@@ -68,7 +71,7 @@ public function user(): BelongsTo
         return $this->belongsTo(config('backpack-async-import-export.user_model'));
     }
 
-    protected static function boot()
+    protected static function boot(): void
     {
         parent::boot();
         ImportExport::saving(function (ImportExport $export) {
@@ -128,7 +131,7 @@ public function getDownloadButton(): string
     protected function isReady(): Attribute
     {
         return Attribute::make(
-            get: fn (): bool => ImportExportStatus::Successful === $this->{ImportExport::COLUMN_STATUS}
+            get: fn(): bool => ImportExportStatus::Successful === $this->{ImportExport::COLUMN_STATUS}
                 && Storage::disk($this->disk)->exists($this->{self::COLUMN_FILENAME}),
         );
     }