Bump branch alias to 3.6 (#1774)

The MetaCommand's custom autoloader throws a ReflectionException for any
class not found during meta generation. However, this breaks libraries
that use class_exists() to check for optional dependencies before loading
them (e.g. Doctrine ORM checking for StaticReflectionService removed in
doctrine/persistence v4).

This fix checks the call stack (up to 3 frames) for class_exists(),
interface_exists(), trait_exists(), or enum_exists() calls and returns
gracefully instead of throwing, allowing the existence check to return
false as expected.

Fixes #1750

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

@@ -1,75 +1,79 @@
 name: Integration Tests
 
 on:
-    push:
-        branches:
-            - master
-    pull_request:
-        branches:
-            - "*"
-    schedule:
-        - cron: '0 0 * * *'
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - "*"
 
 jobs:
-    php-laravel-integration-tests:
-        runs-on: ubuntu-22.04
-        timeout-minutes: 15
-        env:
-            COMPOSER_NO_INTERACTION: 1
-        strategy:
-            fail-fast: false
-            matrix:
-                php: [8.4, 8.3, 8.2]
-                laravel: [11.x, 12.x]
+  php-laravel-integration-tests:
+    runs-on: ubuntu-22.04
 
-        name: P${{ matrix.php }} - Laravel${{ matrix.laravel }}
-        steps:
-            - name: Checkout code
-              uses: actions/checkout@v6
-              with:
-                  path: src
+    timeout-minutes: 15
 
-            - name: Setup PHP
-              uses: shivammathur/setup-php@v2
-              with:
-                  php-version: ${{ matrix.php }}
-                  coverage: none
+    env:
+      COMPOSER_NO_INTERACTION: 1
 
-            - name: Install dependencies
-              run: |
-                  composer create-project --prefer-dist laravel/laravel:${{ matrix.laravel }} --stability=dev --no-progress sample
-                  cd sample
-                  composer config minimum-stability dev
-                  composer update --prefer-stable --prefer-dist --no-progress
+    strategy:
+      fail-fast: false
+      matrix:
+        php: [8.5, 8.4, 8.3, 8.2]
+        laravel: [11.x, 12.x, 13.x]
+        exclude:
+          - laravel: 13.x
+            php: 8.2
 
-            - name: Add package from source
-              run: |
-                  cd sample
-                  sed -e 's|"type": "project",|&\n"repositories": [ { "type": "path", "url": "../src" } ],|' -i composer.json
-                  composer require --dev "barryvdh/laravel-ide-helper:*" --with-all-dependencies
+    name: P${{ matrix.php }} - Laravel${{ matrix.laravel }}
 
-            - name: Execute generate run
-              run: |
-                  cd sample
-                  php artisan ide-helper:generate
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v6
+        with:
+          path: src
 
-            - name: Execute meta run
-              run: |
-                  cd sample
-                  php artisan ide-helper:meta -v
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          coverage: none
 
-            - name: Check file existence
-              run: |
-                ls sample/_ide_helper.php
-                ls sample/.phpstorm.meta.php
+      - name: Install dependencies
+        run: |
+          composer create-project --prefer-dist laravel/laravel:${{ matrix.laravel }} --stability=dev --no-progress sample
+          cd sample
+          composer config minimum-stability dev
+          composer update --prefer-stable --prefer-dist --no-progress
 
+      - name: Add package from source
+        run: |
+          cd sample
+          sed -e 's|"type": "project",|&\n"repositories": [ { "type": "path", "url": "../src" } ],|' -i composer.json
+          composer require --dev "barryvdh/laravel-ide-helper:*" --with-all-dependencies
 
-            - name: Check logs
-              run: |
-                if [ `ls -1q "sample/storage/logs/" | wc -l` -gt 0 ]; then
-                  for logfile in sample/storage/logs/*; do
-                    echo "-- $logfile --"
-                    cat $logfile
-                  done
-                  exit 1
-                fi
+      - name: Execute generate run
+        run: |
+          cd sample
+          php artisan ide-helper:generate
+
+      - name: Execute meta run
+        run: |
+          cd sample
+          php artisan ide-helper:meta -v
+
+      - name: Check file existence
+        run: |
+          ls sample/_ide_helper.php
+          ls sample/.phpstorm.meta.php
+
+      - name: Check logs
+        run: |
+          if [ `ls -1q "sample/storage/logs/" | wc -l` -gt 0 ]; then
+            for logfile in sample/storage/logs/*; do
+              echo "-- $logfile --"
+              cat $logfile
+            done
+            exit 1
+          fi

.github/workflows/run-tests.yml

@@ -7,13 +7,13 @@ on:
   pull_request:
     branches:
       - "*"
-  schedule:
-  - cron: '0 0 * * *'
 
 jobs:
   php-tests:
     runs-on: ${{ matrix.os }}
+
     timeout-minutes: 15
+
     env:
       COMPOSER_NO_INTERACTION: 1
 
@@ -22,36 +22,40 @@ jobs:
       matrix:
         os: [ubuntu-latest]
         php: [8.5, 8.4, 8.3, 8.2]
-        laravel: [~11.15, 12.x]
+        laravel: [12.x, 13.x, ~11.15]
         stability: [prefer-lowest, prefer-stable]
         include:
           - os: windows-latest
             php: 8.3
             laravel: 12.x
             stability: prefer-stable
+        exclude:
+          - laravel: 13.x
+            php: 8.2
+
     steps:
-    - name: Set git to use LF
-      if: ${{ matrix.os == 'windows-latest' }}
-      run: |
-        git config --global core.autocrlf false
-        git config --global core.eol lf
+      - name: Set git to use LF
+        if: "${{ matrix.os == 'windows-latest' }}"
+        run: |
+          git config --global core.autocrlf false
+          git config --global core.eol lf
 
-    - name: Checkout code
-      uses: actions/checkout@v6
+      - name: Checkout code
+        uses: actions/checkout@v6
 
-    - name: Setup PHP
-      uses: shivammathur/setup-php@v2
-      with:
-        php-version: ${{ matrix.php }}
-        coverage: none
-        extensions: pdo_sqlite, fileinfo
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          coverage: none
+          extensions: pdo_sqlite, fileinfo
 
-    - name: Install dependencies
-      run: |
-        composer remove vimeo/psalm --no-update --dev
-        composer remove friendsofphp/php-cs-fixer --no-update --dev
-        composer require "laravel/framework:${{ matrix.laravel }}" --no-update --no-progress
-        composer update --prefer-dist --no-progress --${{ matrix.stability }}
+      - name: Install dependencies
+        run: |
+          composer remove vimeo/psalm --no-update --dev
+          composer remove friendsofphp/php-cs-fixer --no-update --dev
+          composer require "laravel/framework:${{ matrix.laravel }}" --no-update --no-progress
+          composer update --prefer-dist --no-progress --${{ matrix.stability }}
 
-    - name: Execute Unit Tests
-      run: composer test-ci
+      - name: Execute Unit Tests
+        run: composer test-ci

.gitignore

@@ -1,4 +1,5 @@
 .phpunit.result.cache
+/auth.json
 /build
 /.idea
 /.php-cs-fixer.cache

composer.json

@@ -25,21 +25,21 @@
         "ext-json": "*",
         "barryvdh/reflection-docblock": "^2.4",
         "composer/class-map-generator": "^1.0",
-        "illuminate/console": "^11.15 || ^12",
-        "illuminate/database": "^11.15 || ^12",
-        "illuminate/filesystem": "^11.15 || ^12",
-        "illuminate/support": "^11.15 || ^12"
+        "illuminate/console": "^11.15 || ^12 || ^13.0",
+        "illuminate/database": "^11.15 || ^12 || ^13.0",
+        "illuminate/filesystem": "^11.15 || ^12 || ^13.0",
+        "illuminate/support": "^11.15 || ^12 || ^13.0"
     },
     "require-dev": {
         "ext-pdo_sqlite": "*",
         "friendsofphp/php-cs-fixer": "^3",
-        "illuminate/config": "^11.15 || ^12",
-        "illuminate/view": "^11.15 || ^12",
+        "illuminate/config": "^11.15 || ^12 || ^13.0",
+        "illuminate/view": "^11.15 || ^12 || ^13.0",
         "larastan/larastan": "^3.1",
         "mockery/mockery": "^1.4",
-        "orchestra/testbench": "^9.2 || ^10",
+        "orchestra/testbench": "^9.2 || ^10 || ^11.0",
         "phpstan/phpstan-phpunit": "^2.0",
-        "phpunit/phpunit": "^10.5 || ^11.5.3",
+        "phpunit/phpunit": "^10.5 || ^11.5.3 || ^12.5.12",
         "spatie/phpunit-snapshot-assertions": "^4 || ^5",
         "vlucas/phpdotenv": "^5"
     },
@@ -66,7 +66,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "3.5-dev"
+            "dev-master": "3.6-dev"
         },
         "laravel": {
             "providers": [
@@ -76,6 +76,7 @@
     },
     "scripts": {
         "analyze": "phpstan",
+        "analyze-set-baseline": "phpstan --generate-baseline",
         "check-style": [
             "php-cs-fixer fix --diff --diff-format=udiff --dry-run",
             "php-cs-fixer fix --diff --diff-format=udiff --dry-run --config=.php_cs.tests.php"
@@ -84,9 +85,8 @@
             "php-cs-fixer fix",
             "php-cs-fixer fix --config=.php-cs-fixer.tests.php"
         ],
-        "analyze-set-baseline": "phpstan --generate-baseline",
         "test": "phpunit",
-        "test-ci": "phpunit -d --without-creating-snapshots",
+        "test-ci": "phpunit",
         "test-regenerate": "phpunit -d --update-snapshots"
     }
 }

config/ide-helper.php

@@ -47,6 +47,17 @@ return [
 
     'include_fluent' => false,
 
+    /*
+    |--------------------------------------------------------------------------
+    | Write model query methods
+    |--------------------------------------------------------------------------
+    |
+    | Set to false to disable generated docs for the 'query()', 'newQuery()' and 'newModelQuery()' methods.
+    |
+    */
+
+    'write_query_methods' => true,
+
     /*
     |--------------------------------------------------------------------------
     | Write model magic methods
@@ -190,29 +201,29 @@ return [
     ],
 
     /*
-     |--------------------------------------------------------------------------
-     | Support for camel cased models
-     |--------------------------------------------------------------------------
-     |
-     | There are some Laravel packages (such as Eloquence) that allow for accessing
-     | Eloquent model properties via camel case, instead of snake case.
-     |
-     | Enabling this option will support these packages by saving all model
-     | properties as camel case, instead of snake case.
-     |
-     | For example, normally you would see this:
-     |
-     |  * @property \Illuminate\Support\Carbon $created_at
-     |  * @property \Illuminate\Support\Carbon $updated_at
-     |
-     | With this enabled, the properties will be this:
-     |
-     |  * @property \Illuminate\Support\Carbon $createdAt
-     |  * @property \Illuminate\Support\Carbon $updatedAt
-     |
-     | Note, it is currently an all-or-nothing option.
-     |
-     */
+    |--------------------------------------------------------------------------
+    | Support for camel cased models
+    |--------------------------------------------------------------------------
+    |
+    | There are some Laravel packages (such as Eloquence) that allow for accessing
+    | Eloquent model properties via camel case, instead of snake case.
+    |
+    | Enabling this option will support these packages by saving all model
+    | properties as camel case, instead of snake case.
+    |
+    | For example, normally you would see this:
+    |
+    |  * @property \Illuminate\Support\Carbon $created_at
+    |  * @property \Illuminate\Support\Carbon $updated_at
+    |
+    | With this enabled, the properties will be this:
+    |
+    |  * @property \Illuminate\Support\Carbon $createdAt
+    |  * @property \Illuminate\Support\Carbon $updatedAt
+    |
+    | Note, it is currently an all-or-nothing option.
+    |
+    */
     'model_camel_case_properties' => false,
 
     /*

src/Alias.php

@@ -101,7 +101,7 @@ class Alias
         }
 
         if ($facade === '\Illuminate\Database\Eloquent\Model') {
-            $this->usedMethods = ['decrement', 'increment'];
+            $this->usedMethods = ['decrement' => true, 'increment' => true];
         }
     }
 
@@ -187,7 +187,7 @@ class Alias
     public function shouldExtendParentClass()
     {
         return $this->parentClass
-            && $this->getExtendsNamespace() !== '\\Illuminate\\Support\\Facades';
+            && !is_subclass_of($this->extends, Facade::class);
     }
 
     /**
@@ -381,7 +381,7 @@ class Alias
             $method = new \ReflectionMethod($className, $name);
             $class = new ReflectionClass($className);
 
-            if (!in_array($magic, $this->usedMethods)) {
+            if (!isset($this->usedMethods[$magic])) {
                 if ($class !== $this->root) {
                     $this->methods[] = new Method(
                         $method,
@@ -393,7 +393,7 @@ class Alias
                         $this->getTemplateNames()
                     );
                 }
-                $this->usedMethods[] = $magic;
+                $this->usedMethods[$magic] = true;
             }
         }
     }
@@ -410,7 +410,7 @@ class Alias
             $methods = $reflection->getMethods(\ReflectionMethod::IS_PUBLIC);
             if ($methods) {
                 foreach ($methods as $method) {
-                    if (!in_array($method->name, $this->usedMethods)) {
+                    if (!isset($this->usedMethods[$method->name])) {
                         // Only add the methods to the output when the root is not the same as the class.
                         // And don't add the __*() methods
                         if ($this->extends !== $class && substr($method->name, 0, 2) !== '__') {
@@ -424,7 +424,7 @@ class Alias
                                 $this->getTemplateNames(),
                             );
                         }
-                        $this->usedMethods[] = $method->name;
+                        $this->usedMethods[$method->name] = true;
                     }
                 }
             }
@@ -435,7 +435,7 @@ class Alias
                 $properties = $reflection->getStaticProperties();
                 $macros = isset($properties['macros']) ? $properties['macros'] : [];
                 foreach ($macros as $macro_name => $macro_func) {
-                    if (!in_array($macro_name, $this->usedMethods)) {
+                    if (!isset($this->usedMethods[$macro_name])) {
                         try {
                             $method = $this->getMacroFunction($macro_func);
                         } catch (Throwable $e) {
@@ -451,7 +451,7 @@ class Alias
                             $this->classAliases,
                             $this->getReturnTypeNormalizers($reflection)
                         );
-                        $this->usedMethods[] = $macro_name;
+                        $this->usedMethods[$macro_name] = true;
                     }
                 }
             }
@@ -589,12 +589,13 @@ class Alias
      */
     protected function removeDuplicateMethodsFromPhpDoc()
     {
-        $methodNames = array_map(function (Method $method) {
-            return $method->getName();
-        }, $this->getMethods());
+        $methodNames = [];
+        foreach ($this->getMethods() as $method) {
+            $methodNames[$method->getName()] = true;
+        }
 
         foreach ($this->phpdoc->getTags() as $tag) {
-            if ($tag instanceof MethodTag && in_array($tag->getMethodName(), $methodNames)) {
+            if ($tag instanceof MethodTag && isset($methodNames[$tag->getMethodName()])) {
                 $this->phpdoc->deleteTag($tag);
             }
         }

src/Console/MetaCommand.php

@@ -195,6 +195,18 @@ class MetaCommand extends Command
                 return;
             }
 
+            // Don't throw when class existence is being checked via class_exists(),
+            // interface_exists(), trait_exists(), or enum_exists(). These functions
+            // expect the autoloader to return gracefully when the class doesn't exist.
+            // Throwing here would break libraries that use class_exists() to check for
+            // optional dependencies (e.g. Doctrine ORM checking for removed classes).
+            $existsFunctions = ['class_exists', 'interface_exists', 'trait_exists', 'enum_exists'];
+            foreach (debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 3) as $frame) {
+                if (isset($frame['function']) && in_array($frame['function'], $existsFunctions, true)) {
+                    return;
+                }
+            }
+
             throw new \ReflectionException("Class '$class' not found.");
         };
 

