Merge branch 'master' into numeric-string-on-decimal-casts

Author: barryvdh

.github/workflows/run-integration-tests.yml

@@ -19,11 +19,8 @@ jobs:
         strategy:
             fail-fast: false
             matrix:
-                php: [8.3, 8.2, 8.1]
-                laravel: [11.*, 10.*]
-                exclude:
-                  - php: 8.1
-                    laravel: 11.*
+                php: [8.4, 8.3, 8.2]
+                laravel: [^11.15]
 
         name: P${{ matrix.php }} - Laravel${{ matrix.laravel }}
         steps:

.github/workflows/run-tests.yml

@@ -21,12 +21,9 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-22.04, windows-2019]
-        php: [8.3, 8.2, 8.1]
-        laravel: [10.*, 11.*]
+        php: [8.4, 8.3, 8.2]
+        laravel: [^11.15]
         stability: [prefer-lowest, prefer-stable]
-        exclude:
-          - php: 8.1
-            laravel: 11.*
     steps:
     - name: Set git to use LF
       if: ${{ matrix.os == 'windows-2019' }}

CHANGELOG.md

@@ -2,17 +2,29 @@
 
 All notable changes to this project will be documented in this file.
 
-[Next release](https://github.com/barryvdh/laravel-ide-helper/compare/v3.1.0...master)
+[Next release](https://github.com/barryvdh/laravel-ide-helper/compare/v3.2.0...master)
+--------------
+
+### Changed
+- Add support for multiple pivot types when using the same accessor.
+- Smarter reset, keep tags that IDE helper doesn't use
+- Use `numeric` type on fields with `decimal` casts
+
+
+2024-10-18, 3.2.0
 --------------
 
 ### Fixed
 - Fix type of hashed model property to `string`
 
 ### Changed
-- Use `numeric` type on fields with `decimal` casts
+- Add support for EloquentBuilder generics introduced in Laravel 11.15.
+- Drop support for Laravel versions earlier than 11.15.
 
 ### Added
 
+- Add support for AsCollection::using and AsEnumCollection::of casts [#1577 / uno-sw](https://github.com/barryvdh/laravel-ide-helper/pull/1577)
+
 2024-07-12, 3.1.0
 ------------------
 

README.md

@@ -1,9 +1,9 @@
 # IDE Helper Generator for Laravel
 
 [![Tests](https://github.com/barryvdh/laravel-ide-helper/actions/workflows/run-tests.yml/badge.svg)](https://github.com/barryvdh/laravel-ide-helper/actions)
-[![Packagist License](https://poser.pugx.org/barryvdh/laravel-ide-helper/license.png)](http://choosealicense.com/licenses/mit/)
-[![Latest Stable Version](https://poser.pugx.org/barryvdh/laravel-ide-helper/version.png)](https://packagist.org/packages/barryvdh/laravel-ide-helper)
-[![Total Downloads](https://poser.pugx.org/barryvdh/laravel-ide-helper/d/total.png)](https://packagist.org/packages/barryvdh/laravel-ide-helper)
+[![Packagist License](https://img.shields.io/badge/Licence-MIT-blue)](http://choosealicense.com/licenses/mit/)
+[![Latest Stable Version](https://img.shields.io/packagist/v/barryvdh/laravel-ide-helper?label=Stable)](https://packagist.org/packages/barryvdh/laravel-ide-helper)
+[![Total Downloads](https://img.shields.io/packagist/dt/barryvdh/laravel-ide-helper?label=Downloads)](https://packagist.org/packages/barryvdh/laravel-ide-helper)
 [![Fruitcake](https://img.shields.io/badge/Powered%20By-Fruitcake-b2bc35.svg)](https://fruitcake.nl/)
 
 **Complete PHPDocs, directly from the source**
@@ -169,11 +169,11 @@ php artisan ide-helper:models "App\Models\Post"
  * @property \Illuminate\Support\Carbon $updated_at
  * @property-read \User $author
  * @property-read \Illuminate\Database\Eloquent\Collection|\Comment[] $comments
- * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Post newModelQuery()
- * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Post newQuery()
- * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Post query()
- * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Post whereTitle($value)
- * @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Post forAuthors(\User ...$authors)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|\App\Models\Post newModelQuery()
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|\App\Models\Post newQuery()
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|\App\Models\Post query()
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|\App\Models\Post whereTitle($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|\App\Models\Post forAuthors(\User ...$authors)
  * …
  */
 ```

composer.json

@@ -20,24 +20,24 @@
         }
     ],
     "require": {
-        "php": "^8.1",
+        "php": "^8.2",
         "ext-json": "*",
-        "barryvdh/reflection-docblock": "^2.1.1",
+        "barryvdh/reflection-docblock": "^2.1.2",
         "composer/class-map-generator": "^1.0",
-        "illuminate/console": "^10 || ^11",
-        "illuminate/database": "^10.38 || ^11",
-        "illuminate/filesystem": "^10 || ^11",
-        "illuminate/support": "^10 || ^11",
+        "illuminate/console": "^11.15",
+        "illuminate/database": "^11.15",
+        "illuminate/filesystem": "^11.15",
+        "illuminate/support": "^11.15",
         "nikic/php-parser": "^4.18 || ^5",
         "phpdocumentor/type-resolver": "^1.1.0"
     },
     "require-dev": {
         "ext-pdo_sqlite": "*",
         "friendsofphp/php-cs-fixer": "^3",
-        "illuminate/config": "^9 || ^10 || ^11",
-        "illuminate/view": "^9 || ^10 || ^11",
+        "illuminate/config": "^11.15",
+        "illuminate/view": "^11.15",
         "mockery/mockery": "^1.4",
-        "orchestra/testbench": "^8 || ^9",
+        "orchestra/testbench": "^9.2",
         "phpunit/phpunit": "^10.5",
         "spatie/phpunit-snapshot-assertions": "^4 || ^5",
         "vimeo/psalm": "^5.4"
@@ -65,7 +65,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "3.1-dev"
+            "dev-master": "3.2-dev"
         },
         "laravel": {
             "providers": [

src/Console/ModelsCommand.php

@@ -219,7 +219,7 @@ protected function getOptions()
             ],
             ['nowrite', 'N', InputOption::VALUE_NONE, 'Don\'t write to Model file'],
             ['reset', 'R', InputOption::VALUE_NONE, 'Remove the original phpdocs instead of appending'],
-            ['smart-reset', 'r', InputOption::VALUE_NONE, 'Refresh the properties/methods list, but keep the text'],
+            ['smart-reset', 'r', InputOption::VALUE_NONE, 'Retained for compatibility, while it no longer has any effect'],
             ['phpstorm-noinspections', 'p', InputOption::VALUE_NONE,
                 'Add PhpFullyQualifiedNameUsageInspection and PhpUnnecessaryFullyQualifiedNameInspection PHPStorm ' .
                 'noinspection tags',
@@ -412,8 +412,6 @@ public function castPropertiesType($model)
                 case 'immutable_datetime':
                     $realType = '\Carbon\CarbonImmutable';
                     break;
-                case AsCollection::class:
-                case AsEnumCollection::class:
                 case 'collection':
                     $realType = '\Illuminate\Support\Collection';
                     break;
@@ -439,6 +437,18 @@ public function castPropertiesType($model)
                 continue;
             }
 
+            if (Str::startsWith($type, AsCollection::class)) {
+                $realType = $this->getTypeInModel($model, $params[0] ?? null) ?? '\Illuminate\Support\Collection';
+            }
+
+            if (Str::startsWith($type, AsEnumCollection::class)) {
+                $realType = '\Illuminate\Support\Collection';
+                $relatedModel = $this->getTypeInModel($model, $params[0] ?? null);
+                if ($relatedModel) {
+                    $realType = $this->getCollectionTypeHint($realType, $relatedModel);
+                }
+            }
+
             $realType = $this->checkForCastableCasts($realType, $params);
             $realType = $this->checkForCustomLaravelCasts($realType);
             $realType = $this->getTypeOverride($realType);
@@ -555,7 +565,7 @@ public function getPropertiesFromTable($model)
                 $this->setMethod(
                     Str::camel('where_' . $name),
                     $this->getClassNameInDestinationFile($model, $builderClass)
-                    . '|'
+                    . '<static>|'
                     . $this->getClassNameInDestinationFile($model, get_class($model)),
                     ['$value']
                 );
@@ -634,14 +644,14 @@ public function getPropertiesFromMethods($model)
                             new ReflectionClass($model),
                             get_class($model)
                         );
-                        $this->setMethod($name, $builder . '|' . $modelName, $args, $comment);
+                        $this->setMethod($name, $builder . '<static>|' . $modelName, $args, $comment);
                     }
                 } elseif (in_array($method, ['query', 'newQuery', 'newModelQuery'])) {
                     $builder = $this->getClassNameInDestinationFile($model, get_class($model->newModelQuery()));
 
                     $this->setMethod(
                         $method,
-                        $builder . '|' . $this->getClassNameInDestinationFile($model, get_class($model))
+                        $builder . '<static>|' . $this->getClassNameInDestinationFile($model, get_class($model))
                     );
 
                     if ($this->write_model_external_builder_methods) {
@@ -716,14 +726,25 @@ public function getPropertiesFromMethods($model)
                                     if ($relationObj instanceof BelongsToMany) {
                                         $pivot = get_class($relationObj->newPivot());
                                         if (!in_array($pivot, [Pivot::class, MorphPivot::class])) {
+                                            $pivot = $this->getClassNameInDestinationFile($model, $pivot);
+
+                                            if ($existingPivot = ($this->properties[$relationObj->getPivotAccessor()] ?? null)) {
+                                                // If the pivot is already set, we need to append the type to it
+                                                $pivot .= '|' . $existingPivot['type'];
+                                            } else {
+                                                // pivots are not always set
+                                                $pivot .= '|null';
+                                            }
+
                                             $this->setProperty(
                                                 $relationObj->getPivotAccessor(),
-                                                $this->getClassNameInDestinationFile($model, $pivot),
+                                                $pivot,
                                                 true,
                                                 false
                                             );
                                         }
                                     }
+
                                     //Collection or array of models (because Collection is Arrayable)
                                     $relatedClass = '\\' . get_class($relationObj->getRelated());
                                     $collectionClass = $this->getCollectionClass($relatedClass);
@@ -907,7 +928,7 @@ public function getMethodType(Model $model, string $classType)
     {
         $modelName = $this->getClassNameInDestinationFile($model, get_class($model));
         $builder = $this->getClassNameInDestinationFile($model, $classType);
-        return $builder . '|' . $modelName;
+        return $builder . '<static>|' . $modelName;
     }
 
     /**
@@ -926,13 +947,19 @@ protected function createPhpDocs($class)
             $reflection->getParentClass()->getInterfaceNames()
         );
 
+        $phpdoc = new DocBlock($reflection, new Context($namespace));
         if ($this->reset) {
-            $phpdoc = new DocBlock('', new Context($namespace));
             $phpdoc->setText(
                 (new DocBlock($reflection, new Context($namespace)))->getText()
             );
-        } else {
-            $phpdoc = new DocBlock($reflection, new Context($namespace));
+            foreach ($phpdoc->getTags() as $tag) {
+                if (
+                    in_array($tag->getName(), ['property', 'property-read', 'property-write', 'method', 'mixin'])
+                    || ($tag->getName() === 'noinspection' && in_array($tag->getContent(), ['PhpUnnecessaryFullyQualifiedNameInspection', 'PhpFullyQualifiedNameUsageInspection']))
+                ) {
+                    $phpdoc->deleteTag($tag);
+                }
+            }
         }
 
         $properties = [];
@@ -1322,9 +1349,9 @@ protected function getSoftDeleteMethods($model)
         if (in_array('Illuminate\\Database\\Eloquent\\SoftDeletes', $traits)) {
             $modelName = $this->getClassNameInDestinationFile($model, get_class($model));
             $builder = $this->getClassNameInDestinationFile($model, \Illuminate\Database\Eloquent\Builder::class);
-            $this->setMethod('withTrashed', $builder . '|' . $modelName, []);
-            $this->setMethod('withoutTrashed', $builder . '|' . $modelName, []);
-            $this->setMethod('onlyTrashed', $builder . '|' . $modelName, []);
+            $this->setMethod('withTrashed', $builder . '<static>|' . $modelName, []);
+            $this->setMethod('withoutTrashed', $builder . '<static>|' . $modelName, []);
+            $this->setMethod('onlyTrashed', $builder . '<static>|' . $modelName, []);
         }
     }
 
@@ -1528,7 +1555,7 @@ protected function writeModelExternalBuilderMethods(Model $model): void
 
             $this->setMethod(
                 $builderMethod,
-                $builderClassBasedOnFQCNOption . '|' . $this->getClassNameInDestinationFile($model, get_class($model)),
+                $builderClassBasedOnFQCNOption . '<static>|' . $this->getClassNameInDestinationFile($model, get_class($model)),
                 $args
             );
         }

tests/Console/ModelsCommand/AdvancedCasts/Collections/AdvancedCastCollection.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts\Collections;
+
+use Illuminate\Support\Collection;
+
+class AdvancedCastCollection extends Collection
+{
+}

tests/Console/ModelsCommand/AdvancedCasts/Enums/AdvancedCastEnum.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts\Enums;
+
+enum AdvancedCastEnum
+{
+    case apple;
+    case banana;
+    case orange;
+}

tests/Console/ModelsCommand/AdvancedCasts/Models/AdvancedCast.php

@@ -4,28 +4,35 @@
 
 namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts\Models;
 
+use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts\Collections\AdvancedCastCollection;
+use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts\Enums\AdvancedCastEnum;
 use Illuminate\Database\Eloquent\Casts\AsArrayObject;
 use Illuminate\Database\Eloquent\Casts\AsCollection;
 use Illuminate\Database\Eloquent\Casts\AsEnumCollection;
 use Illuminate\Database\Eloquent\Model;
 
 class AdvancedCast extends Model
 {
-    protected $casts = [
-        'cast_to_date_serialization' => 'date:Y-m-d',
-        'cast_to_datetime_serialization' => 'datetime:Y-m-d H:i:s',
-        'cast_to_custom_datetime' => 'custom_datetime:Y-m-d H:i:s',
-        'cast_to_immutable_date' => 'immutable_date',
-        'cast_to_immutable_custom_datetime' => 'immutable_custom_datetime:Y-m-d H:i:s',
-        'cast_to_immutable_datetime' => 'immutable_datetime',
-        'cast_to_timestamp' => 'timestamp',
-        'cast_to_encrypted' => 'encrypted',
-        'cast_to_encrypted_array' => 'encrypted:array',
-        'cast_to_encrypted_collection' => 'encrypted:collection',
-        'cast_to_encrypted_json' => 'encrypted:json',
-        'cast_to_encrypted_object' => 'encrypted:object',
-        'cast_to_as_collection' => AsCollection::class,
-        'cast_to_as_enum_collection' => AsEnumCollection::class,
-        'cast_to_as_array_object' => AsArrayObject::class,
-    ];
+    protected function casts(): array
+    {
+        return [
+            'cast_to_date_serialization' => 'date:Y-m-d',
+            'cast_to_datetime_serialization' => 'datetime:Y-m-d H:i:s',
+            'cast_to_custom_datetime' => 'custom_datetime:Y-m-d H:i:s',
+            'cast_to_immutable_date' => 'immutable_date',
+            'cast_to_immutable_custom_datetime' => 'immutable_custom_datetime:Y-m-d H:i:s',
+            'cast_to_immutable_datetime' => 'immutable_datetime',
+            'cast_to_timestamp' => 'timestamp',
+            'cast_to_encrypted' => 'encrypted',
+            'cast_to_encrypted_array' => 'encrypted:array',
+            'cast_to_encrypted_collection' => 'encrypted:collection',
+            'cast_to_encrypted_json' => 'encrypted:json',
+            'cast_to_encrypted_object' => 'encrypted:object',
+            'cast_to_as_collection' => AsCollection::class,
+            'cast_to_as_collection_using' => AsCollection::using(AdvancedCastCollection::class),
+            'cast_to_as_enum_collection' => AsEnumCollection::class,
+            'cast_to_as_enum_collection_of' => AsEnumCollection::of(AdvancedCastEnum::class),
+            'cast_to_as_array_object' => AsArrayObject::class,
+        ];
+    }
 }