add Laravel IDE helper hook

Author: trippo

README.md

@@ -19,11 +19,27 @@ You can install the package via composer:
 composer require datomatic/laravel-enum-collections
 ```
 
-The main parts of the package are: 
+The main parts of the package are:
 - [EnumCollection](#enumCollection)
-- [Eloquent model casting](#casting) 
+- [Eloquent model casting](#casting)
 - [HasEnumCollections trait](#HasEnumCollections-trait)
 
+
+### Using Laravel IDE Helper?
+If you are using [Laravel IDE Helper](https://github.com/barryvdh/laravel-ide-helper), you need to run the following command:
+
+```bash
+php artisan vendor:publish --tag=ide-helper-hooks
+```
+and add `LaravelEnumCollectionModelIdeHelperHook::class` on `model_hooks` array in `config/ide-helper.php`
+
+```php
+    'model_hooks' => [
+        ...,
+        LaravelEnumCollectionModelIdeHelperHook::class,
+    ],
+```
+
 ## EnumCollection
 
 `EnumCollection` is an extension of base [Laravel collection](https://laravel.com/docs/collections) that expand his functionalities to add the compatibility with:

phpstan.neon.dist

@@ -5,6 +5,7 @@ parameters:
     level: 9
     paths:
         - src
+
     tmpDir: build/phpstan
     checkOctaneCompatibility: true
     checkModelProperties: true

src/Casts/AsLaravelEnumCollection.php

@@ -65,7 +65,7 @@ public function get(Model $model, string $key, mixed $value, array $attributes)
             }
 
             /**
-             * @param  Arrayable<int, int|string|TValue>|iterable<int, int|string|TValue>|int|string|null|EnumCollection  $value
+             * @param  Arrayable<TKey, int|string|TValue>|iterable<TKey, int|string|TValue>|int|string|null|EnumCollection<TKey,TValue>  $value
              */
             public function set(Model $model, string $key, mixed $value, array $attributes)
             {

src/EnumCollectionServiceProvider.php

@@ -17,5 +17,10 @@ public function configurePackage(Package $package): void
          * More info: https://github.com/spatie/laravel-package-tools
          */
         $package->name('laravel-enum-collections');
+
+        $this->publishes([
+            $this->package->basePath('/../stubs/LaravelEnumCollectionModelIdeHelperHook.stub')
+                => app_path('Support/IdeHelper/LaravelEnumCollectionModelIdeHelperHook.stub'),
+        ], 'ide-helper-hooks');
     }
 }

stubs/LaravelEnumCollectionModelIdeHelperHook.stub

@@ -0,0 +1,38 @@
+<?php
+declare(strict_types=1);
+
+namespace App\Support\IdeHelper;
+
+use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
+use Barryvdh\LaravelIdeHelper\Contracts\ModelHookInterface;
+use Datomatic\EnumCollections\Casts\AsLaravelEnumCollection;
+use Datomatic\EnumCollections\EnumCollection;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Support\Str;
+
+class LaravelEnumCollectionModelIdeHelperHook implements ModelHookInterface
+{
+    public function run(ModelsCommand $command, Model $model): void
+    {
+        foreach ($model->getCasts() as $attribute => $cast) {
+            if(Str::contains($cast, ':') && Str::contains($cast, AsLaravelEnumCollection::class)) {
+                strtok($cast, ':');
+                $params = strtok(':');
+                $params = $params ? explode(',', $params) : [];
+                $type = $this->getCollectionTypeHint('\\' . EnumCollection::class,'\\' . $params[0]);
+                $command->setProperty($attribute, $type);
+            }
+        }
+    }
+
+    protected function getCollectionTypeHint(string $collectionClassNameInModel, string $relatedModel): string
+    {
+        $useGenericsSyntax = config('ide-helper.use_generics_annotations', true);
+        if ($useGenericsSyntax) {
+            return $collectionClassNameInModel . '<int, ' . $relatedModel . '>';
+        } else {
+            return $collectionClassNameInModel . '|' . $relatedModel . '[]';
+        }
+    }
+
+}