src/Console/ModelsCommand.php

@@ -123,6 +123,14 @@ class ModelsCommand extends Command
     protected $reset;
     protected $phpstorm_noinspections;
     protected $write_model_external_builder_methods;
+    /**
+     * @var array<string, \SplFileObject>
+     */
+    protected $fileCache = [];
+    /**
+     * @var array<string, Context>
+     */
+    protected $contextCache = [];
     /**
      * @var array<string, true>
      */
@@ -526,7 +534,7 @@ class ModelsCommand extends Command
         }
 
         if ($isNullable) {
-            $type .= '|null';
+            $type = $this->wrapIntersectionType($type) . '|null';
         } else {
             $type = str_replace($nullString, '', $type);
         }
@@ -534,6 +542,22 @@ class ModelsCommand extends Command
         return $type;
     }
 
+    /**
+     * Wraps a bare intersection type in parentheses for correct DNF syntax.
+     *
+     * For example, `A&B` becomes `(A&B)` so that adding `|null` produces
+     * `(A&B)|null` instead of the ambiguous `A&B|null`.
+     * Types that are already parenthesized or contain union types are returned as-is.
+     */
+    protected function wrapIntersectionType(string $type): string
+    {
+        if (str_contains($type, '&') && !str_contains($type, '|') && $type[0] !== '(') {
+            return '(' . $type . ')';
+        }
+
+        return $type;
+    }
+
     /**
      * Returns the override type for the give type.
      *
@@ -696,13 +720,16 @@ class ModelsCommand extends Command
                         );
                         $this->setMethod($name, $builder . '<static>|' . $modelName, $args, $comment);
                     }
-                } elseif (in_array($method, ['query', 'newQuery', 'newModelQuery'])) {
-                    $builder = $this->getClassNameInDestinationFile($model, get_class($model->newModelQuery()));
+                } elseif (in_array($method, ['query', 'newQuery', 'newModelQuery'])
+                ) {
+                    if ($this->laravel['config']->get('ide-helper.write_query_methods', true)) {
+                        $builder = $this->getClassNameInDestinationFile($model, get_class($model->newModelQuery()));
 
-                    $this->setMethod(
-                        $method,
-                        $builder . '<static>|' . $this->getClassNameInDestinationFile($model, get_class($model))
-                    );
+                        $this->setMethod(
+                            $method,
+                            $builder . '<static>|' . $this->getClassNameInDestinationFile($model, get_class($model))
+                        );
+                    }
 
                     if ($this->write_model_external_builder_methods) {
                         $this->writeModelExternalBuilderMethods($model);
@@ -721,14 +748,19 @@ class ModelsCommand extends Command
                         $type = (string)$this->getReturnTypeFromDocBlock($reflection);
                     }
 
-                    $file = new \SplFileObject($reflection->getFileName());
+                    $fileName = $reflection->getFileName();
+                    if (!isset($this->fileCache[$fileName])) {
+                        $this->fileCache[$fileName] = new \SplFileObject($fileName);
+                    }
+                    $file = $this->fileCache[$fileName];
                     $file->seek($reflection->getStartLine() - 1);
 
-                    $code = '';
+                    $lines = [];
                     while ($file->key() < $reflection->getEndLine()) {
-                        $code .= $file->current();
+                        $lines[] = $file->current();
                         $file->next();
                     }
+                    $code = implode('', $lines);
                     $code = trim(preg_replace('/\s\s+/', '', $code));
                     $begin = strpos($code, 'function(');
                     $code = substr($code, $begin, strrpos($code, '}') - $begin + 1);
@@ -982,7 +1014,7 @@ class ModelsCommand extends Command
         if ($type !== null) {
             $newType = $this->getTypeOverride($type);
             if ($nullable) {
-                $newType .= '|null';
+                $newType = $this->wrapIntersectionType($newType) . '|null';
             }
             $this->properties[$name]['type'] = $newType;
         }
@@ -1170,6 +1202,14 @@ class ModelsCommand extends Command
                 $replace = "{$modelDocComment}\n";
                 $pos = strpos($contents, "final class {$classname}") ?: strpos($contents, "class {$classname}");
                 if ($pos !== false) {
+                    // If PHP 8 attributes (e.g. #[ObservedBy(...)]) precede the class
+                    // declaration, insert the docblock before the first attribute so that
+                    // the resulting order is: docblock → attributes → class.
+                    $before = substr($contents, 0, $pos);
+                    if (preg_match('/((?:#\[.+?\]\s*)+)$/s', $before, $matches)) {
+                        $pos -= strlen($matches[1]);
+                        $replace = "{$modelDocComment}\n";
+                    }
                     $contents = substr_replace($contents, $replace, $pos, 0);
                 }
             }
@@ -1275,13 +1315,18 @@ class ModelsCommand extends Command
         }
     }
 
+    protected ?array $cachedRelationTypes = null;
+    protected ?array $cachedRelationReturnTypes = null;
+
     /**
      * Returns the available relation types
      */
     protected function getRelationTypes(): array
     {
-        $configuredRelations = $this->laravel['config']->get('ide-helper.additional_relation_types', []);
-        return array_merge(self::RELATION_TYPES, $configuredRelations);
+        return $this->cachedRelationTypes ??= array_merge(
+            self::RELATION_TYPES,
+            $this->laravel['config']->get('ide-helper.additional_relation_types', [])
+        );
     }
 
     /**
@@ -1289,7 +1334,7 @@ class ModelsCommand extends Command
      */
     protected function getRelationReturnTypes(): array
     {
-        return $this->laravel['config']->get('ide-helper.additional_relation_return_types', []);
+        return $this->cachedRelationReturnTypes ??= $this->laravel['config']->get('ide-helper.additional_relation_return_types', []);
     }
 
     /**
@@ -1364,11 +1409,7 @@ class ModelsCommand extends Command
      */
     protected function getCommentFromDocBlock(\ReflectionMethod $reflection)
     {
-        $phpDocContext = (new ContextFactory())->createFromReflector($reflection);
-        $context = new Context(
-            $phpDocContext->getNamespace(),
-            $phpDocContext->getNamespaceAliases()
-        );
+        $context = $this->getDocBlockContext($reflection);
         $comment = '';
         $phpdoc = new DocBlock($reflection, $context);
 
@@ -1389,11 +1430,7 @@ class ModelsCommand extends Command
      */
     protected function getReturnTypeFromDocBlock(\ReflectionMethod $reflection, ?\Reflector $reflectorForContext = null)
     {
-        $phpDocContext = (new ContextFactory())->createFromReflector($reflectorForContext ?? $reflection);
-        $context = new Context(
-            $phpDocContext->getNamespace(),
-            $phpDocContext->getNamespaceAliases()
-        );
+        $context = $this->getDocBlockContext($reflectorForContext ?? $reflection);
         $type = null;
         $phpdoc = new DocBlock($reflection, $context);
 
@@ -1411,6 +1448,31 @@ class ModelsCommand extends Command
         return $type;
     }
 
+    protected function getDocBlockContext(\Reflector $reflector): Context
+    {
+        if ($reflector instanceof \ReflectionMethod) {
+            $key = $reflector->getDeclaringClass()->getName();
+        } elseif ($reflector instanceof ReflectionClass) {
+            $key = $reflector->getName();
+        } else {
+            $phpDocContext = (new ContextFactory())->createFromReflector($reflector);
+            return new Context(
+                $phpDocContext->getNamespace(),
+                $phpDocContext->getNamespaceAliases()
+            );
+        }
+
+        if (!isset($this->contextCache[$key])) {
+            $phpDocContext = (new ContextFactory())->createFromReflector($reflector);
+            $this->contextCache[$key] = new Context(
+                $phpDocContext->getNamespace(),
+                $phpDocContext->getNamespaceAliases()
+            );
+        }
+
+        return $this->contextCache[$key];
+    }
+
     protected function getReturnTypeFromReflection(\ReflectionMethod $reflection): ?string
     {
         $returnType = $reflection->getReturnType();
@@ -1616,9 +1678,10 @@ class ModelsCommand extends Command
      */
     protected function getUsedClassNames(ReflectionClass $reflection): array
     {
+        $context = $this->getDocBlockContext($reflection);
         $namespaceAliases = array_flip(array_map(function ($alias) {
             return ltrim($alias, '\\');
-        }, (new ContextFactory())->createFromReflector($reflection)->getNamespaceAliases()));
+        }, $context->getNamespaceAliases()));
         $namespaceAliases[$reflection->getName()] = $reflection->getShortName();
 
         return $namespaceAliases;

tests/Console/ModelsCommand/MorphToIntersection/Models/BaseModel.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\MorphToIntersection\Models;
+
+use Illuminate\Database\Eloquent\Model;
+
+abstract class BaseModel extends Model
+{
+}

tests/Console/ModelsCommand/MorphToIntersection/Models/CanBeAssigned.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\MorphToIntersection\Models;
+
+interface CanBeAssigned
+{
+}

tests/Console/ModelsCommand/MorphToIntersection/Models/MorphToIntersection.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\MorphToIntersection\Models;
+
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\MorphTo;
+
+class MorphToIntersection extends Model
+{
+    protected $table = 'morphs';
+
+    /** @return MorphTo<(BaseModel&CanBeAssigned), $this> */
+    public function assigneeWithParens(): MorphTo
+    {
+        return $this->morphTo(type: 'nullable_relation_morph_to_type', id: 'nullable_relation_morph_to_id');
+    }
+
+    /** @return MorphTo<BaseModel&CanBeAssigned, $this> */
+    public function assigneeWithoutParens(): MorphTo
+    {
+        return $this->morphTo(type: 'nullable_relation_morph_to_type', id: 'nullable_relation_morph_to_id');
+    }
+
+    /** @return MorphTo<(BaseModel&CanBeAssigned), $this> */
+    public function nonNullableAssignee(): MorphTo
+    {
+        return $this->morphTo(type: 'relation_morph_to_type', id: 'relation_morph_to_id');
+    }
+}

tests/Console/ModelsCommand/MorphToIntersection/Test.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\MorphToIntersection;
+
+use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
+use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AbstractModelsCommand;
+
+class Test extends AbstractModelsCommand
+{
+    public function test(): void
+    {
+        $command = $this->app->make(ModelsCommand::class);
+
+        $tester = $this->runCommand($command, [
+            '--write' => true,
+        ]);
+
+        $this->assertSame(0, $tester->getStatusCode());
+        $this->assertStringContainsString('Written new phpDocBlock to', $tester->getDisplay());
+        $this->assertMatchesMockedSnapshot();
+    }
+}

tests/Console/ModelsCommand/MorphToIntersection/__snapshots__/Test__test__1.php

@@ -0,0 +1,48 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\MorphToIntersection\Models;
+
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\MorphTo;
+
+/**
+ * @property string $relation_morph_to_type
+ * @property int $relation_morph_to_id
+ * @property string|null $nullable_relation_morph_to_type
+ * @property int|null $nullable_relation_morph_to_id
+ * @property-read (BaseModel&CanBeAssigned)|null $assigneeWithParens
+ * @property-read (BaseModel&CanBeAssigned)|null $assigneeWithoutParens
+ * @property-read (BaseModel&CanBeAssigned) $nonNullableAssignee
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|MorphToIntersection newModelQuery()
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|MorphToIntersection newQuery()
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|MorphToIntersection query()
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|MorphToIntersection whereNullableRelationMorphToId($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|MorphToIntersection whereNullableRelationMorphToType($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|MorphToIntersection whereRelationMorphToId($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|MorphToIntersection whereRelationMorphToType($value)
+ * @mixin \Eloquent
+ */
+class MorphToIntersection extends Model
+{
+    protected $table = 'morphs';
+
+    /** @return MorphTo<(BaseModel&CanBeAssigned), $this> */
+    public function assigneeWithParens(): MorphTo
+    {
+        return $this->morphTo(type: 'nullable_relation_morph_to_type', id: 'nullable_relation_morph_to_id');
+    }
+
+    /** @return MorphTo<BaseModel&CanBeAssigned, $this> */
+    public function assigneeWithoutParens(): MorphTo
+    {
+        return $this->morphTo(type: 'nullable_relation_morph_to_type', id: 'nullable_relation_morph_to_id');
+    }
+
+    /** @return MorphTo<(BaseModel&CanBeAssigned), $this> */
+    public function nonNullableAssignee(): MorphTo
+    {
+        return $this->morphTo(type: 'relation_morph_to_type', id: 'relation_morph_to_id');
+    }
+}

tests/Console/ModelsCommand/PhpAttributesBeforeClass/Models/FinalWithNested.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\PhpAttributesBeforeClass\Models;
+
+use Illuminate\Database\Eloquent\Model;
+
+// Tests: final class + attribute with nested array argument (e.g. ObservedBy([...]))
+#[ObservedByStub([StubObserver::class])]
+final class FinalWithNested extends Model
+{
+    protected $table = 'simples';
+}

tests/Console/ModelsCommand/PhpAttributesBeforeClass/Models/MultipleAttributes.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\PhpAttributesBeforeClass\Models;
+
+use Illuminate\Database\Eloquent\Model;
+
+// Tests: multiple consecutive PHP 8 attributes before the class declaration
+#[\AllowDynamicProperties]
+#[SecondAttribute]
+class MultipleAttributes extends Model
+{
+    protected $table = 'simples';
+}

tests/Console/ModelsCommand/PhpAttributesBeforeClass/Models/Simple.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\PhpAttributesBeforeClass\Models;
+
+use Illuminate\Database\Eloquent\Model;
+
+#[\AllowDynamicProperties]
+class Simple extends Model
+{
+}

tests/Console/ModelsCommand/PhpAttributesBeforeClass/Test.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\PhpAttributesBeforeClass;
+
+use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
+use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AbstractModelsCommand;
+
+class Test extends AbstractModelsCommand
+{
+    public function test(): void
+    {
+        $command = $this->app->make(ModelsCommand::class);
+
+        $tester = $this->runCommand($command, [
+            '--write' => true,
+        ]);
+
+        $this->assertSame(0, $tester->getStatusCode());
+        $this->assertStringContainsString('Written new phpDocBlock to', $tester->getDisplay());
+        $this->assertMatchesMockedSnapshot();
+    }
+}

tests/Console/ModelsCommand/PhpAttributesBeforeClass/__snapshots__/Test__test__1.php

@@ -0,0 +1,65 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\PhpAttributesBeforeClass\Models;
+
+use Illuminate\Database\Eloquent\Model;
+
+// Tests: final class + attribute with nested array argument (e.g. ObservedBy([...]))
+/**
+ * @property int $id
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|FinalWithNested newModelQuery()
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|FinalWithNested newQuery()
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|FinalWithNested query()
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|FinalWithNested whereId($value)
+ * @mixin \Eloquent
+ */
+#[ObservedByStub([StubObserver::class])]
+final class FinalWithNested extends Model
+{
+    protected $table = 'simples';
+}
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\PhpAttributesBeforeClass\Models;
+
+use Illuminate\Database\Eloquent\Model;
+
+// Tests: multiple consecutive PHP 8 attributes before the class declaration
+/**
+ * @property int $id
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|MultipleAttributes newModelQuery()
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|MultipleAttributes newQuery()
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|MultipleAttributes query()
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|MultipleAttributes whereId($value)
+ * @mixin \Eloquent
+ */
+#[\AllowDynamicProperties]
+#[SecondAttribute]
+class MultipleAttributes extends Model
+{
+    protected $table = 'simples';
+}
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\PhpAttributesBeforeClass\Models;
+
+use Illuminate\Database\Eloquent\Model;
+
+/**
+ * @property int $id
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Simple newModelQuery()
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Simple newQuery()
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Simple query()
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Simple whereId($value)
+ * @mixin \Eloquent
+ */
+#[\AllowDynamicProperties]
+class Simple extends Model
+{
+}

tests/Console/ModelsCommand/QueryMethods/Models/Post.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\QueryMethods\Models;
+
+use Illuminate\Database\Eloquent\Model;
+
+class Post extends Model
+{
+}

tests/Console/ModelsCommand/QueryMethods/Test.php

@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\QueryMethods;
+
+use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
+use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AbstractModelsCommand;
+
+class Test extends AbstractModelsCommand
+{
+    protected function getEnvironmentSetUp($app)
+    {
+        parent::getEnvironmentSetUp($app);
+
+        $app['config']->set('ide-helper.write_query_methods', false);
+    }
+
+    public function test(): void
+    {
+        $command = $this->app->make(ModelsCommand::class);
+
+        $tester = $this->runCommand($command, [
+            '--write' => true,
+        ]);
+
+        $this->assertSame(0, $tester->getStatusCode());
+        $this->assertStringContainsString('Written new phpDocBlock to', $tester->getDisplay());
+        $this->assertMatchesMockedSnapshot();
+        $this->assertStringNotContainsString("@method static \Illuminate\Database\Eloquent\Builder<static>|Post query()", $this->mockFilesystemOutput);
+    }
+}

tests/Console/ModelsCommand/QueryMethods/__snapshots__/Test__test__1.php

@@ -0,0 +1,156 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\QueryMethods\Models;
+
+use Illuminate\Database\Eloquent\Model;
+
+/**
+ * @property int $id
+ * @property string|null $char_nullable
+ * @property string $char_not_nullable
+ * @property string|null $string_nullable
+ * @property string $string_not_nullable
+ * @property string|null $text_nullable
+ * @property string $text_not_nullable
+ * @property string|null $medium_text_nullable
+ * @property string $medium_text_not_nullable
+ * @property string|null $long_text_nullable
+ * @property string $long_text_not_nullable
+ * @property int|null $integer_nullable
+ * @property int $integer_not_nullable
+ * @property int|null $tiny_integer_nullable
+ * @property int $tiny_integer_not_nullable
+ * @property int|null $small_integer_nullable
+ * @property int $small_integer_not_nullable
+ * @property int|null $medium_integer_nullable
+ * @property int $medium_integer_not_nullable
+ * @property int|null $big_integer_nullable
+ * @property int $big_integer_not_nullable
+ * @property int|null $unsigned_integer_nullable
+ * @property int $unsigned_integer_not_nullable
+ * @property int|null $unsigned_tiny_integer_nullable
+ * @property int $unsigned_tiny_integer_not_nullable
+ * @property int|null $unsigned_small_integer_nullable
+ * @property int $unsigned_small_integer_not_nullable
+ * @property int|null $unsigned_medium_integer_nullable
+ * @property int $unsigned_medium_integer_not_nullable
+ * @property int|null $unsigned_big_integer_nullable
+ * @property int $unsigned_big_integer_not_nullable
+ * @property float|null $float_nullable
+ * @property float $float_not_nullable
+ * @property float|null $double_nullable
+ * @property float $double_not_nullable
+ * @property numeric|null $decimal_nullable
+ * @property numeric $decimal_not_nullable
+ * @property int|null $boolean_nullable
+ * @property int $boolean_not_nullable
+ * @property string|null $enum_nullable
+ * @property string $enum_not_nullable
+ * @property string|null $json_nullable
+ * @property string $json_not_nullable
+ * @property string|null $jsonb_nullable
+ * @property string $jsonb_not_nullable
+ * @property string|null $date_nullable
+ * @property string $date_not_nullable
+ * @property string|null $datetime_nullable
+ * @property string $datetime_not_nullable
+ * @property string|null $datetimetz_nullable
+ * @property string $datetimetz_not_nullable
+ * @property string|null $time_nullable
+ * @property string $time_not_nullable
+ * @property string|null $timetz_nullable
+ * @property string $timetz_not_nullable
+ * @property string|null $timestamp_nullable
+ * @property string $timestamp_not_nullable
+ * @property string|null $timestamptz_nullable
+ * @property string $timestamptz_not_nullable
+ * @property int|null $year_nullable
+ * @property int $year_not_nullable
+ * @property string|null $binary_nullable
+ * @property string $binary_not_nullable
+ * @property string|null $uuid_nullable
+ * @property string $uuid_not_nullable
+ * @property string|null $ipaddress_nullable
+ * @property string $ipaddress_not_nullable
+ * @property string|null $macaddress_nullable
+ * @property string $macaddress_not_nullable
+ * @property \Illuminate\Support\Carbon|null $created_at
+ * @property \Illuminate\Support\Carbon|null $updated_at
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereBigIntegerNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereBigIntegerNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereBinaryNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereBinaryNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereBooleanNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereBooleanNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereCharNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereCharNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereCreatedAt($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDateNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDateNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDatetimeNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDatetimeNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDatetimetzNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDatetimetzNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDecimalNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDecimalNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDoubleNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDoubleNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereEnumNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereEnumNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereFloatNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereFloatNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereId($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereIntegerNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereIntegerNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereIpaddressNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereIpaddressNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereJsonNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereJsonNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereJsonbNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereJsonbNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereLongTextNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereLongTextNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereMacaddressNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereMacaddressNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereMediumIntegerNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereMediumIntegerNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereMediumTextNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereMediumTextNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereSmallIntegerNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereSmallIntegerNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereStringNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereStringNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTextNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTextNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTimeNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTimeNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTimestampNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTimestampNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTimestamptzNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTimestamptzNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTimetzNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTimetzNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTinyIntegerNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTinyIntegerNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedBigIntegerNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedBigIntegerNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedIntegerNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedIntegerNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedMediumIntegerNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedMediumIntegerNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedSmallIntegerNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedSmallIntegerNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedTinyIntegerNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedTinyIntegerNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUpdatedAt($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUuidNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUuidNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereYearNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereYearNullable($value)
+ * @mixin \Eloquent
+ */
+class Post extends Model
+{
+}