fix(pivot): only use unique classes in the pivot union (Fixes #1606) (#1607)

* fix(pivot): only use unique classes in the pivot union (Fixes #1606)

* composer fix-style

---------

Co-authored-by: laravel-ide-helper <[email protected]>

.gitattributes

@@ -2,9 +2,14 @@
 # https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html
 
 # Ignore all test and documentation with "export-ignore".
-/.gitattributes     export-ignore
-/.gitignore         export-ignore
-/.travis.yml        export-ignore
-/phpunit.xml.dist   export-ignore
-/.scrutinizer.yml   export-ignore
-/tests              export-ignore
+/.editorconfig                export-ignore
+/.gitattributes               export-ignore
+/.github                      export-ignore
+/.gitignore                   export-ignore
+/.php-cs-fixer.cache          export-ignore
+/.php-cs-fixer.php            export-ignore
+/.php-cs-fixer.tests.cache    export-ignore
+/phpunit.xml.dist             export-ignore
+/psalm-baseline.xml           export-ignore
+/psalm.xml                    export-ignore
+/tests                        export-ignore

.github/FUNDING.yml

@@ -0,0 +1,5 @@
+# These are supported funding model platforms
+
+github: barryvdh
+custom: ['https://fruitcake.nl']
+

.github/ISSUE_TEMPLATE/1_Bug_report.md

@@ -0,0 +1,23 @@
+---
+name: "🐛 Bug Report"
+about: 'Report a general bug.'
+labels: bug
+
+---
+
+### Versions:
+- ide-helper Version: #.#.#
+- Laravel Version: #.#.# <!-- remove if not applicable -->
+- PHP Version: #.#.#
+
+### Description:
+
+<!--
+Please describe in detail the nature of the bug, code samples, etc.
+
+The more, the better.
+-->
+
+### Steps To Reproduce:
+
+- …

.github/ISSUE_TEMPLATE/2_Feature_request.md

@@ -0,0 +1,12 @@
+---
+name: "✨ Feature request"
+about: 'Suggest a new feature or other improvements.'
+labels: enhancement
+
+---
+
+### Summary
+
+<!--
+Describe in detail what you propose, show (preferable) code examples and also signal if you're willing to work on it!
+-->

.github/ISSUE_TEMPLATE/3_Support_question.md

@@ -0,0 +1,14 @@
+---
+name: "🙋🏼‍♂️ Support question"
+about: 'I need assistance or clarification on usage of this library.'
+labels: question
+
+---
+
+### Versions:
+- ide-helper Version: #.#.#
+- Laravel Version: #.#.# <!-- remove if not applicable -->
+- PHP Version: #.#.#
+
+### Question:
+

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,17 @@
+## Summary
+<!-- Please provide an exhaustive description. -->
+
+## Type of change
+
+<!-- Please delete options that are not relevant. -->
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] This change requires a documentation update
+- [ ] Misc. change (internal, infrastructure, maintenance, etc.)
+
+### Checklist
+- [ ] Existing tests have been adapted and/or new tests have been added
+- [ ] Update the README.md
+- [ ] Code style has been fixed via `composer fix-style`

.github/dependabot.yaml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: monthly
+    groups:
+      deps:
+        patterns:
+          - '*'

.github/release-drafter.yml

@@ -0,0 +1,4 @@
+template: |
+  ## What’s Changed
+
+  $CHANGES

.github/stale.yml

@@ -0,0 +1,24 @@
+# Number of days of inactivity before an issue becomes stale
+daysUntilStale: 90
+# Number of days of inactivity before a stale issue is closed
+daysUntilClose: 60
+# Issues with these labels will never be considered stale
+exemptLabels:
+  - bug
+  - enhancement
+  - discussion
+# Label to use when marking an issue as stale
+staleLabel: stale
+# Comment to post when marking an issue as stale. Set to `false` to disable
+markComment: >
+  This issue has been automatically marked as stale because it has not had
+  recent activity. It will be closed if no further activity occurs. 
+  
+  If this issue is still present on the latest version of this library on supported Laravel versions, 
+  please let us know by replying to this issue so we can investigate further.
+  
+  Thank you for your contribution! Apologies for any delayed response on our side.
+# Comment to post when closing a stale issue. Set to `false` to disable
+closeComment: false
+# Limit to only `issues` or `pulls`
+only: issues

.github/workflows/composer-normalize.yml

@@ -0,0 +1,28 @@
+name: normalize composer.json
+
+on:
+  push:
+    paths:
+      - .github/workflows/composer-normalize.yml
+      - composer.json
+
+jobs:
+  normalize:
+    timeout-minutes: 15
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Git checkout
+        uses: actions/checkout@v4
+
+      - name: Validate Composer configuration
+        run: composer validate --strict
+
+      - name: Normalize composer.json
+        run: |
+          composer global config --no-plugins allow-plugins.ergebnis/composer-normalize true
+          composer global require ergebnis/composer-normalize
+          composer normalize
+
+      - uses: stefanzweifel/git-auto-commit-action@v5
+        with:
+          commit_message: normalize composer.json

.github/workflows/fix-code-style.yml

@@ -0,0 +1,33 @@
+name: Fix Code Style
+
+on:
+  push:
+
+jobs:
+  fix-style:
+    name: Fix Code Style
+    timeout-minutes: 15
+    runs-on: ubuntu-22.04
+    env:
+      COMPOSER_NO_INTERACTION: 1
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.3
+          coverage: none
+
+      - name: Install dependencies
+        run: composer update --prefer-dist --no-progress
+
+      - run: composer fix-style
+        continue-on-error: true
+
+      - uses: stefanzweifel/git-auto-commit-action@v5
+        with:
+          commit_message: composer fix-style
+          commit_author: laravel-ide-helper <[email protected]>

.github/workflows/release-drafter.yml

@@ -0,0 +1,41 @@
+name: Release Drafter
+
+on:
+  push:
+    # branches to consider in the event; optional, defaults to all
+    branches:
+      - master
+  # pull_request event is required only for autolabeler
+  pull_request:
+    # Only following types are handled by the action, but one can default to all as well
+    types: [opened, reopened, synchronize]
+  # pull_request_target event is required for autolabeler to support PRs from forks
+  # pull_request_target:
+  #   types: [opened, reopened, synchronize]
+
+permissions:
+  contents: read
+
+jobs:
+  update_release_draft:
+    permissions:
+      # write permission is required to create a github release
+      contents: write
+      # write permission is required for autolabeler
+      # otherwise, read permission is required at least
+      pull-requests: write
+    runs-on: ubuntu-latest
+    steps:
+      # (Optional) GitHub Enterprise requires GHE_HOST variable set
+      #- name: Set GHE_HOST
+      #  run: |
+      #    echo "GHE_HOST=${GITHUB_SERVER_URL##https:\/\/}" >> $GITHUB_ENV
+
+      # Drafts your next Release notes as Pull Requests are merged into "master"
+      - uses: release-drafter/release-drafter@v6
+        # (Optional) specify config name to use, relative to .github/. Default: release-drafter.yml
+        # with:
+        #   config-name: my-config.yml
+        #   disable-autolabeler: true
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

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

@@ -0,0 +1,75 @@
+name: Integration Tests
+
+on:
+    push:
+        branches:
+            - master
+    pull_request:
+        branches:
+            - "*"
+    schedule:
+        - cron: '0 0 * * *'
+
+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.15]
+
+        name: P${{ matrix.php }} - Laravel${{ matrix.laravel }}
+        steps:
+            - name: Checkout code
+              uses: actions/checkout@v4
+              with:
+                  path: src
+
+            - name: Setup PHP
+              uses: shivammathur/setup-php@v2
+              with:
+                  php-version: ${{ matrix.php }}
+                  coverage: none
+
+            - 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: 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-static-analysis.yml

@@ -0,0 +1,28 @@
+name: Run Static Analysis
+
+on:
+    push:
+    pull_request:
+    schedule:
+        - cron: '0 0 * * *'
+
+jobs:
+    build:
+        timeout-minutes: 15
+        runs-on: ubuntu-22.04
+
+        steps:
+            - uses: actions/checkout@v4
+
+            - name: Setup PHP
+              uses: shivammathur/setup-php@v2
+              with:
+                php-version: 8.3
+                coverage: none
+                extensions: pdo_sqlite
+
+            - name: Install dependencies
+              run: composer install --prefer-dist --no-progress --no-suggest
+
+            - name: Analyze
+              run: composer analyze

.github/workflows/run-tests.yml

@@ -0,0 +1,52 @@
+name: Tests
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - "*"
+  schedule:
+  - cron: '0 0 * * *'
+
+jobs:
+  php-tests:
+    runs-on: ${{ matrix.os }}
+    timeout-minutes: 15
+    env:
+      COMPOSER_NO_INTERACTION: 1
+
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-22.04, windows-2019]
+        php: [8.4, 8.3, 8.2]
+        laravel: [^11.15]
+        stability: [prefer-lowest, prefer-stable]
+    steps:
+    - name: Set git to use LF
+      if: ${{ matrix.os == 'windows-2019' }}
+      run: |
+        git config --global core.autocrlf false
+        git config --global core.eol lf
+
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - 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: Execute Unit Tests
+      run: composer test-ci

.github/workflows/update-changelog.yaml

@@ -0,0 +1,34 @@
+name: "Update Changelog"
+
+on:
+  release:
+    types: [released]
+
+jobs:
+  update:
+    runs-on: ubuntu-latest
+
+    permissions:
+      # Give the default GITHUB_TOKEN write permission to commit and push the 
+      # updated CHANGELOG back to the repository.
+      # https://github.blog/changelog/2023-02-02-github-actions-updating-the-default-github_token-permissions-to-read-only/
+      contents: write
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.release.target_commitish }}
+
+      - name: Update Changelog
+        uses: stefanzweifel/changelog-updater-action@v1
+        with:
+          latest-version: ${{ github.event.release.tag_name }}
+          release-notes: ${{ github.event.release.body }}
+
+      - name: Commit updated CHANGELOG
+        uses: stefanzweifel/git-auto-commit-action@v5
+        with:
+          branch: ${{ github.event.release.target_commitish }}
+          commit_message: Update CHANGELOG
+          file_pattern: CHANGELOG.md

.gitignore

@@ -1,4 +1,8 @@
-build
-vendor
-composer.lock
-.idea
+.phpunit.result.cache
+
+/.idea
+/.php-cs-fixer.cache
+/.php-cs-fixer.php
+/.php-cs-fixer.tests.cache
+/composer.lock
+/vendor

.php-cs-fixer.common.php

@@ -0,0 +1,62 @@
+<?php
+
+// Share common rules between non-test and test files
+return [
+    '@PSR12' => true,
+    'blank_line_after_opening_tag' => true,
+    'braces' => [
+        'allow_single_line_anonymous_class_with_empty_body' => true,
+    ],
+    'compact_nullable_typehint' => true,
+    'declare_equal_normalize' => true,
+    'lowercase_cast' => true,
+    'lowercase_static_reference' => true,
+    'new_with_braces' => true,
+    'no_blank_lines_after_class_opening' => true,
+    'no_leading_import_slash' => true,
+    'no_whitespace_in_blank_line' => true,
+    'ordered_class_elements' => [
+        'order' => [
+            'use_trait',
+        ],
+    ],
+    'ordered_imports' => [
+        'imports_order' => [
+            'class',
+            'function',
+            'const',
+        ],
+        'sort_algorithm' => 'alpha',
+    ],
+    'return_type_declaration' => true,
+    'short_scalar_cast' => true,
+    'single_trait_insert_per_statement' => true,
+    'ternary_operator_spaces' => true,
+    'visibility_required' => [
+        'elements' => [
+            'const',
+            'method',
+            'property',
+        ],
+    ],
+
+    // Further quality-of-life improvements
+    'array_syntax' => [
+        'syntax' => 'short',
+    ],
+    'concat_space' => [
+        'spacing' => 'one',
+    ],
+    'fully_qualified_strict_types' => true,
+    'native_function_invocation' => [
+        'include' => [],
+        'strict' => true,
+    ],
+    'no_unused_imports' => true,
+    'single_quote' => true,
+    'space_after_semicolon' => true,
+    'trailing_comma_in_multiline' => true,
+    'trim_array_spaces' => true,
+    'unary_operator_spaces' => true,
+    'whitespace_after_comma_in_array' => true,
+];

.php-cs-fixer.dist.php

@@ -0,0 +1,14 @@
+<?php
+require __DIR__ . '/vendor/autoload.php';
+
+$finder = PhpCsFixer\Finder::create()
+    ->in(__DIR__)
+    ->exclude('tests');
+
+$config = require __DIR__ . '/.php-cs-fixer.common.php';
+
+return (new PhpCsFixer\Config())
+    ->setFinder($finder)
+    ->setRules($config)
+    ->setRiskyAllowed(true)
+    ->setCacheFile(__DIR__ . '/.php-cs-fixer.cache');

.php-cs-fixer.tests.php

@@ -0,0 +1,22 @@
+<?php
+require __DIR__ . '/vendor/autoload.php';
+
+$finder = PhpCsFixer\Finder::create()
+    ->in(__DIR__ . '/tests')
+    ->exclude('__snapshots__');
+
+$config = require __DIR__ . '/.php-cs-fixer.common.php';
+
+// Additional rules for tests
+$config = array_merge(
+    $config,
+    [
+        'declare_strict_types' => true,
+    ]
+);
+
+return (new PhpCsFixer\Config())
+    ->setFinder($finder)
+    ->setRules($config)
+    ->setRiskyAllowed(true)
+    ->setCacheFile(__DIR__ . '/.php-cs-fixer.tests.cache');

.scrutinizer.yml

@@ -1,23 +0,0 @@
-filter:
-    excluded_paths: [tests/*]
-
-checks:
-    php:
-        remove_extra_empty_lines: true
-        remove_php_closing_tag: true
-        remove_trailing_whitespace: true
-        fix_use_statements:
-            remove_unused: true
-            preserve_multiple: false
-            preserve_blanklines: true
-            order_alphabetically: true
-        fix_php_opening_tag: true
-        fix_linefeed: true
-        fix_line_ending: true
-        fix_identation_4spaces: true
-        fix_doc_comments: true
-
-tools:
-    external_code_coverage:
-        timeout: 600
-        runs: 3

.styleci.yml

@@ -1 +0,0 @@
-preset: psr2

.travis.yml

@@ -1,31 +0,0 @@
-language: php
-
-php:
-  - 5.5
-  - 5.6
-  - 7.0
-  - hhvm
-
-# This triggers builds to run on the new TravisCI infrastructure.
-# See: http://docs.travis-ci.com/user/workers/container-based-infrastructure/
-sudo: false
-
-## Cache composer
-cache:
-  directories:
-    - $HOME/.composer/cache
-
-matrix:
-  include:
-    - php: 5.5
-      env: 'COMPOSER_FLAGS="--prefer-stable --prefer-lowest"'
-
-before_script:
-  - travis_retry composer update ${COMPOSER_FLAGS} --no-interaction --prefer-dist
-
-script:
-  - vendor/bin/phpcs --standard=psr2 src/
-  - vendor/bin/phpunit --coverage-text --coverage-clover=coverage.clover
-
-after_script:
-  - if [[ $TRAVIS_PHP_VERSION != 'hhvm' && $TRAVIS_PHP_VERSION != '7.0' ]]; then php vendor/bin/ocular code-coverage:upload --format=php-clover coverage.clover; fi

CHANGELOG.md

@@ -0,0 +1,294 @@
+# Changelog
+
+## 3.2.1 - 2024-10-28
+
+### What's Changed
+* chore: Fix the description of unused option by @KentarouTakeda in https://github.com/barryvdh/laravel-ide-helper/pull/1600
+* feat(pivot): add support for multiple pivot types when using the same accessor by @pataar in https://github.com/barryvdh/laravel-ide-helper/pull/1597
+* Add support for `AsCollection::using` and `AsEnumCollection::of` casts by @uno-sw in https://github.com/barryvdh/laravel-ide-helper/pull/1577
+* Smarter reset by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1603
+* feat: use `numeric` type on fields with `decimal` casts by @ekisu in https://github.com/barryvdh/laravel-ide-helper/pull/1583
+
+### New Contributors
+* @uno-sw made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1577
+* @ekisu made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1583
+
+**Full Changelog**: https://github.com/barryvdh/laravel-ide-helper/compare/v3.2.0...v3.2.1
+
+## 3.2.0 - 2024-10-18
+
+### Fixed
+- Fix type of hashed model property to `string`
+
+### Changed
+- 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)
+
+## 3.1.0 - 2024-07-12
+
+### Fixed
+- Fix return value of query scopes from parent class [#1366 / sforward](https://github.com/barryvdh/laravel-ide-helper/pull/1366)
+- Add static to isBuiltin() check in ide-helper:models [#1541 / bram-pkg](https://github.com/barryvdh/laravel-ide-helper/pull/1541)
+- Fix for getSomethingAttribute functions which return a collection with type templating in the phpDoc. [#1567 / stefanScrumble](https://github.com/barryvdh/laravel-ide-helper/pull/1567)
+
+### Added
+ - Add type to pivot when using a custom pivot class [#1518 / d3v2a](https://github.com/barryvdh/laravel-ide-helper/pull/1518)
+ - Add support in morphTo relationship for null values [#1547 / matysekmichal](https://github.com/barryvdh/laravel-ide-helper/pull/1547)
+ - Add support for AsEnumCollection casts [#1557 / Braunson](https://github.com/barryvdh/laravel-ide-helper/pull/1557)
+ - Support for Attribute class in attributes [#1567 / stefanScrumble](https://github.com/barryvdh/laravel-ide-helper/pull/1567)
+
+## 3.0.0 - 2024-03-01
+
+### Added
+- Support for Laravel 11 [#1520 / KentarouTakeda](https://github.com/barryvdh/laravel-ide-helper/pull/1520)
+
+### Changed
+- Make `--reset` always keep the text and remove `--smart-reset`. Always skip the classname [#1523 / barryvdh](https://github.com/barryvdh/laravel-ide-helper/pull/1523) & [#1525 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/1525)
+- Use short types (`int` and `bool` instead of `integer` and `boolean`) [#1524 / barryvdh](https://github.com/barryvdh/laravel-ide-helper/pull/1524)
+
+### Removed
+- Support for Laravel 9 and use of doctrine/dbal [#1512 / barryvdh](https://github.com/barryvdh/laravel-ide-helper/pull/1512)
+  With this functionality gone, a few changes have been made:
+  - support for custom datatypes has been dropped (config `custom_db_types`) unknown data types default to `string` now and to fix the type, add a proper cast in Eloquent
+  - You _might_ have top-level dependency on doctrine/dbal. This may have been in the past due to ide-helper, we suggest to check if you still need it and remove it otherwise
+  - Minimum PHP version, due to Laravel 10, is now PHP 8.1
+
+2024-02-15, 2.15.1
+------------------
+
+### Fixed
+- Fix final class keyword in wrong position [#1517 / barryvdh](https://github.com/barryvdh/laravel-ide-helper/pull/1517)
+
+### Changed
+
+### Added
+
+2024-02-14, 2.15.0
+------------------
+### Fixed
+- Fix case issue in `ModelsCommand::unsetMethod()` [#1453 / leo108](https://github.com/barryvdh/laravel-ide-helper/pull/1453)
+- Fix non-facade classes will result in no autocomplete [#841 / netpok](https://github.com/barryvdh/laravel-ide-helper/pull/841)
+- Skip swoole, otherwise fatal error [#1477 / TimoFrenzel](https://github.com/barryvdh/laravel-ide-helper/pull/1477)
+- Fix vulnerability CVE-2021-43608 [#1392 / allanlaal](https://github.com/barryvdh/laravel-ide-helper/pull/1392)
+- Reset foreignKeyConstraintsColumns on model loop start [#1461 / snmatsui](https://github.com/barryvdh/laravel-ide-helper/pull/1461)
+- Accept scope & scopes as relation [#1452 / Muetze42](https://github.com/barryvdh/laravel-ide-helper/pull/1452)
+- Fix #1300 relation_return_type must take precedence if it is defined [#1394 / menthol](https://github.com/barryvdh/laravel-ide-helper/pull/1394)
+
+### Changed
+- Disable inspections of helper files [#1486 / eidng8](https://github.com/barryvdh/laravel-ide-helper/pull/1486)
+- Removed support for Laravel 8 and therefore for PHP < 8.0 [#1504 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/1504)
+
+### Added
+- Add support for enum default arguments using enum cases. [#1464 / d8vjork](https://github.com/barryvdh/laravel-ide-helper/pull/1464)
+- Add support for real-time facades in the helper file. [#1455 / filipac](https://github.com/barryvdh/laravel-ide-helper/pull/1455)
+- Add support for relations with composite keys. [#1479 / calebdw](https://github.com/barryvdh/laravel-ide-helper/pull/1479)
+- Add support for attribute accessors with no backing field or type hinting [#1411 / pindab0ter](https://github.com/barryvdh/laravel-ide-helper/pull/1411).
+- Add support for AsCollection and AsArrayObject casts [#1393 / pataar](https://github.com/barryvdh/laravel-ide-helper/pull/1393)
+- Reintroduce support for multi-db setups [#1426 / benpoulson](https://github.com/barryvdh/laravel-ide-helper/pull/1426)
+- Support the BINARY(...) database field type [#1434 / Sfonxs](https://github.com/barryvdh/laravel-ide-helper/pull/1434)
+- Add AllowDynamicProperties Attribute to cooperate with php8.2 deprecation [#1428 / GeoSot](https://github.com/barryvdh/laravel-ide-helper/pull/1428)
+
+2024-02-05, 2.14.0
+------------------
+
+### Changed
+- Official support for Lumen has been dropped [#1425 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/1425)
+- Refactor resolving of null information for custom casted attribute types [#1330 / wimski](https://github.com/barryvdh/laravel-ide-helper/pull/1330)
+
+### Fixed
+- Catch exceptions when loading aliases [#1465 / dongm2ez](https://github.com/barryvdh/laravel-ide-helper/pull/1465)
+
+### Added
+- Add support for nikic/php-parser 5 (next to 4) [#1502 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/1502)
+- Add support for `immutable_date:*` and `immutable_datetime:*` casts. [#1380 / thekonz](https://github.com/barryvdh/laravel-ide-helper/pull/1380)
+- Add support for attribute accessors marked as protected. [#1339 / pindab0ter](https://github.com/barryvdh/laravel-ide-helper/pull/1339)
+
+2023-02-04, 2.13.0
+------------------
+
+### Fixed
+- Fix return type of methods provided by `SoftDeletes` [#1345 / KentarouTakeda](https://github.com/barryvdh/laravel-ide-helper/pull/1345)
+- Handle PHP 8.1 deprecation warnings when passing `null` to `new \ReflectionClass` [#1351 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/1351)
+- Fix issue where \Eloquent is not included when using write_mixin [#1352 / Jefemy](https://github.com/barryvdh/laravel-ide-helper/pull/1352)
+- Fix model factory method arguments for Laravel >= 9 [#1361 / wimski](https://github.com/barryvdh/laravel-ide-helper/pull/1361)
+- Improve return type of mock helper methods in tests [#1405 / bentleyo](https://github.com/barryvdh/laravel-ide-helper/pull/1405)
+- Fix Castable class if failed to detect it from return types [#1388 / kwarcu](https://github.com/barryvdh/laravel-ide-helper/pull/1388)
+
+### Added
+- Added Laravel 10 support [#1407 / lptn](https://github.com/barryvdh/laravel-ide-helper/pull/1407)
+- Add support for custom casts that implement `CastsInboundAttributes` [#1329 / sforward](https://github.com/barryvdh/laravel-ide-helper/pull/1329)
+- Add option `use_generics_annotations` for collection type hints [#1298 / tanerkay](https://github.com/barryvdh/laravel-ide-helper/pull/1298)
+
+2022-03-06, 2.12.3
+------------------
+
+### Fixed
+- Fix date and datetime handling for attributes that set a serialization format option for the Carbon instance [#1324 / FLeudts](https://github.com/barryvdh/laravel-ide-helper/pull/1324)
+- Fix composer conflict with composer/pcre version 2/3. [#1327 / barryvdh](https://github.com/barryvdh/laravel-ide-helper/pull/1327)
+
+2022-02-08, 2.12.2
+------------------
+### Fixed
+- Remove composer dependecy, use copy of ClassMapGenerator [#1313 / barryvdh](https://github.com/barryvdh/laravel-ide-helper/pull/1313)
+
+2022-01-24, 2.12.1
+------------------
+### Fixed
+- Properly handle `Castable`s without return type. [#1306 / binotaliu](https://github.com/barryvdh/laravel-ide-helper/pull/1306)
+
+2022-01-23, 2.12.0
+------------------
+### Added
+- Add support for custom casts that using `Castable` [#1287 / binotaliu](https://github.com/barryvdh/laravel-ide-helper/pull/1287)
+- Added Laravel 9 support [#1297 / rcerljenko](https://github.com/barryvdh/laravel-ide-helper/pull/1297)
+- Added option `additional_relation_return_types` for custom relations that don't fit the typical naming scheme
+
+2022-01-03, 2.11.0
+------------------
+### Added
+- Add support for Laravel 8.77 Attributes [\#1289 / SimonJnsson](https://github.com/barryvdh/laravel-ide-helper/pull/1289)
+- Add support for cast types `decimal:*`, `encrypted:*`, `immutable_date`, `immutable_datetime`, `custom_datetime`, and `immutable_custom_datetime` [#1262 / miken32](https://github.com/barryvdh/laravel-ide-helper/pull/1262)
+- Add support of variadic parameters in `ide-helper:models` [\#1234 / shaffe-fr](https://github.com/barryvdh/laravel-ide-helper/pull/1234)
+- Add support of custom casts without properties [\#1267 / sparclex](https://github.com/barryvdh/laravel-ide-helper/pull/1267)
+
+### Fixed
+- Fix recursively searching for `HasFactory` and `Macroable` traits [\#1216 / daniel-de-wit](https://github.com/barryvdh/laravel-ide-helper/pull/1216)
+- Use platformName to determine db type when casting boolean types [\#1212 / stockalexander](https://github.com/barryvdh/laravel-ide-helper/pull/1212)
+
+### Changed
+- Move default models helper filename to config [\#1241 / wimski](https://github.com/barryvdh/laravel-ide-helper/pull/1241)
+
+2021-06-18, 2.10.1
+------------------
+### Added
+- Added Type registration according to [Custom Mapping Types documentation](https://www.doctrine-project.org/projects/doctrine-dbal/en/latest/reference/types.html#custom-mapping-types) [\#1228 / wimski](https://github.com/barryvdh/laravel-ide-helper/pull/1241)
+
+### Fixed
+- Fixing issue where configured custom_db_types could cause a DBAL exception to be thrown while running `ide-helper:models` [\#1228 / wimski](https://github.com/barryvdh/laravel-ide-helper/pull/1241)
+
+2021-04-09, 2.10.0
+------------------
+### Added
+- Allowing Methods to be set or unset in ModelHooks [\#1198 / jenga201](https://github.com/barryvdh/laravel-ide-helper/pull/1198)\
+  Note: the visibility of `\Barryvdh\LaravelIdeHelper\Console\ModelsCommand::setMethod` has been changed to **public**!
+
+### Fixed
+- Fixing issue where incorrect autoloader unregistered [\#1210 / tezhm](https://github.com/barryvdh/laravel-ide-helper/pull/1210)
+
+2021-04-02, 2.9.3
+-----------------
+### Fixed
+- Support both customized namespace factories as well as default resolvable ones [\#1201 / wimski](https://github.com/barryvdh/laravel-ide-helper/pull/1201)
+
+2021-04-01, 2.9.2
+-----------------
+### Added
+- Model hooks for adding custom information from external sources to model classes through the ModelsCommand [\#945 / wimski](https://github.com/barryvdh/laravel-ide-helper/pull/945)
+
+### Fixed
+- Fix ide-helper:models exception if model doesn't have factory [\#1196 / ahmed-aliraqi](https://github.com/barryvdh/laravel-ide-helper/pull/1196)
+- Running tests triggering post_migrate hooks [\#1193 / netpok](https://github.com/barryvdh/laravel-ide-helper/pull/1193)
+- Array_merge error when config is cached prior to package install [\#1184 / netpok](https://github.com/barryvdh/laravel-ide-helper/pull/1184)
+
+2021-03-15, 2.9.1
+-----------------
+### Added
+- Generate PHPDoc for Laravel 8.x factories [\#1074 / ahmed-aliraqi](https://github.com/barryvdh/laravel-ide-helper/pull/1074)
+- Add a comment to a property like table columns [\#1168 / biiiiiigmonster](https://github.com/barryvdh/laravel-ide-helper/pull/1168)
+- Added `post_migrate` hook to run commands after a migration [\#1163 / netpok](https://github.com/barryvdh/laravel-ide-helper/pull/1163)
+- Allow for PhpDoc for macros with union types [\#1148 / riesjart](https://github.com/barryvdh/laravel-ide-helper/pull/1148)
+
+### Fixed
+- Error when generating helper for invokable classes [\#1124 / standaniels](https://github.com/barryvdh/laravel-ide-helper/pull/1124)
+- Fix broken ReflectionUnionTypes [\#1132 / def-studio](https://github.com/barryvdh/laravel-ide-helper/pull/1132)
+- Relative class names are not converted to fully-qualified class names [\#1005 / SavKS](https://github.com/barryvdh/laravel-ide-helper/pull/1005)
+
+2020-12-30, 2.9.0
+-----------------
+### Changed
+- Dropped support for Laravel 6 and Laravel 7, as well as support for PHP 7.2 and added support for doctrine/dbal:^3 [\#1114 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/1114)
+
+### Fixed
+- `Macro::initPhpDoc()` will save original docblock if present [\#1116 / LastDragon-ru](https://github.com/barryvdh/laravel-ide-helper/pull/1116)
+- `Alias` will grab macros from `\Illuminate\Database\Eloquent\Builder` too [\#1118 / LastDragon-ru](https://github.com/barryvdh/laravel-ide-helper/pull/1118)
+
+2020-12-08, 2.8.2
+-----------------
+### Added
+- Fix phpdoc generate for custom cast with parameter [\#986 / artelkr](https://github.com/barryvdh/laravel-ide-helper/pull/986)
+- Created a possibility to add custom relation type [\#987 / efinder2](https://github.com/barryvdh/laravel-ide-helper/pull/987)
+- Added `@see` with macro/mixin definition location to PhpDoc [\#1054 / riesjart](https://github.com/barryvdh/laravel-ide-helper/pull/1054)
+- Initial compatibility for PHP8 [\#1106 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/1106)
+
+### Changed
+- Implement DeferrableProvider [\#914 / kon-shou](https://github.com/barryvdh/laravel-ide-helper/pull/914)
+
+### Fixed
+- Compatibility with Lumen [\#1043 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/1043)
+- Allow model_locations to have glob patterns [\#1059 / saackearl](https://github.com/barryvdh/laravel-ide-helper/pull/1059)
+- Error when generating helper for macroable classes which are not facades and contain a "fake" method [\#1066 / domkrm] (https://github.com/barryvdh/laravel-ide-helper/pull/1066)
+- Casts with a return type of `static` or `$this` now resolve to an instance of the cast [\#1103 / riesjart](https://github.com/barryvdh/laravel-ide-helper/pull/1103)
+
+### Removed
+- Removed format and broken generateJsonHelper [\#1053 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/1053)
+
+2020-09-07, 2.8.1
+-----------------
+### Added
+- Support Laravel 8 [\#1022 / barryvdh](https://github.com/barryvdh/laravel-ide-helper/pull/1022)
+- Add option to force usage of FQN [\#1031 / edvordo](https://github.com/barryvdh/laravel-ide-helper/pull/1031)
+- Add support for macros of all macroable classes [\#1006 / domkrm](https://github.com/barryvdh/laravel-ide-helper/pull/1006)
+
+2020-08-11, 2.8.0
+-----------------
+### Added
+- Add static return type to builder methods [\#924 / dmason30](https://github.com/barryvdh/laravel-ide-helper/pull/924)
+- Add `optonal` to meta generator for PhpStorm [\#932 / halaei](https://github.com/barryvdh/laravel-ide-helper/pull/932)
+- Decimal columns as string in Models [\#948 / fgibaux](https://github.com/barryvdh/laravel-ide-helper/pull/948)
+- Simplify full namespaces for already included resources [\#954 / LANGERGabriel](https://github.com/barryvdh/laravel-ide-helper/pull/954)
+- Make writing relation count properties optional [\#969 / AegirLeet](https://github.com/barryvdh/laravel-ide-helper/pull/969)
+- Add more methods able to resolve container instances [\#996 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/996)
+
+### Fixed
+- Test `auth` is bound before detect Auth driver [\#946 / zhwei](https://github.com/barryvdh/laravel-ide-helper/pull/946)
+- Fix inline doc-block for final models [\#944 / Gummibeer](https://github.com/barryvdh/laravel-ide-helper/pull/955)
+
+2020-04-22, 2.7.0
+-----------------
+### Added
+- Add `ignored_models` as config option [\#890 / pataar](https://github.com/barryvdh/laravel-ide-helper/pull/890)
+- Infer return type from reflection if no phpdoc given [\#906 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/906)
+- Add custom collection support for get and all methods [\#903 / dmason30](https://github.com/barryvdh/laravel-ide-helper/pull/903)
+- if a model implements interfaces, include them in the stub [\#920 / mr-feek](https://github.com/barryvdh/laravel-ide-helper/pull/920)
+- Generate noinspections PHPStorm tags [\#905 / mzglinski](https://github.com/barryvdh/laravel-ide-helper/pull/905)
+- Added support for Laravel 7 custom casts [\#913 / belamov](https://github.com/barryvdh/laravel-ide-helper/pull/913)
+- Ability to use patterns for model_locations [\#921 / 4n70w4](https://github.com/barryvdh/laravel-ide-helper/pull/921)
+
+### Fixed
+- MorphToMany relations with query not working [\#894 / UksusoFF](https://github.com/barryvdh/laravel-ide-helper/pull/894)
+- Fix camelCase duplicated properties generator [\#881 / bop10](https://github.com/barryvdh/laravel-ide-helper/pull/881)
+- Prevent generation of invalid code for certain parameter default values [\#901 / loilo](https://github.com/barryvdh/laravel-ide-helper/pull/901)
+- Make hasOne and morphOne nullable [\#864 / leo108](https://github.com/barryvdh/laravel-ide-helper/pull/864)
+- Remove unnecessary and wrong definition of SoftDelete methods [\#918 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/918)
+- Unregister meta command custom autoloader when it is no longer needed [\#919 / mr-feek](https://github.com/barryvdh/laravel-ide-helper/pull/919)
+
+2020-02-25, 2.6.7
+-----------------
+### Added
+- Support for Laravel 7 [commit by barryvdh](https://github.com/barryvdh/laravel-ide-helper/commit/edd69c5e0508972c81f1f7173236de2459c45814)
+
+2019-12-02, 2.6.6
+-----------------
+### Added
+- Add splat operator (...) support [\#860 / ngmy](https://github.com/barryvdh/laravel-ide-helper/pull/860)
+- Add support for custom date class via Date::use() [\#859 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/859)
+
+### Fixed
+- Prevent undefined property errors [\#877 / matt-allan](https://github.com/barryvdh/laravel-ide-helper/pull/877)
+
+----
+Missing an older changelog? Feel free to submit a PR!

LICENSE.md

@@ -1,6 +1,6 @@
 # The MIT License (MIT)
 
-Copyright (c) 2016 Barry vd. Heuvel <barryvdh@gmail.com>
+Copyright (c) Barry vd. Heuvel <barryvdh@gmail.com>
 
 > Permission is hereby granted, free of charge, to any person obtaining a copy
 > of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ Copyright (c) 2016 Barry vd. Heuvel <[email protected]>
 > AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 > LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 > OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-> THE SOFTWARE.
+> THE SOFTWARE.

README.md

@@ -0,0 +1,394 @@
+# 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://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**
+
+This package generates helper files that enable your IDE to provide accurate autocompletion.
+Generation is done based on the files in your project, so they are always up-to-date.
+
+The 3.x branch supports Laravel 10 and 11. For older version, use the 2.x releases.
+
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Automatic PHPDoc generation for Laravel Facades](#automatic-phpdoc-generation-for-laravel-facades)
+  - [Automatic PHPDocs for models](#automatic-phpdocs-for-models)
+    - [Model Directories](#model-directories)
+    - [Ignore Models](#ignore-models)
+    - [Model Hooks](#model-hooks)
+  - [Automatic PHPDocs generation for Laravel Fluent methods](#automatic-phpdocs-generation-for-laravel-fluent-methods)
+  - [Auto-completion for factory builders](#auto-completion-for-factory-builders)
+  - [PhpStorm Meta for Container instances](#phpstorm-meta-for-container-instances)
+- [License](#license)
+
+## Installation
+
+Require this package with composer using the following command:
+
+```bash
+composer require --dev barryvdh/laravel-ide-helper
+```
+
+> [!NOTE]  
+> If you encounter version conflicts with doctrine/dbal, please try:
+> `composer require --dev barryvdh/laravel-ide-helper --with-all-dependencies`
+ 
+This package makes use of [Laravels package auto-discovery mechanism](https://medium.com/@taylorotwell/package-auto-discovery-in-laravel-5-5-ea9e3ab20518), which means if you don't install dev dependencies in production, it also won't be loaded.
+
+If for some reason you want manually control this:
+- add the package to the `extra.laravel.dont-discover` key in `composer.json`, e.g.
+  ```json
+  "extra": {
+    "laravel": {
+      "dont-discover": [
+        "barryvdh/laravel-ide-helper"
+      ]
+    }
+  }
+  ```
+- Add the following class to the `providers` array in `config/app.php`:
+  ```php
+  Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider::class,
+  ```
+  If you want to manually load it only in non-production environments, instead you can add this to your `AppServiceProvider` with the `register()` method:
+  ```php
+  public function register()
+  {
+      if ($this->app->isLocal()) {
+          $this->app->register(\Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider::class);
+      }
+      // ...
+  }
+  ```
+
+> Note: Avoid caching the configuration in your development environment, it may cause issues after installing this package; respectively clear the cache beforehand via `php artisan cache:clear` if you encounter problems when running the commands
+
+## Usage
+
+_Check out [this Laracasts video](https://laracasts.com/series/how-to-be-awesome-in-phpstorm/episodes/15) for a quick introduction/explanation!_
+
+- `php artisan ide-helper:generate` - [PHPDoc generation for Laravel Facades ](#automatic-phpdoc-generation-for-laravel-facades)
+- `php artisan ide-helper:models` - [PHPDocs for models](#automatic-phpdocs-for-models)
+- `php artisan ide-helper:meta` - [PhpStorm Meta file](#phpstorm-meta-for-container-instances)
+
+
+Note: You do need CodeComplice for Sublime Text: https://github.com/spectacles/CodeComplice
+
+### Automatic PHPDoc generation for Laravel Facades
+
+You can now re-generate the docs yourself (for future updates)
+
+```bash
+php artisan ide-helper:generate
+```
+
+Note: `bootstrap/compiled.php` has to be cleared first, so run `php artisan clear-compiled` before generating.
+
+This will generate the file `_ide_helper.php` which is expected to be additionally parsed by your IDE for autocomplete. You can use the config `filename` to change its name.
+
+You can configure your `composer.json` to do this each time you update your dependencies:
+
+```js
+"scripts": {
+    "post-update-cmd": [
+        "Illuminate\\Foundation\\ComposerScripts::postUpdate",
+        "@php artisan ide-helper:generate",
+        "@php artisan ide-helper:meta"
+    ]
+},
+```
+
+You can also publish the config file to change implementations (ie. interface to specific class) or set defaults for `--helpers`.
+
+```bash
+php artisan vendor:publish --provider="Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider" --tag=config
+```
+
+The generator tries to identify the real class, but if it cannot be found, you can define it in the config file.
+
+Some classes need a working database connection. If you do not have a default working connection, some facades will not be included.
+You can use an in-memory SQLite driver by adding the `-M` option.
+
+If you use [real-time facades](https://laravel.com/docs/master/facades#real-time-facades) in your app, those will also be included in the generated file using a `@mixin` annotation and extending the original class underneath the facade. 
+
+**Note**: this feature uses the generated real-time facades files in the `storage/framework/cache` folder. Those files are generated on-demand as you use the real-time facade, so if the framework has not generated that first, it will not be included in the helper file. Run the route/command/code first and then regenerate the helper file and this time the real-time facade will be included in it.
+
+You can choose to include helper files. This is not enabled by default, but you can override it with the `--helpers (-H)` option.
+The `Illuminate/Support/helpers.php` is already set up, but you can add/remove your own files in the config file.
+
+### Automatic PHPDoc generation for macros and mixins
+
+This package can generate PHPDocs for macros and mixins which will be added to the `_ide_helper.php` file.
+
+But this only works if you use type hinting when declaring a macro.
+
+```php
+Str::macro('concat', function(string $str1, string $str2) : string {
+    return $str1 . $str2;
+});
+```
+
+### Automatic PHPDocs for models
+
+If you don't want to write your properties yourself, you can use the command `php artisan ide-helper:models` to generate
+PHPDocs, based on table columns, relations and getters/setters.
+
+> Note: this command requires a working database connection to introspect the table of each model
+
+By default, you are asked to overwrite or write to a separate file (`_ide_helper_models.php`).
+You can write the comments directly to your Model file, using the `--write (-W)` option, or
+force to not write with `--nowrite (-N)`.
+
+Alternatively using the `--write-mixin (-M)` option will only add a mixin tag to your Model file,
+writing the rest in (`_ide_helper_models.php`).
+The class name will be different from the model, avoiding the IDE duplicate annoyance.
+
+> Please make sure to back up your models, before writing the info.
+
+Writing to the models should keep the existing comments and only append new properties/methods. It will not update changed properties/methods.
+
+With the `--reset (-R)` option, the whole existing PHPDoc is replaced, including any comments that have been made.
+
+```bash
+php artisan ide-helper:models "App\Models\Post"
+```
+
+```php
+/**
+ * App\Models\Post
+ *
+ * @property integer $id
+ * @property integer $author_id
+ * @property string $title
+ * @property string $text
+ * @property \Illuminate\Support\Carbon $created_at
+ * @property \Illuminate\Support\Carbon $updated_at
+ * @property-read \User $author
+ * @property-read \Illuminate\Database\Eloquent\Collection|\Comment[] $comments
+ * @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)
+ * …
+ */
+```
+
+With the `--write-mixin (-M)` option
+```php
+/**
+ * …
+ * @mixin IdeHelperPost
+ */
+```
+
+#### Model Directories
+
+By default, models in `app/models` are scanned. The optional argument tells what models to use (also outside app/models).
+
+```bash
+php artisan ide-helper:models "App\Models\Post" "App\Models\User"
+```
+
+You can also scan a different directory, using the `--dir` option (relative from the base path):
+
+```bash
+php artisan ide-helper:models --dir="path/to/models" --dir="app/src/Model"
+```
+
+You can publish the config file (`php artisan vendor:publish`) and set the default directories.
+
+#### Ignore Models
+
+Models can be ignored using the `--ignore (-I)` option
+
+```bash
+php artisan ide-helper:models --ignore="App\Models\Post,App\Models\User"
+```
+
+Or can be ignored by setting the `ignored_models` config
+
+```php
+'ignored_models' => [
+    App\Post::class,
+    Api\User::class
+],
+```
+
+#### Magic `where*` methods
+
+Eloquent allows calling `where<Attribute>` on your models, e.g. `Post::whereTitle(…)` and automatically translates this to e.g. `Post::where('title', '=', '…')`.
+
+If for some reason it's undesired to have them generated (one for each column), you can disable this via config `write_model_magic_where` and setting it to `false`.
+
+#### Magic `*_count` properties
+
+You may use the [`::withCount`](https://laravel.com/docs/master/eloquent-relationships#counting-related-models) method to count the number results from a relationship without actually loading them. Those results are then placed in attributes following the `<columname>_count` convention.
+
+By default, these attributes are generated in the phpdoc. You can turn them off by setting the config `write_model_relation_count_properties` to `false`.
+
+#### Generics annotations
+
+Laravel 9 introduced generics annotations in DocBlocks for collections. PhpStorm 2022.3 and above support the use of generics annotations within `@property` and `@property-read` declarations in DocBlocks, e.g. `Collection<User>` instead of `Collection|User[]`.
+
+These can be disabled by setting the config `use_generics_annotations` to `false`.
+
+#### Support `@comment` based on DocBlock
+
+In order to better support IDEs, relations and getters/setters can also add a comment to a property like table columns. Therefore a custom docblock `@comment` is used:
+```php
+class Users extends Model
+{
+    /**
+     * @comment Get User's full name
+     *
+     * @return string
+     */
+    public function getFullNameAttribute(): string
+    {
+        return $this->first_name . ' ' .$this->last_name ;
+    }
+}
+
+// => after generate models
+
+/**
+ * App\Models\Users
+ * 
+ * @property-read string $full_name Get User's full name
+ * …
+ */
+```
+
+#### Dedicated Eloquent Builder methods
+
+A new method to the eloquent models was added called `newEloquentBuilder` [Reference](https://timacdonald.me/dedicated-eloquent-model-query-builders/) where we can 
+add support for creating a new dedicated class instead of using local scopes in the model itself.
+
+If for some reason it's undesired to have them generated (one for each column), you can disable this via config `write_model_external_builder_methods` and setting it to `false`.
+
+#### Custom Relationship Types
+
+If you are using relationships not built into Laravel you will need to specify the name and returning class in the config to get proper generation.
+
+```php
+'additional_relation_types' => [
+    'externalHasMany' => \My\Package\externalHasMany::class
+],
+```
+
+Found relationships will typically generate a return value based on the name of the relationship.
+
+If your custom relationships don't follow this traditional naming scheme you can define its return type manually. The available options are `many` and `morphTo`.
+
+```php
+'additional_relation_return_types' => [
+    'externalHasMultiple' => 'many'
+],
+```
+
+#### Model Hooks
+
+If you need additional information on your model from sources that are not handled by default, you can hook in to the
+ generation process with model hooks to add extra information on the fly.
+ Simply create a class that implements `ModelHookInterface` and add it to the `model_hooks` array in the config:
+ 
+ ```php
+'model_hooks' => [
+    MyCustomHook::class,
+],
+```
+
+The `run` method will be called during generation for every model and receives the current running `ModelsCommand` and the current `Model`, e.g.:
+
+```php
+class MyCustomHook implements ModelHookInterface
+{
+    public function run(ModelsCommand $command, Model $model): void
+    {
+        if (! $model instanceof MyModel) {
+            return;
+        }
+
+        $command->setProperty('custom', 'string', true, false, 'My custom property');
+        $command->unsetMethod('method');
+        $command->setMethod('method', $command->getMethodType($model, '\Some\Class'), ['$param']);
+    }
+}
+```
+
+```php
+/**
+ * MyModel
+ *
+ * @property integer $id
+ * @property-read string $custom
+```
+
+### Automatic PHPDocs generation for Laravel Fluent methods
+
+If you need PHPDocs support for Fluent methods in migration, for example
+
+```php
+$table->string("somestring")->nullable()->index();
+```
+
+After publishing vendor, simply change the `include_fluent` line in your `config/ide-helper.php` file into:
+
+```php
+'include_fluent' => true,
+```
+
+Then run `php artisan ide-helper:generate`, you will now see all Fluent methods recognized by your IDE.
+
+### Auto-completion for factory builders
+
+If you would like the `factory()->create()` and `factory()->make()` methods to return the correct model class,
+you can enable custom factory builders with the `include_factory_builders` line in your `config/ide-helper.php` file.
+Deprecated for Laravel 8 or latest.
+
+```php
+'include_factory_builders' => true,
+```
+
+For this to work, you must also publish the PhpStorm Meta file (see below).
+
+## PhpStorm Meta for Container instances
+
+It's possible to generate a PhpStorm meta file to [add support for factory design pattern](https://www.jetbrains.com/help/phpstorm/ide-advanced-metadata.html).
+For Laravel, this means we can make PhpStorm understand what kind of object we are resolving from the IoC Container.
+For example, `events` will return an `Illuminate\Events\Dispatcher` object,
+so with the meta file you can call `app('events')` and it will autocomplete the Dispatcher methods.
+
+```bash
+php artisan ide-helper:meta
+```
+
+```php
+app('events')->fire();
+\App::make('events')->fire();
+
+/** @var \Illuminate\Foundation\Application $app */
+$app->make('events')->fire();
+
+// When the key is not found, it uses the argument as class name
+app('App\SomeClass');
+// Also works with
+app(App\SomeClass::class);
+```
+
+> Note: You might need to restart PhpStorm and make sure `.phpstorm.meta.php` is indexed.
+>
+> Note: When you receive a FatalException: class not found, check your config
+> (for example, remove S3 as cloud driver when you don't have S3 configured. Remove Redis ServiceProvider when you don't use it).
+
+You can change the generated filename via the config `meta_filename`. This can be useful for cases where you want to take advantage of PhpStorm's support of the _directory_ `.phpstorm.meta.php/`: all files placed there are parsed, should you want to provide additional files to PhpStorm.
+
+## License
+
+The Laravel IDE Helper Generator is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT)
+

composer.json

@@ -1,8 +1,18 @@
 {
     "name": "barryvdh/laravel-ide-helper",
     "description": "Laravel IDE Helper, generates correct PHPDocs for all Facade classes, to improve auto-completion.",
-    "keywords": ["laravel", "autocomplete", "ide", "helper", "phpstorm", "netbeans", "sublime", "codeintel", "phpdoc"],
     "license": "MIT",
+    "keywords": [
+        "laravel",
+        "autocomplete",
+        "ide",
+        "helper",
+        "phpstorm",
+        "netbeans",
+        "sublime",
+        "codeintel",
+        "phpdoc"
+    ],
     "authors": [
         {
             "name": "Barry vd. Heuvel",
@@ -10,22 +20,33 @@
         }
     ],
     "require": {
-        "php": ">=5.4.0",
-        "illuminate/support": "^5.0,<5.5",
-        "illuminate/console": "^5.0,<5.5",
-        "illuminate/filesystem": "^5.0,<5.5",
-        "barryvdh/reflection-docblock": "^2.0.4",
-        "symfony/class-loader": "^2.3|^3.0"
+        "php": "^8.2",
+        "ext-json": "*",
+        "barryvdh/reflection-docblock": "^2.1.2",
+        "composer/class-map-generator": "^1.0",
+        "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": {
-        "phpunit/phpunit" : "4.*",
-        "scrutinizer/ocular": "~1.1",
-        "squizlabs/php_codesniffer": "~2.3",
-        "doctrine/dbal": "~2.3"
+        "ext-pdo_sqlite": "*",
+        "friendsofphp/php-cs-fixer": "^3",
+        "illuminate/config": "^11.15",
+        "illuminate/view": "^11.15",
+        "mockery/mockery": "^1.4",
+        "orchestra/testbench": "^9.2",
+        "phpunit/phpunit": "^10.5",
+        "spatie/phpunit-snapshot-assertions": "^4 || ^5",
+        "vimeo/psalm": "^5.4"
     },
     "suggest": {
-        "doctrine/dbal": "Load information from the database about models for phpdocs (~2.3)"
+        "illuminate/events": "Required for automatic helper generation (^6|^7|^8|^9|^10|^11)."
     },
+    "minimum-stability": "dev",
+    "prefer-stable": true,
     "autoload": {
         "psr-4": {
             "Barryvdh\\LaravelIdeHelper\\": "src"
@@ -33,16 +54,38 @@
     },
     "autoload-dev": {
         "psr-4": {
-            ":vendor\\:package_name\\": "tests"
+            "Barryvdh\\LaravelIdeHelper\\Tests\\": "tests"
         }
     },
-    "scripts": {
-        "test": "phpunit",
-        "cs": "phpcs --standard=psr2 src/"
+    "config": {
+        "allow-plugins": {
+            "composer/package-versions-deprecated": true
+        },
+        "sort-packages": true
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "2.3-dev"
+            "dev-master": "3.2-dev"
+        },
+        "laravel": {
+            "providers": [
+                "Barryvdh\\LaravelIdeHelper\\IdeHelperServiceProvider"
+            ]
         }
+    },
+    "scripts": {
+        "analyze": "psalm",
+        "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"
+        ],
+        "fix-style": [
+            "php-cs-fixer fix",
+            "php-cs-fixer fix --config=.php-cs-fixer.tests.php"
+        ],
+        "psalm-set-baseline": "psalm --set-baseline=psalm-baseline.xml",
+        "test": "phpunit",
+        "test-ci": "phpunit -d --without-creating-snapshots",
+        "test-regenerate": "phpunit -d --update-snapshots"
     }
 }

config/ide-helper.php

@@ -1,30 +1,114 @@
 <?php
 
-return array(
+return [
 
     /*
     |--------------------------------------------------------------------------
-    | Filename & Format
+    | Filename
     |--------------------------------------------------------------------------
     |
-    | The default filename (without extension) and the format (php or json)
+    | The default filename.
     |
     */
 
-    'filename'  => '_ide_helper',
-    'format'    => 'php',
+    'filename' => '_ide_helper.php',
+
+    /*
+    |--------------------------------------------------------------------------
+    | Models filename
+    |--------------------------------------------------------------------------
+    |
+    | The default filename for the models helper file.
+    |
+    */
+
+    'models_filename' => '_ide_helper_models.php',
+
+    /*
+    |--------------------------------------------------------------------------
+    | PhpStorm meta filename
+    |--------------------------------------------------------------------------
+    |
+    | PhpStorm also supports the directory `.phpstorm.meta.php/` with arbitrary
+    | files in it, should you need additional files for your project; e.g.
+    | `.phpstorm.meta.php/laravel_ide_Helper.php'.
+    |
+    */
+    'meta_filename' => '.phpstorm.meta.php',
 
     /*
     |--------------------------------------------------------------------------
     | Fluent helpers
     |--------------------------------------------------------------------------
     |
-    | Set to true to generate commonly used Fluent methods
+    | Set to true to generate commonly used Fluent methods.
     |
     */
 
     'include_fluent' => false,
 
+    /*
+    |--------------------------------------------------------------------------
+    | Factory builders
+    |--------------------------------------------------------------------------
+    |
+    | Set to true to generate factory generators for better factory()
+    | method auto-completion.
+    |
+    | Deprecated for Laravel 8 or latest.
+    |
+    */
+
+    'include_factory_builders' => false,
+
+    /*
+    |--------------------------------------------------------------------------
+    | Write model magic methods
+    |--------------------------------------------------------------------------
+    |
+    | Set to false to disable write magic methods of model.
+    |
+    */
+
+    'write_model_magic_where' => true,
+
+    /*
+    |--------------------------------------------------------------------------
+    | Write model external Eloquent builder methods
+    |--------------------------------------------------------------------------
+    |
+    | Set to false to disable write external Eloquent builder methods.
+    |
+    */
+
+    'write_model_external_builder_methods' => true,
+
+    /*
+    |--------------------------------------------------------------------------
+    | Write model relation count properties
+    |--------------------------------------------------------------------------
+    |
+    | Set to false to disable writing of relation count properties to model DocBlocks.
+    |
+    */
+
+    'write_model_relation_count_properties' => true,
+
+    /*
+    |--------------------------------------------------------------------------
+    | Write Eloquent model mixins
+    |--------------------------------------------------------------------------
+    |
+    | This will add the necessary DocBlock mixins to the model class
+    | contained in the Laravel framework. This helps the IDE with
+    | auto-completion.
+    |
+    | Please be aware that this setting changes a file within the /vendor directory.
+    |
+    */
+
+    'write_eloquent_model_mixins' => false,
+
     /*
     |--------------------------------------------------------------------------
     | Helper files to include
@@ -37,9 +121,9 @@ return array(
 
     'include_helpers' => false,
 
-    'helper_files' => array(
-        base_path().'/vendor/laravel/framework/src/Illuminate/Support/helpers.php',
-    ),
+    'helper_files' => [
+        base_path() . '/vendor/laravel/framework/src/Illuminate/Support/helpers.php',
+    ],
 
     /*
     |--------------------------------------------------------------------------
@@ -49,39 +133,58 @@ return array(
     | Define in which directories the ide-helper:models command should look
     | for models.
     |
+    | glob patterns are supported to easier reach models in sub-directories,
+    | e.g. `app/Services/* /Models` (without the space).
+    |
     */
 
-    'model_locations' => array(
+    'model_locations' => [
         'app',
-    ),
+    ],
 
+    /*
+    |--------------------------------------------------------------------------
+    | Models to ignore
+    |--------------------------------------------------------------------------
+    |
+    | Define which models should be ignored.
+    |
+    */
+
+    'ignored_models' => [
+        // App\MyModel::class,
+    ],
+
+    /*
+    |--------------------------------------------------------------------------
+    | Models hooks
+    |--------------------------------------------------------------------------
+    |
+    | Define which hook classes you want to run for models to add custom information.
+    |
+    | Hooks should implement Barryvdh\LaravelIdeHelper\Contracts\ModelHookInterface.
+    |
+    */
+
+    'model_hooks' => [
+        // App\Support\IdeHelper\MyModelHook::class
+    ],
 
     /*
     |--------------------------------------------------------------------------
     | Extra classes
     |--------------------------------------------------------------------------
     |
-    | These implementations are not really extended, but called with magic functions
+    | These implementations are not really extended, but called with magic functions.
     |
     */
 
-    'extra' => array(
-        'Eloquent' => array('Illuminate\Database\Eloquent\Builder', 'Illuminate\Database\Query\Builder'),
-        'Session' => array('Illuminate\Session\Store'),
-    ),
+    'extra' => [
+        'Eloquent' => ['Illuminate\Database\Eloquent\Builder', 'Illuminate\Database\Query\Builder'],
+        'Session' => ['Illuminate\Session\Store'],
+    ],
 
-    'magic' => array(
-        'Log' => array(
-            'debug'     => 'Monolog\Logger::addDebug',
-            'info'      => 'Monolog\Logger::addInfo',
-            'notice'    => 'Monolog\Logger::addNotice',
-            'warning'   => 'Monolog\Logger::addWarning',
-            'error'     => 'Monolog\Logger::addError',
-            'critical'  => 'Monolog\Logger::addCritical',
-            'alert'     => 'Monolog\Logger::addAlert',
-            'emergency' => 'Monolog\Logger::addEmergency',
-        )
-    ),
+    'magic' => [],
 
     /*
     |--------------------------------------------------------------------------
@@ -93,39 +196,9 @@ return array(
     |
     */
 
-    'interfaces' => array(
-
-    ),
-
-    /*
-    |--------------------------------------------------------------------------
-    | Support for custom DB types
-    |--------------------------------------------------------------------------
-    |
-    | This setting allow you to map any custom database type (that you may have
-    | created using CREATE TYPE statement or imported using database plugin
-    | / extension to a Doctrine type.
-    |
-    | Each key in this array is a name of the Doctrine2 DBAL Platform. Currently valid names are:
-    | 'postgresql', 'db2', 'drizzle', 'mysql', 'oracle', 'sqlanywhere', 'sqlite', 'mssql'
-    |
-    | This name is returned by getName() method of the specific Doctrine/DBAL/Platforms/AbstractPlatform descendant
-    |
-    | The value of the array is an array of type mappings. Key is the name of the custom type,
-    | (for example, "jsonb" from Postgres 9.4) and the value is the name of the corresponding Doctrine2 type (in
-    | our case it is 'json_array'. Doctrine types are listed here:
-    | http://doctrine-dbal.readthedocs.org/en/latest/reference/types.html
-    |
-    | So to support jsonb in your models when working with Postgres, just add the following entry to the array below:
-    |
-    | "postgresql" => array(
-    |       "jsonb" => "json_array",
-    |  ),
-    |
-    */
-    'custom_db_types' => array(
-
-    ),
+    'interfaces' => [
+        // App\MyInterface::class => App\MyImplementation::class,
+    ],
 
     /*
      |--------------------------------------------------------------------------
@@ -140,13 +213,13 @@ return array(
      |
      | For example, normally you would see this:
      |
-     |  * @property \Carbon\Carbon $created_at
-     |  * @property \Carbon\Carbon $updated_at
+     |  * @property \Illuminate\Support\Carbon $created_at
+     |  * @property \Illuminate\Support\Carbon $updated_at
      |
      | With this enabled, the properties will be this:
      |
-     |  * @property \Carbon\Carbon $createdAt
-     |  * @property \Carbon\Carbon $updatedAt
+     |  * @property \Illuminate\Support\Carbon $createdAt
+     |  * @property \Illuminate\Support\Carbon $updatedAt
      |
      | Note, it is currently an all-or-nothing option.
      |
@@ -155,14 +228,87 @@ return array(
 
     /*
     |--------------------------------------------------------------------------
-    | Property Casts
+    | Property casts
     |--------------------------------------------------------------------------
     |
     | Cast the given "real type" to the given "type".
     |
     */
-   'type_overrides' => array(
+    'type_overrides' => [
         'integer' => 'int',
         'boolean' => 'bool',
-   ),
-);
+    ],
+
+    /*
+    |--------------------------------------------------------------------------
+    | Include DocBlocks from classes
+    |--------------------------------------------------------------------------
+    |
+    | Include DocBlocks from classes to allow additional code inspection for
+    | magic methods and properties.
+    |
+    */
+    'include_class_docblocks' => false,
+
+    /*
+    |--------------------------------------------------------------------------
+    | Force FQN usage
+    |--------------------------------------------------------------------------
+    |
+    | Use the fully qualified (class) name in DocBlocks,
+    | even if the class exists in the same namespace
+    | or there is an import (use className) of the class.
+    |
+    */
+    'force_fqn' => false,
+
+    /*
+    |--------------------------------------------------------------------------
+    | Use generics syntax
+    |--------------------------------------------------------------------------
+    |
+    | Use generics syntax within DocBlocks,
+    | e.g. `Collection<User>` instead of `Collection|User[]`.
+    |
+    */
+    'use_generics_annotations' => true,
+
+    /*
+    |--------------------------------------------------------------------------
+    | Additional relation types
+    |--------------------------------------------------------------------------
+    |
+    | Sometimes it's needed to create custom relation types. The key of the array
+    | is the relationship method name. The value of the array is the fully-qualified
+    | class name of the relationship, e.g. `'relationName' => RelationShipClass::class`.
+    |
+    */
+    'additional_relation_types' => [],
+
+    /*
+    |--------------------------------------------------------------------------
+    | Additional relation return types
+    |--------------------------------------------------------------------------
+    |
+    | When using custom relation types its possible for the class name to not contain
+    | the proper return type of the relation. The key of the array is the relationship
+    | method name. The value of the array is the return type of the relation ('many'
+    | or 'morphTo').
+    | e.g. `'relationName' => 'many'`.
+    |
+    */
+    'additional_relation_return_types' => [],
+
+    /*
+    |--------------------------------------------------------------------------
+    | Run artisan commands after migrations to generate model helpers
+    |--------------------------------------------------------------------------
+    |
+    | The specified commands should run after migrations are finished running.
+    |
+    */
+    'post_migrate' => [
+        // 'ide-helper:models --nowrite',
+    ],
+
+];

phpunit.xml.dist

@@ -1,29 +1,17 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit bootstrap="vendor/autoload.php"
-         backupGlobals="false"
-         backupStaticAttributes="false"
-         colors="true"
-         verbose="true"
-         convertErrorsToExceptions="true"
-         convertNoticesToExceptions="true"
-         convertWarningsToExceptions="true"
-         processIsolation="false"
-         stopOnFailure="false">
+<phpunit
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.5/phpunit.xsd"
+        cacheDirectory=".phpunit.result.cache"
+>
     <testsuites>
-        <testsuite name=":vendor Test Suite">
+        <testsuite name="Unit Tests">
             <directory>tests</directory>
         </testsuite>
     </testsuites>
-    <filter>
-        <whitelist>
+    <source>
+        <include>
             <directory suffix=".php">src/</directory>
-        </whitelist>
-    </filter>
-    <logging>
-        <log type="tap" target="build/report.tap"/>
-        <log type="junit" target="build/report.junit.xml"/>
-        <log type="coverage-html" target="build/coverage" charset="UTF-8" yui="true" highlight="true"/>
-        <log type="coverage-text" target="build/coverage.txt"/>
-        <log type="coverage-clover" target="build/logs/clover.xml"/>
-    </logging>
-</phpunit>
+        </include>
+    </source>
+</phpunit>

psalm-baseline.xml

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<files psalm-version="5.4.0@62db5d4f6a7ae0a20f7cc5a4952d730272fc0863">
+  <file src="src/Factories.php">
+    <UndefinedClass occurrences="2">
+      <code>Factory</code>
+      <code>Factory</code>
+    </UndefinedClass>
+  </file>
+  <file src="src/Generator.php">
+    <UndefinedClass occurrences="6">
+      <code>\Auth</code>
+      <code>\Cache</code>
+      <code>\Cache</code>
+      <code>\DB</code>
+      <code>\Queue</code>
+      <code>\Storage</code>
+    </UndefinedClass>
+  </file>
+  <file src="src/Console/ModelsCommand.php">
+    <UndefinedClass occurrences="1">
+      <code>\UnitEnum</code>
+    </UndefinedClass>
+  </file>
+</files>

psalm.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0"?>
+<psalm
+    errorLevel="7"
+    resolveFromConfigFile="true"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns="https://getpsalm.org/schema/config"
+    xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
+    errorBaseline="psalm-baseline.xml"
+>
+    <projectFiles>
+        <directory name="src" />
+        <ignoreFiles>
+            <directory name="vendor" />
+        </ignoreFiles>
+    </projectFiles>
+</psalm>

readme.md

@@ -1,256 +0,0 @@
-## Laravel 5 IDE Helper Generator
-
-[![Latest Version on Packagist][ico-version]][link-packagist]
-[![Software License][ico-license]](LICENSE.md)
-[![Build Status][ico-travis]][link-travis]
-[![Total Downloads][ico-downloads]][link-downloads]
-
-__For Laravel 4.x, check [version 1.11](https://github.com/barryvdh/laravel-ide-helper/tree/1.11)__
-
-### Complete phpDocs, directly from the source
-
-_Check out [this Laracasts video](https://laracasts.com/series/how-to-be-awesome-in-phpstorm/episodes/15) for a quick introduction/explanation!_
-
- * [`php artisan ide-helper:generate` - phpDoc generation for Laravel Facades ](#automatic-phpdoc-generation-for-laravel-facades)
- * [`php artisan ide-helper:models` - phpDocs for models](#automatic-phpdocs-for-models)
- * [`php artisan ide-helper:meta` - PhpStorm Meta file](#phpstorm-meta-for-container-instances)
-
-This package generates a file that your IDE understands, so it can provide accurate autocompletion. Generation is done based on the files in your project, so they are always up-to-date.
-If you don't want to generate it, you can add a pre-generated file to the root folder of your Laravel project (but this isn't as up-to-date as self generated files).
-
-* Generated version for L5: https://gist.github.com/barryvdh/5227822
-* Generated version for Lumen: https://gist.github.com/barryvdh/be17164b0ad51f832f20
-* Generated Phpstorm Meta file: https://gist.github.com/barryvdh/bb6ffc5d11e0a75dba67
-
-Note: You do need CodeIntel for Sublime Text: https://github.com/SublimeCodeIntel/SublimeCodeIntel
-
-### Install
-
-Require this package with composer using the following command:
-
-```bash
-composer require barryvdh/laravel-ide-helper
-```
-
-After updating composer, add the service provider to the `providers` array in `config/app.php`
-
-```php
-Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider::class,
-```
-
-To install this package on only development systems, add the `--dev` flag to your composer command:
-
-```bash
-composer require --dev barryvdh/laravel-ide-helper
-```
-
-In Laravel, instead of adding the service provider in the `config/app.php` file, you can add the following code to your `app/Providers/AppServiceProvider.php` file, within the `register()` method:
-
-```php
-public function register()
-{
-    if ($this->app->environment() !== 'production') {
-        $this->app->register(\Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider::class);
-    }
-    // ...
-}
-```
-
-This will allow your application to load the Laravel IDE Helper on non-production enviroments.
-
-### Automatic phpDoc generation for Laravel Facades
-
-You can now re-generate the docs yourself (for future updates)
-
-```bash
-php artisan ide-helper:generate
-```
-
-Note: `bootstrap/compiled.php` has to be cleared first, so run `php artisan clear-compiled` before generating (and `php artisan optimize` after).
-
-You can configure your composer.json to do this after each commit:
-
-```js
-"scripts":{
-    "post-update-cmd": [
-        "Illuminate\\Foundation\\ComposerScripts::postUpdate",
-        "php artisan ide-helper:generate",
-        "php artisan ide-helper:meta",
-        "php artisan optimize"
-    ]
-},
-```
-
-You can also publish the config file to change implementations (ie. interface to specific class) or set defaults for `--helpers` or `--sublime`.
-
-```bash
-php artisan vendor:publish --provider="Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider" --tag=config
-```
-
-The generator tries to identify the real class, but if it cannot be found, you can define it in the config file.
-
-Some classes need a working database connection. If you do not have a default working connection, some facades will not be included.
-You can use an in-memory SQLite driver by adding the -M option.
-
-You can choose to include helper files. This is not enabled by default, but you can override it with the `--helpers (-H)` option.
-The `Illuminate/Support/helpers.php` is already set up, but you can add/remove your own files in the config file.
-
-### Automatic phpDocs for models
-
-> You need to require `doctrine/dbal: ~2.3` in your own composer.json to get database columns.
-
-
-```bash
-composer require doctrine/dbal
-```
-
-If you don't want to write your properties yourself, you can use the command `php artisan ide-helper:models` to generate
-phpDocs, based on table columns, relations and getters/setters. You can write the comments directly to your Model file, using the `--write (-W)` option. By default, you are asked to overwrite or write to a separate file (`_ide_helper_models.php`). You can force No with `--nowrite (-N)`.
-Please make sure to backup your models, before writing the info.
-It should keep the existing comments and only append new properties/methods. The existing phpdoc is replaced, or added if not found.
-With the `--reset (-R)` option, the existing phpdocs are ignored, and only the newly found columns/relations are saved as phpdocs.
-
-```bash
-php artisan ide-helper:models Post
-```
-
-```php
-/**
- * An Eloquent Model: 'Post'
- *
- * @property integer $id
- * @property integer $author_id
- * @property string $title
- * @property string $text
- * @property \Carbon\Carbon $created_at
- * @property \Carbon\Carbon $updated_at
- * @property-read \User $author
- * @property-read \Illuminate\Database\Eloquent\Collection|\Comment[] $comments
- */
-```
-
-By default, models in `app/models` are scanned. The optional argument tells what models to use (also outside app/models).
-
-```bash
-php artisan ide-helper:models Post User
-```
-
-You can also scan a different directory, using the `--dir` option (relative from the base path):
-
-```bash
-php artisan ide-helper:models --dir="path/to/models" --dir="app/src/Model"
-```
-
-You can publish the config file (`php artisan vendor:publish`) and set the default directories.
-
-Models can be ignored using the `--ignore (-I)` option
-
-```bash
-php artisan ide-helper:models --ignore="Post,User"
-```
-
-Note: With namespaces, wrap your model name in " signs: `php artisan ide-helper:models "API\User"`, or escape the slashes (`Api\\User`)
-
-### Automatic phpDocs generation for Laravel Fluent methods
-If you need phpDocs support for Fluent methods in migration, for example
-```php
-$table->string(“somestring”)->nullable()->index();
-```
-After publishing vendor, simply change the `include_fluent` line your `config/ide-helper.php` file into:
-```php
-'include_fluent' => true,
-```
-And then run `php artisan ide-helper:generate` , you will now see all of the Fluent methods are recognized by your IDE now.
-
-
-## PhpStorm Meta for Container instances
-
-It's possible to generate a PhpStorm meta file to [add support for factory design pattern](https://confluence.jetbrains.com/display/PhpStorm/PhpStorm+Advanced+Metadata). For Laravel, this means we can make PhpStorm understand what kind of object we are resolving from the IoC Container. For example, `events` will return an `Illuminate\Events\Dispatcher` object, so with the meta file you can call `app('events')` and it will autocomplete the Dispatcher methods.
-
-``` bash
-php artisan ide-helper:meta
-```
-
-```php
-app('events')->fire();
-\App::make('events')->fire();
-
-/** @var \Illuminate\Foundation\Application $app */
-$app->make('events')->fire();
-
-// When the key is not found, it uses the argument as class name
-app('App\SomeClass');
-```
-
-Pre-generated example: https://gist.github.com/barryvdh/bb6ffc5d11e0a75dba67
-
-> Note: You might need to restart PhpStorm and make sure `.phpstorm.meta.php` is indexed.
-> Note: When you receive a FatalException about a class that is not found, check your config (for example, remove S3 as cloud driver when you don't have S3 configured. Remove Redis ServiceProvider when you don't use it).
-
-## Lumen Install
-
-This package is focused on Laravel development, but it can also be used in Lumen with some workarounds. Because Lumen works a little different, as it is like a barebone version of Laravel and the main configuration parameters are instead located in `bootstrap/app.php`, some alterations must be made.
-
-#### Enabling Facades
-
-While Laravel IDE Helper can generate automatically default Facades for code hinting, Lumen doesn't come with Facades activated. If you plan in using them, you must enable them under the `Create The Application` section, uncommenting this line:
-
-```php
-// $app->withFacades();
-```
-
-From there, you should be able to use the `create_alias()` function to add additional Facades into your application.
-
-#### Adding the Service Provider
-
-You can install Laravel IDE Helper in `app/Providers/AppServiceProvider.php`, and uncommenting this line that registers the App Service Providers so it can properly load.
-
-```php
-// $app->register(App\Providers\AppServiceProvider::class);
-```
-
-If you are not using that line, that is usually handy to manage gracefully multiple Laravel/Lumen installations, you will have to add this line of code under the `Register Service Providers` section of your `bootstrap/app.php`.
-
-```php
-if ($app->environment() !== 'production') {
-    $app->register(\Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider::class);
-}
-```
-
-After that, Laravel IDE Helper should work correctly. During the generation process, the script may throw exceptions saying that some Class(s) doesn't exist or there are some undefined indexes. This is normal, as Lumen has some default packages stripped away, like Cookies, Storage and Session. If you plan to add these packages, you will have to add them manually and create additional Facades if needed.
-
-#### Adding Additional Facades
-
-Currently Lumen IDE Helper doesn't take into account additional Facades created under `bootstrap/app.php` using `create_alias()`, so you need to create a `config/app.php` file and add your custom aliases under an `aliases` array again, like so:
-
-```php
-return [
-    'aliases' => [
-        'CustomAliasOne' => Example\Support\Facades\CustomAliasOne::class,
-        'CustomAliasTwo' => Example\Support\Facades\CustomAliasTwo::class,
-        //...
-    ]
-];
-```
-
-After you run ```php artisan ide-helper:generate```, it's recommended (but not mandatory) to rename `config/app.php` to something else until you have to re-generate the docs or after passing to production enviroment. Lumen 5.1+ will read this file for configuration parameters if it is present, and may overlap some configurations if it is completely populated.
-
-### License
-
-The Laravel IDE Helper Generator is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT)
-
-
-[ico-version]: https://img.shields.io/packagist/v/barryvdh/laravel-ide-helper.svg?style=flat-square
-[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
-[ico-travis]: https://img.shields.io/travis/barryvdh/laravel-ide-helper/master.svg?style=flat-square
-[ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/barryvdh/laravel-ide-helper.svg?style=flat-square
-[ico-code-quality]: https://img.shields.io/scrutinizer/g/barryvdh/laravel-ide-helper.svg?style=flat-square
-[ico-downloads]: https://img.shields.io/packagist/dt/barryvdh/laravel-ide-helper.svg?style=flat-square
-
-[link-packagist]: https://packagist.org/packages/barryvdh/laravel-ide-helper
-[link-travis]: https://travis-ci.org/barryvdh/laravel-ide-helper
-[link-scrutinizer]: https://scrutinizer-ci.com/g/barryvdh/laravel-ide-helper/code-structure
-[link-code-quality]: https://scrutinizer-ci.com/g/barryvdh/laravel-ide-helper
-[link-downloads]: https://packagist.org/packages/barryvdh/laravel-ide-helper
-[link-author]: https://github.com/barryvdh
-[link-contributors]: ../../contributors

resources/views/helper.php

@@ -1,68 +1,91 @@
 <?= '<?php' ?>
+<?php
+/**
+ * @var \Barryvdh\LaravelIdeHelper\Alias[][] $namespaces_by_alias_ns
+ * @var \Barryvdh\LaravelIdeHelper\Alias[][] $namespaces_by_extends_ns
+ * @var bool $include_fluent
+ * @var string $helpers
+ */
+?>
+
+/* @noinspection ALL */
+// @formatter:off
+// phpcs:ignoreFile
 
 /**
- * A helper file for Laravel 5, to provide autocomplete information to your IDE
- * Generated for Laravel <?= $version ?> on <?= date("Y-m-d") ?>.
+ * A helper file for Laravel, to provide autocomplete information to your IDE
+ * Generated for Laravel <?= $version ?>.
+ *
+ * This file should not be included in your code, only analyzed by your IDE!
  *
  * @author Barry vd. Heuvel <[email protected]>
  * @see https://github.com/barryvdh/laravel-ide-helper
  */
-namespace  {
-    exit("This file should not be included, only analyzed by your IDE");
-}
 
-<?php foreach($namespaces as $namespace => $aliases): ?>
-<?php if ($namespace == '\Illuminate\Database\Eloquent'): continue; endif; ?>
+<?php foreach ($namespaces_by_extends_ns as $namespace => $aliases) : ?>
 namespace <?= $namespace == '__root' ? '' : trim($namespace, '\\') ?> {
-<?php foreach($aliases as $alias): ?>
-
-    <?= $alias->getClassType() ?> <?= $alias->getExtendsClass() ?> {
-        <?php foreach($alias->getMethods() as $method): ?>
-
-        <?= trim($method->getDocComment('        ')) ?>
-
+    <?php foreach ($aliases as $alias) : ?>
+        <?= trim($alias->getDocComment('    ')) ?>
+        <?= $alias->getClassType() ?> <?= $alias->getExtendsClass() ?> {
+        <?php foreach ($alias->getMethods() as $method) : ?>
+            <?= trim($method->getDocComment('        ')) ?>
         public static function <?= $method->getName() ?>(<?= $method->getParamsWithDefault() ?>)
-        {<?php if($method->getDeclaringClass() !== $method->getRoot()): ?>
-
+        {<?php if ($method->getDeclaringClass() !== $method->getRoot()) : ?>
             //Method inherited from <?= $method->getDeclaringClass() ?>
-            <?php endif; ?>
+         <?php endif; ?>
 
-            <?= $method->shouldReturn() ? 'return ': '' ?><?= $method->getRoot() ?>::<?= $method->getName() ?>(<?= $method->getParams() ?>);
+            <?php if ($method->isInstanceCall()) : ?>
+            /** @var <?=$method->getRoot()?> $instance */
+            <?php endif?>
+            <?= $method->shouldReturn() ? 'return ' : '' ?><?= $method->getRootMethodCall() ?>;
         }
         <?php endforeach; ?>
-
-    }         
-<?php endforeach; ?>
+    }
+    <?php endforeach; ?>
 }
-    
+
 <?php endforeach; ?>
-    
+
+<?php foreach ($namespaces_by_alias_ns as $namespace => $aliases) : ?>
+namespace <?= $namespace == '__root' ? '' : trim($namespace, '\\') ?> {
+    <?php foreach ($aliases as $alias) : ?>
+        <?= $alias->getClassType() ?> <?= $alias->getShortName() ?> extends <?= $alias->getExtends() ?> {<?php if ($alias->getExtendsNamespace() == '\Illuminate\Database\Eloquent') : ?>
+            <?php foreach ($alias->getMethods() as $method) : ?>
+                <?= trim($method->getDocComment('            ')) ?>
+            public static function <?= $method->getName() ?>(<?= $method->getParamsWithDefault() ?>)
+            {<?php if ($method->getDeclaringClass() !== $method->getRoot()) : ?>
+                //Method inherited from <?= $method->getDeclaringClass() ?>
+             <?php endif; ?>
+
+                <?php if ($method->isInstanceCall()) : ?>
+                /** @var <?=$method->getRoot()?> $instance */
+                <?php endif?>
+                <?= $method->shouldReturn() ? 'return ' : '' ?><?= $method->getRootMethodCall() ?>;
+            }
+            <?php endforeach; ?>
+        <?php endif; ?>}
+    <?php endforeach; ?>
+}
+
+<?php endforeach; ?>
+
+<?php foreach($real_time_facades as $name): ?>
+<?php $nested = explode('\\', str_replace('\\' . class_basename($name), '', $name)); ?>
+namespace <?php echo implode('\\', $nested); ?> {
+    /**
+     * @mixin <?= str_replace('Facades', '', $name) ?>
+     */
+    class <?= class_basename($name) ?> extends <?= str_replace('Facades', '', $name) ?> {}
+}
+<?php endforeach; ?>
+
+<?php if ($helpers) : ?>
 namespace {
-<?= $helpers ?>
-
-<?php foreach($namespaces as $namespace => $aliases): ?>
-<?php foreach($aliases as $alias): ?>
-    <?= $alias->getClassType() ?> <?= $alias->getShortName() ?> extends <?= $alias->getExtends() ?> {<?php if ($namespace == '\Illuminate\Database\Eloquent'): ?>
-    <?php foreach($alias->getMethods() as $method): ?>
-
-        <?= trim($method->getDocComment('        ')) ?>
-
-        public static function <?= $method->getName() ?>(<?= $method->getParamsWithDefault() ?>)
-        {<?php if($method->getDeclaringClass() !== $method->getRoot()): ?>
-
-            //Method inherited from <?= $method->getDeclaringClass() ?>
-            <?php endif; ?>
-
-            <?= $method->shouldReturn() ? 'return ': '' ?><?= $method->getRoot() ?>::<?= $method->getName() ?>(<?= $method->getParams() ?>);
-        }
-        <?php endforeach; ?>
-<?php endif; ?>}
-    
-<?php endforeach; ?>
-<?php endforeach; ?>
+    <?= $helpers ?>
 }
+<?php endif; ?>
 
-<?php if($include_fluent): ?>
+<?php if ($include_fluent) : ?>
 namespace Illuminate\Support {
     /**
      * Methods commonly used in migrations
@@ -71,7 +94,7 @@ namespace Illuminate\Support {
      * @method Fluent charset(string $charset) Add the character set modifier
      * @method Fluent collation(string $collation) Add the collation modifier
      * @method Fluent comment(string $comment) Add comment
-     * @method Fluent default(mixed $value) Add the default modifier
+     * @method Fluent default($value) Add the default modifier
      * @method Fluent first() Select first row
      * @method Fluent index(string $name = null) Add the in dex clause
      * @method Fluent on(string $table) `on` of a foreign key
@@ -79,11 +102,22 @@ namespace Illuminate\Support {
      * @method Fluent onUpdate(string $action) `on update` of a foreign key
      * @method Fluent primary() Add the primary key modifier
      * @method Fluent references(string $column) `references` of a foreign key
-     * @method Fluent nullable() Add the nullable modifier
+     * @method Fluent nullable(bool $value = true) Add the nullable modifier
      * @method Fluent unique(string $name = null) Add unique index clause
      * @method Fluent unsigned() Add the unsigned modifier
      * @method Fluent useCurrent() Add the default timestamp value
+     * @method Fluent change() Add the change modifier
      */
     class Fluent {}
 }
 <?php endif ?>
+
+<?php foreach ($factories as $factory) : ?>
+namespace <?=$factory->getNamespaceName()?> {
+    /**
+    * @method \Illuminate\Database\Eloquent\Collection|<?=$factory->getShortName()?>[]|<?=$factory->getShortName()?> create($attributes = [])
+    * @method \Illuminate\Database\Eloquent\Collection|<?=$factory->getShortName()?>[]|<?=$factory->getShortName()?> make($attributes = [])
+    */
+    class <?=$factory->getShortName()?>FactoryBuilder extends \Illuminate\Database\Eloquent\FactoryBuilder {}
+}
+<?php endforeach; ?>

resources/views/meta.php

@@ -1,21 +1,68 @@
 <?= '<?php' ?>
 
+/* @noinspection ALL */
+// @formatter:off
+// phpcs:ignoreFile
+
 namespace PHPSTORM_META {
 
    /**
     * PhpStorm Meta file, to provide autocomplete information for PhpStorm
-    * Generated on <?= date("Y-m-d") ?>.
     *
     * @author Barry vd. Heuvel <[email protected]>
     * @see https://github.com/barryvdh/laravel-ide-helper
     */
-    $STATIC_METHOD_TYPES = [
-<?php foreach($methods as $method): ?>
-        <?= $method ?> => [
-            '' == '@',
-<?php foreach($bindings as $abstract => $class): ?>
-            '<?= $abstract ?>' instanceof \<?= $class ?>,
-<?php endforeach ?>        ],
-<?php endforeach ?>
-    ];
+<?php foreach ($methods as $method) : ?>
+    override(<?= $method ?>, map([
+        '' => '@',
+    <?php foreach ($bindings as $abstract => $class) : ?>
+        '<?= $abstract ?>' => \<?= $class ?>::class,
+    <?php endforeach; ?>
+    ]));
+<?php endforeach; ?>
+
+<?php if (count($factories)) : ?>
+    override(\factory(0), map([
+        '' => '@FactoryBuilder',
+    <?php foreach ($factories as $factory) : ?>
+        '<?= $factory->getName() ?>' => \<?= $factory->getName() ?>FactoryBuilder::class,
+    <?php endforeach; ?>
+    ]));
+<?php endif; ?>
+
+    override(\Illuminate\Foundation\Testing\Concerns\InteractsWithContainer::mock(0), map(["" => "@&\Mockery\MockInterface"]));
+    override(\Illuminate\Foundation\Testing\Concerns\InteractsWithContainer::partialMock(0), map(["" => "@&\Mockery\MockInterface"]));
+    override(\Illuminate\Foundation\Testing\Concerns\InteractsWithContainer::instance(0), type(1));
+    override(\Illuminate\Foundation\Testing\Concerns\InteractsWithContainer::spy(0), map(["" => "@&\Mockery\MockInterface"]));
+    override(\Illuminate\Support\Arr::add(0), type(0));
+    override(\Illuminate\Support\Arr::except(0), type(0));
+    override(\Illuminate\Support\Arr::first(0), elementType(0));
+    override(\Illuminate\Support\Arr::last(0), elementType(0));
+    override(\Illuminate\Support\Arr::get(0), elementType(0));
+    override(\Illuminate\Support\Arr::only(0), type(0));
+    override(\Illuminate\Support\Arr::prepend(0), type(0));
+    override(\Illuminate\Support\Arr::pull(0), elementType(0));
+    override(\Illuminate\Support\Arr::set(0), type(0));
+    override(\Illuminate\Support\Arr::shuffle(0), type(0));
+    override(\Illuminate\Support\Arr::sort(0), type(0));
+    override(\Illuminate\Support\Arr::sortRecursive(0), type(0));
+    override(\Illuminate\Support\Arr::where(0), type(0));
+    override(\array_add(0), type(0));
+    override(\array_except(0), type(0));
+    override(\array_first(0), elementType(0));
+    override(\array_last(0), elementType(0));
+    override(\array_get(0), elementType(0));
+    override(\array_only(0), type(0));
+    override(\array_prepend(0), type(0));
+    override(\array_pull(0), elementType(0));
+    override(\array_set(0), type(0));
+    override(\array_sort(0), type(0));
+    override(\array_sort_recursive(0), type(0));
+    override(\array_where(0), type(0));
+    override(\head(0), elementType(0));
+    override(\last(0), elementType(0));
+    override(\with(0), type(0));
+    override(\tap(0), type(0));
+    override(\optional(0), type(0));
+
 }

src/Alias.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Laravel IDE Helper Generator
  *
@@ -10,9 +11,21 @@
 
 namespace Barryvdh\LaravelIdeHelper;
 
+use Barryvdh\Reflection\DocBlock;
+use Barryvdh\Reflection\DocBlock\Context;
+use Barryvdh\Reflection\DocBlock\Serializer as DocBlockSerializer;
+use Barryvdh\Reflection\DocBlock\Tag\MethodTag;
+use Closure;
+use Illuminate\Config\Repository as ConfigRepository;
+use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
+use Illuminate\Support\Facades\Facade;
+use ReflectionClass;
+use Throwable;
+
 class Alias
 {
     protected $alias;
+    /** @psalm-var class-string $facade */
     protected $facade;
     protected $extends = null;
     protected $extendsClass = null;
@@ -21,24 +34,32 @@ class Alias
     protected $short;
     protected $namespace = '__root';
     protected $root = null;
-    protected $classes = array();
-    protected $methods = array();
-    protected $usedMethods = array();
+    protected $classes = [];
+    protected $methods = [];
+    protected $usedMethods = [];
     protected $valid = false;
-    protected $magicMethods = array();
-    protected $interfaces = array();
+    protected $magicMethods = [];
+    protected $interfaces = [];
+    protected $phpdoc = null;
+    protected $classAliases = [];
+
+    /** @var ConfigRepository  */
+    protected $config;
 
     /**
-     * @param string $alias
-     * @param string $facade
-     * @param array $magicMethods
-     * @param array $interfaces
+     * @param ConfigRepository $config
+     * @param string           $alias
+     * @psalm-param class-string $facade
+     * @param string           $facade
+     * @param array            $magicMethods
+     * @param array            $interfaces
      */
-    public function __construct($alias, $facade, $magicMethods = array(), $interfaces = array())
+    public function __construct($config, $alias, $facade, $magicMethods = [], $interfaces = [])
     {
         $this->alias = $alias;
         $this->magicMethods = $magicMethods;
         $this->interfaces = $interfaces;
+        $this->config = $config;
 
         // Make the class absolute
         $facade = '\\' . ltrim($facade, '\\');
@@ -46,19 +67,27 @@ class Alias
 
         $this->detectRoot();
 
-        if ((!$this->isTrait() && $this->root)) {
-            $this->valid = true;
-        } else {
+        if (!$this->root || $this->isTrait()) {
             return;
         }
 
+        $this->valid = true;
+
         $this->addClass($this->root);
+        $this->detectFake();
         $this->detectNamespace();
         $this->detectClassType();
         $this->detectExtendsNamespace();
-        
+
+        if (!empty($this->namespace)) {
+            $this->classAliases = (new UsesResolver())->loadFromClass($this->root);
+
+            //Create a DocBlock and serializer instance
+            $this->phpdoc = new DocBlock(new ReflectionClass($alias), new Context($this->namespace, $this->classAliases));
+        }
+
         if ($facade === '\Illuminate\Database\Eloquent\Model') {
-            $this->usedMethods = array('decrement', 'increment');
+            $this->usedMethods = ['decrement', 'increment'];
         }
     }
 
@@ -107,7 +136,7 @@ class Alias
     {
         return $this->extends;
     }
-    
+
     /**
      * Get the class short name which this alias extends
      *
@@ -117,7 +146,7 @@ class Alias
     {
         return $this->extendsClass;
     }
-    
+
     /**
      * Get the namespace of the class which this alias extends
      *
@@ -158,15 +187,47 @@ class Alias
     /**
      * Get the methods found by this Alias
      *
-     * @return array
+     * @return array|Method[]
      */
     public function getMethods()
     {
+        if (count($this->methods) > 0) {
+            return $this->methods;
+        }
+
         $this->addMagicMethods();
         $this->detectMethods();
         return $this->methods;
     }
 
+    /**
+     * Detect class returned by ::fake()
+     */
+    protected function detectFake()
+    {
+        $facade = $this->facade;
+
+        if (!is_subclass_of($facade, Facade::class)) {
+            return;
+        }
+
+        if (!method_exists($facade, 'fake')) {
+            return;
+        }
+
+        $real = $facade::getFacadeRoot();
+
+        try {
+            $facade::fake();
+            $fake = $facade::getFacadeRoot();
+            if ($fake !== $real) {
+                $this->addClass(get_class($fake));
+            }
+        } finally {
+            $facade::swap($real);
+        }
+    }
+
     /**
      * Detect the namespace
      */
@@ -180,7 +241,7 @@ class Alias
             $this->short = $this->alias;
         }
     }
-    
+
     /**
      * Detect the extends namespace
      */
@@ -237,12 +298,12 @@ class Alias
             //When the database connection is not set, some classes will be skipped
         } catch (\PDOException $e) {
             $this->error(
-                "PDOException: " . $e->getMessage() .
+                'PDOException: ' . $e->getMessage() .
                 "\nPlease configure your database connection correctly, or use the sqlite memory driver (-M)." .
                 " Skipping $facade."
             );
-        } catch (\Exception $e) {
-            $this->error("Exception: " . $e->getMessage() . "\nSkipping $facade.");
+        } catch (Throwable $e) {
+            $this->error('Exception: ' . $e->getMessage() . "\nSkipping $facade.");
         }
     }
 
@@ -254,10 +315,7 @@ class Alias
     protected function isTrait()
     {
         // Check if the facade is not a Trait
-        if (function_exists('trait_exists') && trait_exists($this->facade)) {
-            return true;
-        }
-        return false;
+        return trait_exists($this->facade);
     }
 
     /**
@@ -266,16 +324,16 @@ class Alias
     protected function addMagicMethods()
     {
         foreach ($this->magicMethods as $magic => $real) {
-            list($className, $name) = explode('::', $real);
-            if (!class_exists($className) && !interface_exists($className)) {
+            [$className, $name] = explode('::', $real);
+            if ((!class_exists($className) && !interface_exists($className)) || !method_exists($className, $name)) {
                 continue;
             }
             $method = new \ReflectionMethod($className, $name);
-            $class = new \ReflectionClass($className);
+            $class = new ReflectionClass($className);
 
-            if (!in_array($method->name, $this->usedMethods)) {
+            if (!in_array($magic, $this->usedMethods)) {
                 if ($class !== $this->root) {
-                    $this->methods[] = new Method($method, $this->alias, $class, $magic, $this->interfaces);
+                    $this->methods[] = new Method($method, $this->alias, $class, $magic, $this->interfaces, $this->classAliases);
                 }
                 $this->usedMethods[] = $magic;
             }
@@ -289,9 +347,8 @@ class Alias
      */
     protected function detectMethods()
     {
-
         foreach ($this->classes as $class) {
-            $reflection = new \ReflectionClass($class);
+            $reflection = new ReflectionClass($class);
 
             $methods = $reflection->getMethods(\ReflectionMethod::IS_PUBLIC);
             if ($methods) {
@@ -305,13 +362,102 @@ class Alias
                                 $this->alias,
                                 $reflection,
                                 $method->name,
-                                $this->interfaces
+                                $this->interfaces,
+                                $this->classAliases
                             );
                         }
                         $this->usedMethods[] = $method->name;
                     }
                 }
             }
+
+            // Check if the class is macroable
+            // (Eloquent\Builder is also macroable but doesn't use Macroable trait)
+            $traits = collect($reflection->getTraitNames());
+            if ($traits->contains('Illuminate\Support\Traits\Macroable') || $class === EloquentBuilder::class) {
+                $properties = $reflection->getStaticProperties();
+                $macros = isset($properties['macros']) ? $properties['macros'] : [];
+                foreach ($macros as $macro_name => $macro_func) {
+                    if (!in_array($macro_name, $this->usedMethods)) {
+                        // Add macros
+                        $this->methods[] = new Macro(
+                            $this->getMacroFunction($macro_func),
+                            $this->alias,
+                            $reflection,
+                            $macro_name,
+                            $this->interfaces,
+                            $this->classAliases
+                        );
+                        $this->usedMethods[] = $macro_name;
+                    }
+                }
+            }
+        }
+    }
+
+    /**
+     * @param $macro_func
+     *
+     * @return \ReflectionFunctionAbstract
+     * @throws \ReflectionException
+     */
+    protected function getMacroFunction($macro_func)
+    {
+        if (is_array($macro_func) && is_callable($macro_func)) {
+            return new \ReflectionMethod($macro_func[0], $macro_func[1]);
+        }
+
+        if (is_object($macro_func) && is_callable($macro_func) && !$macro_func instanceof Closure) {
+            return new \ReflectionMethod($macro_func, '__invoke');
+        }
+
+        return new \ReflectionFunction($macro_func);
+    }
+
+    /*
+     * Get the docblock for this alias
+     *
+     * @param string $prefix
+     * @return mixed
+     */
+    public function getDocComment($prefix = "\t\t")
+    {
+        $serializer = new DocBlockSerializer(1, $prefix);
+
+        if (!$this->phpdoc) {
+            return '';
+        }
+
+        if ($this->config->get('ide-helper.include_class_docblocks')) {
+            // if a class doesn't expose any DocBlock tags
+            // we can perform reflection on the class and
+            // add in the original class DocBlock
+            if (count($this->phpdoc->getTags()) === 0) {
+                $class = new ReflectionClass($this->root);
+                $this->phpdoc = new DocBlock($class->getDocComment());
+            }
+        }
+
+        $this->removeDuplicateMethodsFromPhpDoc();
+        return $serializer->getDocComment($this->phpdoc);
+    }
+
+    /**
+     * Removes method tags from the doc comment that already appear as functions inside the class.
+     * This prevents duplicate function errors in the IDE.
+     *
+     * @return void
+     */
+    protected function removeDuplicateMethodsFromPhpDoc()
+    {
+        $methodNames = array_map(function (Method $method) {
+            return $method->getName();
+        }, $this->getMethods());
+
+        foreach ($this->phpdoc->getTags() as $tag) {
+            if ($tag instanceof MethodTag && in_array($tag->getMethodName(), $methodNames)) {
+                $this->phpdoc->deleteTag($tag);
+            }
         }
     }
 

src/Console/EloquentCommand.php

@@ -0,0 +1,62 @@
+<?php
+
+/**
+ * Laravel IDE Helper Generator - Eloquent Model Mixin
+ *
+ * @author    Charles A. Peterson <[email protected]>
+ * @copyright 2017 Charles A. Peterson / Fruitcake Studio (http://www.fruitcakestudio.nl)
+ * @license   http://www.opensource.org/licenses/mit-license.php MIT
+ * @link      https://github.com/barryvdh/laravel-ide-helper
+ */
+
+namespace Barryvdh\LaravelIdeHelper\Console;
+
+use Barryvdh\LaravelIdeHelper\Eloquent;
+use Illuminate\Console\Command;
+use Illuminate\Filesystem\Filesystem;
+
+/**
+ * A command to add \Eloquent mixin to Eloquent\Model
+ *
+ * @author Charles A. Peterson <[email protected]>
+ */
+class EloquentCommand extends Command
+{
+    /**
+     * The console command name.
+     *
+     * @var string
+     */
+    protected $name = 'ide-helper:eloquent';
+
+    /**
+     * @var Filesystem $files
+     */
+    protected $files;
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Add \Eloquent helper to \Eloquent\Model';
+
+    /**
+     * @param Filesystem $files
+     */
+    public function __construct(Filesystem $files)
+    {
+        parent::__construct();
+        $this->files = $files;
+    }
+
+    /**
+     * Execute the console command.
+     *
+     * @return void
+     */
+    public function handle()
+    {
+        Eloquent::writeEloquentModelHelper($this, $this->files);
+    }
+}

src/Console/GeneratorCommand.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Laravel IDE Helper Generator
  *
@@ -10,12 +11,12 @@
 
 namespace Barryvdh\LaravelIdeHelper\Console;
 
+use Barryvdh\LaravelIdeHelper\Eloquent;
 use Barryvdh\LaravelIdeHelper\Generator;
-use Illuminate\Config\Repository as ConfigRepository;
 use Illuminate\Console\Command;
 use Illuminate\Filesystem\Filesystem;
-use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputOption;
 
 /**
  * A command to generate autocomplete information for your IDE
@@ -24,7 +25,6 @@ use Symfony\Component\Console\Input\InputArgument;
  */
 class GeneratorCommand extends Command
 {
-
     /**
      * The console command name.
      *
@@ -42,7 +42,7 @@ class GeneratorCommand extends Command
     /** @var \Illuminate\Config\Repository */
     protected $config;
 
-    /** @var \Illuminate\Filesystem\Filesystem */
+    /** @var Filesystem */
     protected $files;
 
     /** @var \Illuminate\View\Factory */
@@ -54,11 +54,12 @@ class GeneratorCommand extends Command
     /**
      *
      * @param \Illuminate\Config\Repository $config
-     * @param \Illuminate\Filesystem\Filesystem $files
+     * @param Filesystem $files
      * @param \Illuminate\View\Factory $view
      */
     public function __construct(
-        /*ConfigRepository */ $config,
+        /*ConfigRepository */
+        $config,
         Filesystem $files,
         /* Illuminate\View\Factory */
         $view
@@ -74,50 +75,55 @@ class GeneratorCommand extends Command
      *
      * @return void
      */
-    public function fire()
+    public function handle()
     {
-        if (file_exists(base_path() . '/vendor/compiled.php') ||
+        if (
+            file_exists(base_path() . '/vendor/compiled.php') ||
             file_exists(base_path() . '/bootstrap/cache/compiled.php') ||
-            file_exists(base_path() . '/storage/framework/compiled.php')) {
+            file_exists(base_path() . '/storage/framework/compiled.php')
+        ) {
             $this->error(
                 'Error generating IDE Helper: first delete your compiled file (php artisan clear-compiled)'
             );
-        } else {
-            $filename = $this->argument('filename');
-            $format = $this->option('format');
+            return;
+        }
 
-            // Strip the php extension
-            if (substr($filename, -4, 4) == '.php') {
-                $filename = substr($filename, 0, -4);
-            }
+        $filename = $this->argument('filename');
 
-            $filename .= '.' . $format;
+        // Add the php extension if missing
+        // This is a backwards-compatible shim and can be removed in the future
+        if (substr($filename, -4, 4) !== '.php') {
+            $filename .= '.php';
+        }
 
-            if ($this->option('memory')) {
-                $this->useMemoryDriver();
-            }
+        if ($this->option('memory')) {
+            $this->useMemoryDriver();
+        }
 
 
-            $helpers = '';
-            if ($this->option('helpers') || ($this->config->get('ide-helper.include_helpers'))) {
-                foreach ($this->config->get('ide-helper.helper_files', array()) as $helper) {
-                    if (file_exists($helper)) {
-                        $helpers .= str_replace(array('<?php', '?>'), '', $this->files->get($helper));
-                    }
+        $helpers = '';
+        if ($this->option('helpers') || ($this->config->get('ide-helper.include_helpers'))) {
+            foreach ($this->config->get('ide-helper.helper_files', []) as $helper) {
+                if (file_exists($helper)) {
+                    $helpers .= str_replace(['<?php', '?>'], '', $this->files->get($helper));
                 }
-            } else {
-                $helpers = '';
             }
+        } else {
+            $helpers = '';
+        }
 
-            $generator = new Generator($this->config, $this->view, $this->getOutput(), $helpers);
-            $content = $generator->generate($format);
-            $written = $this->files->put($filename, $content);
+        $generator = new Generator($this->config, $this->view, $this->getOutput(), $helpers);
+        $content = $generator->generate();
+        $written = $this->files->put($filename, $content);
 
-            if ($written !== false) {
-                $this->info("A new helper file was written to $filename");
-            } else {
-                $this->error("The helper file could not be created at $filename");
+        if ($written !== false) {
+            $this->info("A new helper file was written to $filename");
+
+            if ($this->option('write_mixins')) {
+                Eloquent::writeEloquentModelHelper($this, $this->files);
             }
+        } else {
+            $this->error("The helper file could not be created at $filename");
         }
     }
 
@@ -126,10 +132,10 @@ class GeneratorCommand extends Command
         //Use a sqlite database in memory, to avoid connection errors on Database facades
         $this->config->set(
             'database.connections.sqlite',
-            array(
+            [
                 'driver' => 'sqlite',
                 'database' => ':memory:',
-            )
+            ]
         );
         $this->config->set('database.default', 'sqlite');
     }
@@ -143,11 +149,11 @@ class GeneratorCommand extends Command
     {
         $filename = $this->config->get('ide-helper.filename');
 
-        return array(
-            array(
-                'filename', InputArgument::OPTIONAL, 'The path to the helper file', $filename
-            ),
-        );
+        return [
+            [
+                'filename', InputArgument::OPTIONAL, 'The path to the helper file', $filename,
+            ],
+        ];
     }
 
     /**
@@ -157,13 +163,12 @@ class GeneratorCommand extends Command
      */
     protected function getOptions()
     {
-        $format = $this->config->get('ide-helper.format');
+        $writeMixins = $this->config->get('ide-helper.write_eloquent_model_mixins');
 
-        return array(
-            array('format', "F", InputOption::VALUE_OPTIONAL, 'The format for the IDE Helper', $format),
-            array('helpers', "H", InputOption::VALUE_NONE, 'Include the helper files'),
-            array('memory', "M", InputOption::VALUE_NONE, 'Use sqlite memory driver'),
-            array('sublime', "S", InputOption::VALUE_NONE, 'DEPRECATED: Use different style for SublimeText CodeIntel'),
-        );
+        return [
+            ['write_mixins', 'W', InputOption::VALUE_OPTIONAL, 'Write mixins to Laravel Model?', $writeMixins],
+            ['helpers', 'H', InputOption::VALUE_NONE, 'Include the helper files'],
+            ['memory', 'M', InputOption::VALUE_NONE, 'Use sqlite memory driver'],
+        ];
     }
 }

src/Console/MetaCommand.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Laravel IDE Helper Generator
  *
@@ -10,7 +11,9 @@
 
 namespace Barryvdh\LaravelIdeHelper\Console;
 
+use Barryvdh\LaravelIdeHelper\Factories;
 use Illuminate\Console\Command;
+use RuntimeException;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 
@@ -21,14 +24,12 @@ use Symfony\Component\Console\Output\OutputInterface;
  */
 class MetaCommand extends Command
 {
-
     /**
      * The console command name.
      *
      * @var string
      */
     protected $name = 'ide-helper:meta';
-    protected $filename = '.phpstorm.meta.php';
 
     /**
      * The console command description.
@@ -42,23 +43,35 @@ class MetaCommand extends Command
 
     /** @var \Illuminate\Contracts\View\Factory */
     protected $view;
-    
+
+    /** @var \Illuminate\Contracts\Config\Repository */
+    protected $config;
+
     protected $methods = [
       'new \Illuminate\Contracts\Container\Container',
-      '\Illuminate\Contracts\Container\Container::make(\'\')',
-      '\App::make(\'\')',
-      '\app(\'\')',
+      '\Illuminate\Container\Container::makeWith(0)',
+      '\Illuminate\Contracts\Container\Container::get(0)',
+      '\Illuminate\Contracts\Container\Container::make(0)',
+      '\Illuminate\Contracts\Container\Container::makeWith(0)',
+      '\App::get(0)',
+      '\App::make(0)',
+      '\App::makeWith(0)',
+      '\app(0)',
+      '\resolve(0)',
+      '\Psr\Container\ContainerInterface::get(0)',
     ];
 
     /**
      *
      * @param \Illuminate\Contracts\Filesystem\Filesystem $files
      * @param \Illuminate\Contracts\View\Factory $view
+     * @param \Illuminate\Contracts\Config\Repository $config
      */
-    public function __construct($files, $view)
+    public function __construct($files, $view, $config)
     {
         $this->files = $files;
         $this->view = $view;
+        $this->config = $config;
         parent::__construct();
     }
 
@@ -67,32 +80,44 @@ class MetaCommand extends Command
      *
      * @return void
      */
-    public function fire()
+    public function handle()
     {
-        $this->registerClassAutoloadExceptions();
+        // Needs to run before exception handler is registered
+        $factories = $this->config->get('ide-helper.include_factory_builders') ? Factories::all() : [];
 
-        $bindings = array();
+        $ourAutoloader = $this->registerClassAutoloadExceptions();
+
+        $bindings = [];
         foreach ($this->getAbstracts() as $abstract) {
             // Validator and seeder cause problems
             if (in_array($abstract, ['validator', 'seeder'])) {
                 continue;
             }
-            
+
             try {
                 $concrete = $this->laravel->make($abstract);
-                if (is_object($concrete)) {
+
+                if ($concrete === null) {
+                    throw new RuntimeException("Cannot create instance for '$abstract', received 'null'");
+                }
+
+                $reflectionClass = new \ReflectionClass($concrete);
+                if (is_object($concrete) && !$reflectionClass->isAnonymous()) {
                     $bindings[$abstract] = get_class($concrete);
                 }
-            } catch (\Exception $e) {
+            } catch (\Throwable $e) {
                 if ($this->output->getVerbosity() >= OutputInterface::VERBOSITY_VERBOSE) {
-                    $this->comment("Cannot make '$abstract': ".$e->getMessage());
+                    $this->comment("Cannot make '$abstract': " . $e->getMessage());
                 }
             }
         }
 
-        $content = $this->view->make('ide-helper::meta', [
+        $this->unregisterClassAutoloadExceptions($ourAutoloader);
+
+        $content = $this->view->make('meta', [
           'bindings' => $bindings,
           'methods' => $this->methods,
+          'factories' => $factories,
         ])->render();
 
         $filename = $this->option('filename');
@@ -113,19 +138,27 @@ class MetaCommand extends Command
     protected function getAbstracts()
     {
         $abstracts = $this->laravel->getBindings();
-        
+
         // Return the abstract names only
-        return array_keys($abstracts);
+        $keys = array_keys($abstracts);
+
+        sort($keys);
+
+        return $keys;
     }
 
     /**
      * Register an autoloader the throws exceptions when a class is not found.
+     *
+     * @return callable
      */
-    protected function registerClassAutoloadExceptions()
+    protected function registerClassAutoloadExceptions(): callable
     {
-        spl_autoload_register(function ($class) {
-            throw new \Exception("Class '$class' not found.");
-        });
+        $autoloader = function ($class) {
+            throw new \ReflectionException("Class '$class' not found.");
+        };
+        spl_autoload_register($autoloader);
+        return $autoloader;
     }
 
     /**
@@ -135,8 +168,20 @@ class MetaCommand extends Command
      */
     protected function getOptions()
     {
-        return array(
-            array('filename', 'F', InputOption::VALUE_OPTIONAL, 'The path to the meta file', $this->filename),
-        );
+        $filename = $this->config->get('ide-helper.meta_filename');
+
+        return [
+            ['filename', 'F', InputOption::VALUE_OPTIONAL, 'The path to the meta file', $filename],
+        ];
+    }
+
+    /**
+     * Remove our custom autoloader that we pushed onto the autoload stack
+     *
+     * @param callable $ourAutoloader
+     */
+    private function unregisterClassAutoloadExceptions(callable $ourAutoloader): void
+    {
+        spl_autoload_unregister($ourAutoloader);
     }
 }

src/Contracts/ModelHookInterface.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Barryvdh\LaravelIdeHelper\Contracts;
+
+use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
+use Illuminate\Database\Eloquent\Model;
+
+interface ModelHookInterface
+{
+    public function run(ModelsCommand $command, Model $model): void;
+}

src/Eloquent.php

@@ -0,0 +1,113 @@
+<?php
+
+/**
+ * Laravel IDE Helper to add \Eloquent mixin to Eloquent\Model
+ *
+ * @author Charles A. Peterson <artistan@gmail.com>
+ */
+
+namespace Barryvdh\LaravelIdeHelper;
+
+use Barryvdh\Reflection\DocBlock;
+use Barryvdh\Reflection\DocBlock\Context;
+use Barryvdh\Reflection\DocBlock\Serializer as DocBlockSerializer;
+use Barryvdh\Reflection\DocBlock\Tag;
+use Illuminate\Console\Command;
+use Illuminate\Filesystem\Filesystem;
+
+class Eloquent
+{
+    /**
+     * Write mixin helper to the Eloquent\Model
+     * This is needed since laravel/framework v5.4.29
+     *
+     * @param Command    $command
+     * @param Filesystem $files
+     *
+     * @return void
+     */
+    public static function writeEloquentModelHelper(Command $command, Filesystem $files)
+    {
+        $class = 'Illuminate\Database\Eloquent\Model';
+
+        $reflection  = new \ReflectionClass($class);
+        $namespace   = $reflection->getNamespaceName();
+        $originalDoc = $reflection->getDocComment();
+
+        if (!$originalDoc) {
+            $command->info('Unexpected no document on ' . $class);
+        }
+        $phpdoc = new DocBlock($reflection, new Context($namespace));
+
+        $mixins = $phpdoc->getTagsByName('mixin');
+        $expectedMixins = [
+            '\Eloquent'                             => false,
+            '\Illuminate\Database\Eloquent\Builder' => false,
+            '\Illuminate\Database\Query\Builder'    => false,
+        ];
+
+        foreach ($mixins as $m) {
+            $mixin = $m->getContent();
+
+            if (isset($expectedMixins[$mixin])) {
+                $command->info('Tag Exists: @mixin ' . $mixin . ' in ' . $class);
+
+                $expectedMixins[$mixin] = true;
+            }
+        }
+
+        $changed = false;
+        foreach ($expectedMixins as $expectedMixin => $present) {
+            if ($present === false) {
+                $phpdoc->appendTag(Tag::createInstance('@mixin ' . $expectedMixin, $phpdoc));
+
+                $changed = true;
+            }
+        }
+
+        // If nothing's changed, stop here.
+        if (!$changed) {
+            return;
+        }
+
+        $serializer = new DocBlockSerializer();
+        $serializer->getDocComment($phpdoc);
+        $docComment = $serializer->getDocComment($phpdoc);
+
+        /*
+            The new DocBlock is appended to the beginning of the class declaration.
+            Since there is no DocBlock, the declaration is used as a guide.
+        */
+        if (!$originalDoc) {
+            $originalDoc = 'abstract class Model implements';
+
+            $docComment .= "\nabstract class Model implements";
+        }
+
+        $filename = $reflection->getFileName();
+        if (!$filename) {
+            $command->error('Filename not found ' . $class);
+            return;
+        }
+
+        $contents = $files->get($filename);
+        if (!$contents) {
+            $command->error('No file contents found ' . $filename);
+            return;
+        }
+
+        $count = 0;
+        $contents = str_replace($originalDoc, $docComment, $contents, $count);
+        if ($count <= 0) {
+            $command->error('Content did not change ' . $contents);
+            return;
+        }
+
+        if (!$files->put($filename, $contents)) {
+            $command->error('File write failed to ' . $filename);
+            return;
+        }
+
+        $command->info('Wrote expected docblock to ' . $filename);
+    }
+}

src/Factories.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace Barryvdh\LaravelIdeHelper;
+
+use Exception;
+use Illuminate\Database\Eloquent\Factory;
+use ReflectionClass;
+
+class Factories
+{
+    public static function all()
+    {
+        $factories = [];
+
+        if (static::isLaravelSevenOrLower()) {
+            $factory = app(Factory::class);
+
+            $definitions = (new ReflectionClass(Factory::class))->getProperty('definitions');
+            $definitions->setAccessible(true);
+
+            foreach ($definitions->getValue($factory) as $factory_target => $config) {
+                try {
+                    $factories[] = new ReflectionClass($factory_target);
+                } catch (Exception $exception) {
+                }
+            }
+        }
+
+        return $factories;
+    }
+
+    protected static function isLaravelSevenOrLower()
+    {
+        return class_exists('Illuminate\Database\Eloquent\Factory');
+    }
+}

src/Generator.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Laravel IDE Helper Generator
  *
@@ -10,9 +11,15 @@
 
 namespace Barryvdh\LaravelIdeHelper;
 
-use Illuminate\Foundation\Application;
 use Illuminate\Foundation\AliasLoader;
-use Illuminate\Config\Repository as ConfigRepository;
+use Illuminate\Support\Collection;
+use Illuminate\Support\Facades\Facade;
+use Illuminate\Support\Str;
+use Illuminate\Support\Traits\Macroable;
+use PhpParser\Lexer\Emulative;
+use PhpParser\Node\Stmt\Class_;
+use PhpParser\Node\Stmt\Namespace_;
+use PhpParser\Parser\Php7;
 use ReflectionClass;
 use Symfony\Component\Console\Output\OutputInterface;
 
@@ -24,23 +31,25 @@ class Generator
     /** @var \Illuminate\View\Factory */
     protected $view;
 
-    /** @var \Symfony\Component\Console\Output\OutputInterface */
+    /** @var OutputInterface */
     protected $output;
 
-    protected $extra = array();
-    protected $magic = array();
-    protected $interfaces = array();
+    protected $extra = [];
+    protected $magic = [];
+    protected $interfaces = [];
     protected $helpers;
 
     /**
      * @param \Illuminate\Config\Repository $config
      * @param \Illuminate\View\Factory $view
-     * @param \Symfony\Component\Console\Output\OutputInterface $output
+     * @param OutputInterface $output
      * @param string $helpers
      */
     public function __construct(
-        /*ConfigRepository */ $config,
-        /* Illuminate\View\Factory */ $view,
+        /*ConfigRepository */
+        $config,
+        /* Illuminate\View\Factory */
+        $view,
         OutputInterface $output = null,
         $helpers = ''
     ) {
@@ -50,9 +59,9 @@ class Generator
         // Find the drivers to add to the extra/interfaces
         $this->detectDrivers();
 
-        $this->extra = array_merge($this->extra, $this->config->get('ide-helper.extra'));
-        $this->magic = array_merge($this->magic, $this->config->get('ide-helper.magic'));
-        $this->interfaces = array_merge($this->interfaces, $this->config->get('ide-helper.interfaces'));
+        $this->extra = array_merge($this->extra, $this->config->get('ide-helper.extra'), []);
+        $this->magic = array_merge($this->magic, $this->config->get('ide-helper.magic'), []);
+        $this->interfaces = array_merge($this->interfaces, $this->config->get('ide-helper.interfaces'), []);
         // Make all interface classes absolute
         foreach ($this->interfaces as &$interface) {
             $interface = '\\' . ltrim($interface, '\\');
@@ -63,76 +72,34 @@ class Generator
     /**
      * Generate the helper file contents;
      *
-     * @param  string  $format  The format to generate the helper in (php/json)
      * @return string;
      */
-    public function generate($format = 'php')
-    {
-        // Check if the generator for this format exists
-        $method = 'generate'.ucfirst($format).'Helper';
-        if (method_exists($this, $method)) {
-            return $this->$method();
-        }
-
-        return $this->generatePhpHelper();
-    }
-
-    public function generatePhpHelper()
+    public function generate()
     {
         $app = app();
-        return $this->view->make('ide-helper::helper')
-            ->with('namespaces', $this->getNamespaces())
+        return $this->view->make('helper')
+            ->with('namespaces_by_extends_ns', $this->getAliasesByExtendsNamespace())
+            ->with('namespaces_by_alias_ns', $this->getAliasesByAliasNamespace())
+            ->with('real_time_facades', $this->getRealTimeFacades())
             ->with('helpers', $this->helpers)
             ->with('version', $app->version())
-            ->with('include_fluent', $this->config->get('ide-helper.include_fluent', false))
+            ->with('include_fluent', $this->config->get('ide-helper.include_fluent', true))
+            ->with('factories', $this->config->get('ide-helper.include_factory_builders') ? Factories::all() : [])
             ->render();
     }
 
-    public function generateJsonHelper()
-    {
-        $classes = array();
-        foreach ($this->getNamespaces() as $aliases) {
-            foreach ($aliases as $alias) {
-                $functions = array();
-                foreach ($alias->getMethods() as $method) {
-                    $functions[$method->getName()] = '('. $method->getParamsWithDefault().')';
-                }
-                $classes[$alias->getAlias()] = array(
-                    'functions' => $functions,
-                );
-            }
-        }
-
-        $flags = JSON_FORCE_OBJECT;
-        if (defined('JSON_PRETTY_PRINT')) {
-            $flags |= JSON_PRETTY_PRINT;
-        }
-
-        return json_encode(array(
-            'php' => array(
-                'classes' => $classes,
-            ),
-        ), $flags);
-    }
-
     protected function detectDrivers()
     {
         $defaultUserModel = config('auth.providers.users.model', config('auth.model', 'App\User'));
         $this->interfaces['\Illuminate\Contracts\Auth\Authenticatable'] = $defaultUserModel;
 
         try {
-            if (class_exists('Auth') && is_a('Auth', '\Illuminate\Support\Facades\Auth', true)) {
-                if (class_exists('\Illuminate\Foundation\Application')) {
-                    $authMethod = version_compare(Application::VERSION, '5.2', '>=') ? 'guard' : 'driver';
-                } else {
-                    $refClass = new ReflectionClass('\Laravel\Lumen\Application');
-                    $versionStr = $refClass->newInstanceWithoutConstructor()->version();
-                    $authMethod = strpos($versionStr, 'Lumen (5.0') === 0 ?
-                        'driver' :
-                        (strpos($versionStr, 'Lumen (5.1') === 0 ? 'driver' : 'guard');
-                }
-                $class = get_class(\Auth::$authMethod());
-                $this->extra['Auth'] = array($class);
+            if (
+                class_exists('Auth') && is_a('Auth', '\Illuminate\Support\Facades\Auth', true)
+                && app()->bound('auth')
+            ) {
+                $class = get_class(\Auth::guard());
+                $this->extra['Auth'] = [$class];
                 $this->interfaces['\Illuminate\Auth\UserProviderInterface'] = $class;
             }
         } catch (\Exception $e) {
@@ -141,7 +108,7 @@ class Generator
         try {
             if (class_exists('DB') && is_a('DB', '\Illuminate\Support\Facades\DB', true)) {
                 $class = get_class(\DB::connection());
-                $this->extra['DB'] = array($class);
+                $this->extra['DB'] = [$class];
                 $this->interfaces['\Illuminate\Database\ConnectionInterface'] = $class;
             }
         } catch (\Exception $e) {
@@ -151,7 +118,7 @@ class Generator
             if (class_exists('Cache') && is_a('Cache', '\Illuminate\Support\Facades\Cache', true)) {
                 $driver = get_class(\Cache::driver());
                 $store = get_class(\Cache::getStore());
-                $this->extra['Cache'] = array($driver, $store);
+                $this->extra['Cache'] = [$driver, $store];
                 $this->interfaces['\Illuminate\Cache\StoreInterface'] = $store;
             }
         } catch (\Exception $e) {
@@ -160,25 +127,16 @@ class Generator
         try {
             if (class_exists('Queue') && is_a('Queue', '\Illuminate\Support\Facades\Queue', true)) {
                 $class = get_class(\Queue::connection());
-                $this->extra['Queue'] = array($class);
+                $this->extra['Queue'] = [$class];
                 $this->interfaces['\Illuminate\Queue\QueueInterface'] = $class;
             }
         } catch (\Exception $e) {
         }
 
-        try {
-            if (class_exists('SSH') && is_a('SSH', '\Illuminate\Support\Facades\SSH', true)) {
-                $class = get_class(\SSH::connection());
-                $this->extra['SSH'] = array($class);
-                $this->interfaces['\Illuminate\Remote\ConnectionInterface'] = $class;
-            }
-        } catch (\Exception $e) {
-        }
-
         try {
             if (class_exists('Storage') && is_a('Storage', '\Illuminate\Support\Facades\Storage', true)) {
                 $class = get_class(\Storage::disk());
-                $this->extra['Storage'] = array($class);
+                $this->extra['Storage'] = [$class];
                 $this->interfaces['\Illuminate\Contracts\Filesystem\Filesystem'] = $class;
             }
         } catch (\Exception $e) {
@@ -186,38 +144,114 @@ class Generator
     }
 
     /**
-     * Find all namespaces/aliases that are valid for us to render
+     * Find all aliases that are valid for us to render
      *
-     * @return array
+     * @return Collection
      */
-    protected function getNamespaces()
+    protected function getValidAliases()
     {
-        $namespaces = array();
+        $aliases = new Collection();
 
         // Get all aliases
         foreach ($this->getAliases() as $name => $facade) {
             // Skip the Redis facade, if not available (otherwise Fatal PHP Error)
-            if ($facade == 'Illuminate\Support\Facades\Redis' && !class_exists('Predis\Client')) {
+            if ($facade == 'Illuminate\Support\Facades\Redis' && $name == 'Redis' && !class_exists('Predis\Client')) {
                 continue;
             }
 
-            $magicMethods = array_key_exists($name, $this->magic) ? $this->magic[$name] : array();
-            $alias = new Alias($name, $facade, $magicMethods, $this->interfaces);
+            // Skip the swoole
+            if ($facade == 'SwooleTW\Http\Server\Facades\Server' && $name == 'Server' && !class_exists('Swoole\Http\Server')) {
+                continue;
+            }
+
+            $magicMethods = array_key_exists($name, $this->magic) ? $this->magic[$name] : [];
+            $alias = new Alias($this->config, $name, $facade, $magicMethods, $this->interfaces);
             if ($alias->isValid()) {
                 //Add extra methods, from other classes (magic static calls)
                 if (array_key_exists($name, $this->extra)) {
                     $alias->addClass($this->extra[$name]);
                 }
 
-                $namespace = $alias->getExtendsNamespace() ?: $alias->getNamespace();
-                if (!isset($namespaces[$namespace])) {
-                    $namespaces[$namespace] = array();
-                }
-                $namespaces[$namespace][] = $alias;
+                $aliases[] = $alias;
             }
         }
 
-        return $namespaces;
+        return $aliases;
+    }
+
+    protected function getRealTimeFacades()
+    {
+        $facades = [];
+        $realTimeFacadeFiles = glob(storage_path('framework/cache/facade-*.php'));
+        foreach ($realTimeFacadeFiles as $file) {
+            try {
+                $name = $this->getFullyQualifiedClassNameInFile($file);
+                $facades[$name] = $name;
+            } catch (\Exception $e) {
+                continue;
+            }
+        }
+
+        return $facades;
+    }
+
+    protected function getFullyQualifiedClassNameInFile(string $path)
+    {
+        $contents = file_get_contents($path);
+
+        $parsers = new Php7(new Emulative());
+
+        $parsed = collect($parsers->parse($contents) ?: []);
+
+        $namespace = $parsed->first(function ($node) {
+            return $node instanceof Namespace_;
+        });
+
+        if ($namespace) {
+            $name = $namespace->name->toString();
+
+            $class = collect($namespace->stmts)->first(function ($node) {
+                return $node instanceof Class_;
+            });
+
+            if ($class) {
+                $name .= '\\' . $class->name->toString();
+            }
+
+            return $name;
+        }
+    }
+
+
+
+    /**
+     * Regroup aliases by namespace of extended classes
+     *
+     * @return Collection
+     */
+    protected function getAliasesByExtendsNamespace()
+    {
+        $aliases = $this->getValidAliases()->filter(static function (Alias $alias) {
+            return is_subclass_of($alias->getExtends(), Facade::class);
+        });
+
+        $this->addMacroableClasses($aliases);
+
+        return $aliases->groupBy(function (Alias $alias) {
+            return $alias->getExtendsNamespace();
+        });
+    }
+
+    /**
+     * Regroup aliases by namespace of alias
+     *
+     * @return Collection
+     */
+    protected function getAliasesByAliasNamespace()
+    {
+        return $this->getValidAliases()->groupBy(function (Alias $alias) {
+            return $alias->getNamespace();
+        });
     }
 
     protected function getAliases()
@@ -244,45 +278,20 @@ class Generator
           'Schema' => 'Illuminate\Support\Facades\Schema',
           'Session' => 'Illuminate\Support\Facades\Session',
           'Storage' => 'Illuminate\Support\Facades\Storage',
-          //'Validator' => 'Illuminate\Support\Facades\Validator',
+          'Validator' => 'Illuminate\Support\Facades\Validator',
+          'Gate' => 'Illuminate\Support\Facades\Gate',
         ];
 
         $facades = array_merge($facades, $this->config->get('app.aliases', []));
 
         // Only return the ones that actually exist
-        return array_filter($facades, function ($alias) {
-            return class_exists($alias);
-        });
-    }
-
-    /**
-     * Get the driver/connection/store from the managers
-     *
-     * @param $alias
-     * @return array|bool|string
-     */
-    public function getDriver($alias)
-    {
-        try {
-            if ($alias == "Auth") {
-                $driver = \Auth::driver();
-            } elseif ($alias == "DB") {
-                $driver = \DB::connection();
-            } elseif ($alias == "Cache") {
-                $driver = get_class(\Cache::driver());
-                $store = get_class(\Cache::getStore());
-                return array($driver, $store);
-            } elseif ($alias == "Queue") {
-                $driver = \Queue::connection();
-            } else {
-                return false;
-            }
-
-            return get_class($driver);
-        } catch (\Exception $e) {
-            $this->error("Could not determine driver/connection for $alias.");
-            return false;
-        }
+        return array_filter(
+            $facades,
+            function ($alias) {
+                return class_exists($alias);
+            },
+            ARRAY_FILTER_USE_KEY
+        );
     }
 
     /**
@@ -299,4 +308,55 @@ class Generator
             echo $string . "\r\n";
         }
     }
+
+    /**
+     * Add all macroable classes which are not already loaded as an alias and have defined macros.
+     *
+     * @param Collection $aliases
+     */
+    protected function addMacroableClasses(Collection $aliases)
+    {
+        $macroable = $this->getMacroableClasses($aliases);
+
+        foreach ($macroable as $class) {
+            $reflection = new ReflectionClass($class);
+
+            if (!$reflection->getStaticProperties()['macros']) {
+                continue;
+            }
+
+            $aliases[] = new Alias($this->config, $class, $class, [], $this->interfaces);
+        }
+    }
+
+    /**
+     * Get all loaded macroable classes which are not loaded as an alias.
+     *
+     * @param Collection $aliases
+     * @return Collection
+     */
+    protected function getMacroableClasses(Collection $aliases)
+    {
+        return (new Collection(get_declared_classes()))
+            ->filter(function ($class) {
+                $reflection = new ReflectionClass($class);
+
+                // Filter out internal classes and class aliases
+                return !$reflection->isInternal() && $reflection->getName() === $class;
+            })
+            ->filter(function ($class) {
+                $traits = class_uses_recursive($class);
+
+                // Filter only classes with the macroable trait
+                return isset($traits[Macroable::class]);
+            })
+            ->filter(function ($class) use ($aliases) {
+                $class = Str::start($class, '\\');
+
+                // Filter out aliases
+                return !$aliases->first(function (Alias $alias) use ($class) {
+                    return $alias->getExtends() === $class;
+                });
+            });
+    }
 }

src/IdeHelperServiceProvider.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Laravel IDE Helper Generator
  *
@@ -10,21 +11,22 @@
 
 namespace Barryvdh\LaravelIdeHelper;
 
-use Illuminate\Support\ServiceProvider;
+use Barryvdh\LaravelIdeHelper\Console\EloquentCommand;
+use Barryvdh\LaravelIdeHelper\Console\GeneratorCommand;
 use Barryvdh\LaravelIdeHelper\Console\MetaCommand;
 use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
-use Barryvdh\LaravelIdeHelper\Console\GeneratorCommand;
+use Barryvdh\LaravelIdeHelper\Listeners\GenerateModelHelper;
+use Illuminate\Console\Events\CommandFinished;
+use Illuminate\Contracts\Support\DeferrableProvider;
+use Illuminate\Database\Events\MigrationsEnded;
+use Illuminate\Support\ServiceProvider;
+use Illuminate\View\Engines\EngineResolver;
+use Illuminate\View\Engines\PhpEngine;
+use Illuminate\View\Factory;
+use Illuminate\View\FileViewFinder;
 
-class IdeHelperServiceProvider extends ServiceProvider
+class IdeHelperServiceProvider extends ServiceProvider implements DeferrableProvider
 {
-
-    /**
-     * Indicates if loading of the provider is deferred.
-     *
-     * @var bool
-     */
-    protected $defer = true;
-
     /**
      * Bootstrap the application events.
      *
@@ -32,9 +34,18 @@ class IdeHelperServiceProvider extends ServiceProvider
      */
     public function boot()
     {
-        $viewPath = __DIR__.'/../resources/views';
-        $this->loadViewsFrom($viewPath, 'ide-helper');
-        
+        if (!$this->app->runningUnitTests() && $this->app['config']->get('ide-helper.post_migrate', [])) {
+            $this->app['events']->listen(CommandFinished::class, GenerateModelHelper::class);
+            $this->app['events']->listen(MigrationsEnded::class, function () {
+                GenerateModelHelper::$shouldRun = true;
+            });
+        }
+
+        if ($this->app->has('view')) {
+            $viewPath = __DIR__ . '/../resources/views';
+            $this->loadViewsFrom($viewPath, 'ide-helper');
+        }
+
         $configPath = __DIR__ . '/../config/ide-helper.php';
         if (function_exists('config_path')) {
             $publishPath = config_path('ide-helper.php');
@@ -53,11 +64,12 @@ class IdeHelperServiceProvider extends ServiceProvider
     {
         $configPath = __DIR__ . '/../config/ide-helper.php';
         $this->mergeConfigFrom($configPath, 'ide-helper');
-        
+        $localViewFactory = $this->createLocalViewFactory();
+
         $this->app->singleton(
             'command.ide-helper.generate',
-            function ($app) {
-                return new GeneratorCommand($app['config'], $app['files'], $app['view']);
+            function ($app) use ($localViewFactory) {
+                return new GeneratorCommand($app['config'], $app['files'], $localViewFactory);
             }
         );
 
@@ -67,15 +79,27 @@ class IdeHelperServiceProvider extends ServiceProvider
                 return new ModelsCommand($app['files']);
             }
         );
-        
+
         $this->app->singleton(
             'command.ide-helper.meta',
-            function ($app) {
-                return new MetaCommand($app['files'], $app['view']);
+            function ($app) use ($localViewFactory) {
+                return new MetaCommand($app['files'], $localViewFactory, $app['config']);
             }
         );
 
-        $this->commands('command.ide-helper.generate', 'command.ide-helper.models', 'command.ide-helper.meta');
+        $this->app->singleton(
+            'command.ide-helper.eloquent',
+            function ($app) {
+                return new EloquentCommand($app['files']);
+            }
+        );
+
+        $this->commands(
+            'command.ide-helper.generate',
+            'command.ide-helper.models',
+            'command.ide-helper.meta',
+            'command.ide-helper.eloquent'
+        );
     }
 
     /**
@@ -85,6 +109,22 @@ class IdeHelperServiceProvider extends ServiceProvider
      */
     public function provides()
     {
-        return array('command.ide-helper.generate', 'command.ide-helper.models');
+        return ['command.ide-helper.generate', 'command.ide-helper.models'];
+    }
+
+    /**
+     * @return Factory
+     */
+    private function createLocalViewFactory()
+    {
+        $resolver = new EngineResolver();
+        $resolver->register('php', function () {
+            return new PhpEngine($this->app['files']);
+        });
+        $finder = new FileViewFinder($this->app['files'], [__DIR__ . '/../resources/views']);
+        $factory = new Factory($resolver, $finder, $this->app['events']);
+        $factory->addExtension('php', 'php');
+
+        return $factory;
     }
 }

src/Listeners/GenerateModelHelper.php

@@ -0,0 +1,52 @@
+<?php
+
+namespace Barryvdh\LaravelIdeHelper\Listeners;
+
+use Illuminate\Console\Events\CommandFinished;
+use Illuminate\Contracts\Config\Repository as Config;
+use Illuminate\Contracts\Console\Kernel as Artisan;
+
+class GenerateModelHelper
+{
+    /**
+     * Tracks whether we should run the models command on the CommandFinished event or not.
+     * Set to true by the MigrationsEnded event, needs to be cleared before artisan call to prevent infinite loop.
+     *
+     * @var bool
+     */
+    public static $shouldRun = false;
+
+    /** @var Artisan */
+    protected $artisan;
+
+    /** @var Config */
+    protected $config;
+
+    /**
+     * @param  Artisan  $artisan
+     * @param  Config  $config
+     */
+    public function __construct(Artisan $artisan, Config $config)
+    {
+        $this->artisan = $artisan;
+        $this->config = $config;
+    }
+
+    /**
+     * Handle the event.
+     *
+     * @param  CommandFinished  $event
+     */
+    public function handle(CommandFinished $event)
+    {
+        if (!self::$shouldRun) {
+            return;
+        }
+
+        self::$shouldRun = false;
+
+        foreach ($this->config->get('ide-helper.post_migrate', []) as $command) {
+            $this->artisan->call($command, [], $event->output);
+        }
+    }
+}

src/Macro.php

@@ -0,0 +1,127 @@
+<?php
+
+namespace Barryvdh\LaravelIdeHelper;
+
+use Barryvdh\Reflection\DocBlock;
+use Barryvdh\Reflection\DocBlock\Tag;
+use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
+use Illuminate\Support\Collection;
+
+class Macro extends Method
+{
+    /**
+     * Macro constructor.
+     *
+     * @param \ReflectionFunctionAbstract $method
+     * @param string              $alias
+     * @param \ReflectionClass    $class
+     * @param null                $methodName
+     * @param array               $interfaces
+     * @param array               $classAliases
+     */
+    public function __construct(
+        $method,
+        $alias,
+        $class,
+        $methodName = null,
+        $interfaces = [],
+        $classAliases = []
+    ) {
+        parent::__construct($method, $alias, $class, $methodName, $interfaces, $classAliases);
+    }
+
+    /**
+     * @param \ReflectionFunctionAbstract $method
+     */
+    protected function initPhpDoc($method)
+    {
+        $this->phpdoc = new DocBlock($method);
+
+        $this->addLocationToPhpDoc();
+
+        // Add macro parameters if they are missed in original docblock
+        if (!$this->phpdoc->hasTag('param')) {
+            foreach ($method->getParameters() as $parameter) {
+                $reflectionType = $parameter->getType();
+
+                $type = $this->concatReflectionTypes($reflectionType);
+
+                /** @psalm-suppress UndefinedClass */
+                if ($reflectionType && !$reflectionType instanceof \ReflectionUnionType && $reflectionType->allowsNull()) {
+                    $type .= '|null';
+                }
+
+                $type = $type ?: 'mixed';
+
+                $name = $parameter->isVariadic() ? '...' : '';
+                $name .= '$' . $parameter->getName();
+
+                $this->phpdoc->appendTag(Tag::createInstance("@param {$type} {$name}"));
+            }
+        }
+
+        // Add macro return type if it missed in original docblock
+        if ($method->hasReturnType() && !$this->phpdoc->hasTag('return')) {
+            $builder = EloquentBuilder::class;
+            $return = $method->getReturnType();
+
+            $type = $this->concatReflectionTypes($return);
+
+            /** @psalm-suppress UndefinedClass */
+            if (!$return instanceof \ReflectionUnionType) {
+                $type .= $this->root === "\\{$builder}" && $return->getName() === $builder ? '|static' : '';
+                $type .= $return->allowsNull() ? '|null' : '';
+            }
+
+            $this->phpdoc->appendTag(Tag::createInstance("@return {$type}"));
+        }
+    }
+
+    protected function concatReflectionTypes(?\ReflectionType $type): string
+    {
+        /** @psalm-suppress UndefinedClass */
+        $returnTypes = $type instanceof \ReflectionUnionType
+            ? $type->getTypes()
+            : [$type];
+
+        return Collection::make($returnTypes)
+            ->filter()
+            ->map->getName()
+            ->implode('|');
+    }
+
+    protected function addLocationToPhpDoc()
+    {
+        if ($this->method->name === '__invoke') {
+            $enclosingClass = $this->method->getDeclaringClass();
+        } else {
+            $enclosingClass = $this->method->getClosureScopeClass();
+        }
+
+        if (!$enclosingClass) {
+            return;
+        }
+        /** @var \ReflectionMethod $enclosingMethod */
+        $enclosingMethod = Collection::make($enclosingClass->getMethods())
+            ->first(function (\ReflectionMethod $method) {
+                return $method->getStartLine() <= $this->method->getStartLine()
+                    && $method->getEndLine() >= $this->method->getEndLine();
+            });
+
+        if ($enclosingMethod) {
+            $this->phpdoc->appendTag(Tag::createInstance(
+                '@see \\' . $enclosingClass->getName() . '::' . $enclosingMethod->getName() . '()'
+            ));
+        }
+    }
+
+    /**
+     * @param \ReflectionFunctionAbstract $method
+     * @param \ReflectionClass $class
+     */
+    protected function initClassDefinedProperties($method, \ReflectionClass $class)
+    {
+        $this->namespace = $class->getNamespaceName();
+        $this->declaringClassName = '\\' . ltrim($class->name, '\\');
+    }
+}

src/Method.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Laravel IDE Helper Generator
  *
@@ -12,43 +13,55 @@ namespace Barryvdh\LaravelIdeHelper;
 
 use Barryvdh\Reflection\DocBlock;
 use Barryvdh\Reflection\DocBlock\Context;
-use Barryvdh\Reflection\DocBlock\Tag;
-use Barryvdh\Reflection\DocBlock\Tag\ReturnTag;
-use Barryvdh\Reflection\DocBlock\Tag\ParamTag;
 use Barryvdh\Reflection\DocBlock\Serializer as DocBlockSerializer;
+use Barryvdh\Reflection\DocBlock\Tag;
+use Barryvdh\Reflection\DocBlock\Tag\ParamTag;
+use Barryvdh\Reflection\DocBlock\Tag\ReturnTag;
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Support\Str;
 
 class Method
 {
-    /** @var \Barryvdh\Reflection\DocBlock  */
+    /** @var DocBlock  */
     protected $phpdoc;
 
     /** @var \ReflectionMethod  */
     protected $method;
 
     protected $output = '';
+    protected $declaringClassName;
     protected $name;
     protected $namespace;
-    protected $params = array();
-    protected $params_with_default = array();
-    protected $interfaces = array();
+    protected $params = [];
+    protected $params_with_default = [];
+    protected $interfaces = [];
+    protected $real_name;
     protected $return = null;
+    protected $root;
+    protected $classAliases;
 
     /**
-     * @param \ReflectionMethod $method
+     * @param \ReflectionMethod|\ReflectionFunctionAbstract $method
      * @param string $alias
      * @param \ReflectionClass $class
      * @param string|null $methodName
      * @param array $interfaces
+     * @param array $classAliases
      */
-    public function __construct(\ReflectionMethod $method, $alias, $class, $methodName = null, $interfaces = array())
+    public function __construct($method, $alias, $class, $methodName = null, $interfaces = [], array $classAliases = [])
     {
         $this->method = $method;
         $this->interfaces = $interfaces;
+        $this->classAliases = $classAliases;
         $this->name = $methodName ?: $method->name;
-        $this->namespace = $method->getDeclaringClass()->getNamespaceName();
+        $this->real_name = $method->isClosure() ? $this->name : $method->name;
+        $this->initClassDefinedProperties($method, $class);
+
+        //Reference the 'real' function in the declaring class
+        $this->root = '\\' . ltrim($method->name === '__invoke' ? $method->getDeclaringClass()->getName() : $class->getName(), '\\');
 
         //Create a DocBlock and serializer instance
-        $this->phpdoc = new DocBlock($method, new Context($this->namespace));
+        $this->initPhpDoc($method);
 
         //Normalize the description and inherit the docs from parents/interfaces
         try {
@@ -63,11 +76,25 @@ class Method
 
         //Make the method static
         $this->phpdoc->appendTag(Tag::createInstance('@static', $this->phpdoc));
+    }
 
-        //Reference the 'real' function in the declaringclass
+    /**
+     * @param \ReflectionMethod $method
+     */
+    protected function initPhpDoc($method)
+    {
+        $this->phpdoc = new DocBlock($method, new Context($this->namespace, $this->classAliases));
+    }
+
+    /**
+     * @param \ReflectionMethod $method
+     * @param \ReflectionClass $class
+     */
+    protected function initClassDefinedProperties($method, \ReflectionClass $class)
+    {
         $declaringClass = $method->getDeclaringClass();
+        $this->namespace = $declaringClass->getNamespaceName();
         $this->declaringClassName = '\\' . ltrim($declaringClass->name, '\\');
-        $this->root = '\\' . ltrim($class->getName(), '\\');
     }
 
     /**
@@ -90,6 +117,26 @@ class Method
         return $this->root;
     }
 
+    /**
+     * @return bool
+     */
+    public function isInstanceCall()
+    {
+        return !($this->method->isClosure() || $this->method->isStatic());
+    }
+
+    /**
+     * @return string
+     */
+    public function getRootMethodCall()
+    {
+        if ($this->isInstanceCall()) {
+            return "\$instance->{$this->getRealName()}({$this->getParams()})";
+        } else {
+            return "{$this->getRoot()}::{$this->getRealName()}({$this->getParams()})";
+        }
+    }
+
     /**
      * Get the docblock for this method
      *
@@ -112,6 +159,16 @@ class Method
         return $this->name;
     }
 
+    /**
+     * Get the real method name
+     *
+     * @return string
+     */
+    public function getRealName()
+    {
+        return $this->real_name;
+    }
+
     /**
      * Get the parameters for this method
      *
@@ -197,29 +254,37 @@ class Method
      */
     protected function normalizeReturn(DocBlock $phpdoc)
     {
-        //Get the return type and adjust them for beter autocomplete
+        //Get the return type and adjust them for better autocomplete
         $returnTags = $phpdoc->getTagsByName('return');
-        if ($returnTags) {
-            /** @var ReturnTag $tag */
-            $tag = reset($returnTags);
-            // Get the expanded type
-            $returnValue = $tag->getType();
 
-            // Replace the interfaces
-            foreach ($this->interfaces as $interface => $real) {
-                $returnValue = str_replace($interface, $real, $returnValue);
-            }
-
-            // Set the changed content
-            $tag->setContent($returnValue . ' ' . $tag->getDescription());
-            $this->return = $returnValue;
-        } else {
+        if (count($returnTags) === 0) {
             $this->return = null;
+            return;
+        }
+
+        /** @var ReturnTag $tag */
+        $tag = reset($returnTags);
+        // Get the expanded type
+        $returnValue = $tag->getType();
+
+        // Replace the interfaces
+        foreach ($this->interfaces as $interface => $real) {
+            $returnValue = str_replace($interface, $real, $returnValue);
+        }
+
+        // Set the changed content
+        $tag->setContent($returnValue . ' ' . $tag->getDescription());
+        $this->return = $returnValue;
+
+        if ($tag->getType() === '$this') {
+            Str::contains($this->root, Builder::class)
+                ? $tag->setType($this->root . '|static')
+                : $tag->setType($this->root);
         }
     }
 
     /**
-     * Convert keywwords that are incorrect.
+     * Convert keywords that are incorrect.
      *
      * @param  string $string
      * @return string
@@ -240,7 +305,7 @@ class Method
      */
     public function shouldReturn()
     {
-        if ($this->return !== "void" && $this->method->name !== "__construct") {
+        if ($this->return !== 'void' && $this->method->name !== '__construct') {
             return true;
         }
 
@@ -251,22 +316,22 @@ class Method
      * Get the parameters and format them correctly
      *
      * @param  \ReflectionMethod $method
-     * @return array
+     * @return void
      */
     public function getParameters($method)
     {
-        //Loop through the default values for paremeters, and make the correct output string
-        $params = array();
-        $paramsWithDefault = array();
+        //Loop through the default values for parameters, and make the correct output string
+        $params = [];
+        $paramsWithDefault = [];
         foreach ($method->getParameters() as $param) {
-            $paramStr = '$' . $param->getName();
+            $paramStr = $param->isVariadic() ? '...$' . $param->getName() : '$' . $param->getName();
             $params[] = $paramStr;
-            if ($param->isOptional()) {
+            if ($param->isOptional() && !$param->isVariadic()) {
                 $default = $param->isDefaultValueAvailable() ? $param->getDefaultValue() : null;
                 if (is_bool($default)) {
                     $default = $default ? 'true' : 'false';
                 } elseif (is_array($default)) {
-                    $default = 'array()';
+                    $default = '[]';
                 } elseif (is_null($default)) {
                     $default = 'null';
                 } elseif (is_int($default)) {
@@ -274,7 +339,7 @@ class Method
                 } elseif (is_resource($default)) {
                     //skip to not fail
                 } else {
-                    $default = "'" . trim($default) . "'";
+                    $default = var_export($default, true);
                 }
                 $paramStr .= " = $default";
             }
@@ -301,14 +366,14 @@ class Method
         }
         if ($method) {
             $namespace = $method->getDeclaringClass()->getNamespaceName();
-            $phpdoc = new DocBlock($method, new Context($namespace));
-            
+            $phpdoc = new DocBlock($method, new Context($namespace, $this->classAliases));
+
             if (strpos($phpdoc->getText(), '{@inheritdoc}') !== false) {
                 //Not at the end yet, try another parent/interface..
                 return $this->getInheritDoc($method);
-            } else {
-                return $phpdoc;
             }
+
+            return $phpdoc;
         }
     }
 }

src/Parsers/PhpDocReturnTypeParser.php

@@ -0,0 +1,79 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Parsers;
+
+class PhpDocReturnTypeParser
+{
+    /**
+     * @var string
+     */
+    private string $typeAlias;
+
+    /**
+     * @var array
+     */
+    private array $namespaceAliases;
+
+    /**
+     * @param string $typeAlias
+     * @param array $namespaceAliases
+     */
+    public function __construct(string $typeAlias, array $namespaceAliases)
+    {
+        $this->typeAlias = $typeAlias;
+        $this->namespaceAliases = $namespaceAliases;
+    }
+
+    /**
+     * @return string|null
+     */
+    public function parse(): string|null
+    {
+        $matches = [];
+        preg_match('/(\w+)(<.*>)/', $this->typeAlias, $matches);
+        $matchCount = count($matches);
+
+        if ($matchCount === 0 || $matchCount === 1) {
+            return null;
+        }
+
+        if (empty($this->namespaceAliases[$matches[1]])) {
+            return null;
+        }
+
+        return $this->namespaceAliases[$matches[1]] . $this->parseTemplate($matches[2] ?? null);
+    }
+
+    /**
+     * @param string|null $template
+     * @return string
+     */
+    private function parseTemplate(string|null $template): string
+    {
+        if ($template  === null || $template === '') {
+            return '';
+        }
+
+        $type = '';
+        $result = '';
+
+        foreach (str_split($template) as $char) {
+            $match = preg_match('/[A-z]/', $char);
+
+            if (!$match) {
+                $type = $this->namespaceAliases[$type] ?? $type;
+                $result .= $type;
+                $result .= $char;
+                $type = '';
+
+                continue;
+            }
+
+            $type .= $char;
+        }
+
+        return $result;
+    }
+}

src/UsesResolver.php

@@ -0,0 +1,124 @@
+<?php
+
+/**
+ * Laravel IDE Helper Generator
+ *
+ * @author    Barry vd. Heuvel <barryvdh@gmail.com>
+ * @copyright 2014 Barry vd. Heuvel / Fruitcake Studio (http://www.fruitcakestudio.nl)
+ * @license   http://www.opensource.org/licenses/mit-license.php MIT
+ * @link      https://github.com/barryvdh/laravel-ide-helper
+ */
+
+namespace Barryvdh\LaravelIdeHelper;
+
+use PhpParser\Node\Stmt\GroupUse;
+use PhpParser\Node\Stmt\Namespace_;
+use PhpParser\Node\Stmt\Use_;
+use PhpParser\Node\Stmt\UseUse;
+use PhpParser\ParserFactory;
+
+class UsesResolver
+{
+    /**
+     * @param string $classFQN
+     * @return array
+     */
+    public function loadFromClass(string $classFQN): array
+    {
+        return $this->loadFromFile(
+            $classFQN,
+            (new \ReflectionClass($classFQN))->getFileName()
+        );
+    }
+
+    /**
+     * @param string $classFQN
+     * @param string $filename
+     * @return array
+     */
+    public function loadFromFile(string $classFQN, string $filename): array
+    {
+        return $this->loadFromCode(
+            $classFQN,
+            file_get_contents(
+                $filename
+            )
+        );
+    }
+
+    /**
+     * @param string $classFQN
+     * @param string $code
+     * @return array
+     */
+    public function loadFromCode(string $classFQN, string $code): array
+    {
+        $classFQN = ltrim($classFQN, '\\');
+
+        $namespace = rtrim(
+            preg_replace(
+                '/([^\\\\]+)$/',
+                '',
+                $classFQN
+            ),
+            '\\'
+        );
+
+        $parser = (new ParserFactory())->createForHostVersion();
+        $namespaceData = null;
+
+        foreach ($parser->parse($code) as $node) {
+            if ($node instanceof Namespace_ && $node->name->toCodeString() === $namespace) {
+                $namespaceData = $node;
+                break;
+            }
+        }
+
+        if ($namespaceData === null) {
+            return [];
+        }
+
+        /** @var Namespace_ $namespaceData */
+
+        $aliases = [];
+
+        foreach ($namespaceData->stmts as $stmt) {
+            if ($stmt instanceof Use_) {
+                if ($stmt->type !== Use_::TYPE_NORMAL) {
+                    continue;
+                }
+
+                foreach ($stmt->uses as $use) {
+                    /** @var UseUse $use */
+
+                    $alias = $use->alias ?
+                        $use->alias->name :
+                        self::classBasename($use->name->toCodeString());
+
+                    $aliases[$alias] = '\\' . $use->name->toCodeString();
+                }
+            } elseif ($stmt instanceof GroupUse) {
+                foreach ($stmt->uses as $use) {
+                    /** @var UseUse $use */
+
+                    $alias = $use->alias ?
+                        $use->alias->name :
+                        self::classBasename($use->name->toCodeString());
+
+                    $aliases[$alias] = '\\' . $stmt->prefix->toCodeString() . '\\' . $use->name->toCodeString();
+                }
+            }
+        }
+
+        return $aliases;
+    }
+
+    /**
+     * @param string $classFQN
+     * @return string
+     */
+    protected static function classBasename(string $classFQN): string
+    {
+        return preg_replace('/^.*\\\\([^\\\\]+)$/', '$1', $classFQN);
+    }
+}

tests/AliasTest.php

@@ -0,0 +1,105 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests;
+
+use Barryvdh\LaravelIdeHelper\Alias;
+use Barryvdh\LaravelIdeHelper\Macro;
+use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
+use Illuminate\Database\Query\Builder;
+use Illuminate\Support\Arr;
+
+/**
+ * @internal
+ * @coversDefaultClass \Barryvdh\LaravelIdeHelper\Alias
+ */
+class AliasTest extends TestCase
+{
+    /**
+     * @covers ::detectMethods
+     */
+    public function testDetectMethodsMacroableMacros(): void
+    {
+        // Mock
+        $macro = __FUNCTION__;
+        $alias = new AliasMock();
+
+        // Macros
+        Builder::macro(
+            $macro,
+            function () {
+                // empty
+            }
+        );
+
+        // Prepare
+        $alias->setClasses([Builder::class]);
+        $alias->detectMethods();
+
+        // Test
+        $this->assertNotNull($this->getAliasMacro($alias, Builder::class, $macro));
+    }
+
+    /**
+     * @covers ::detectMethods
+     */
+    public function testDetectMethodsEloquentBuilderMacros(): void
+    {
+        // Mock
+        $macro = __FUNCTION__;
+        $alias = new AliasMock();
+
+        // Macros
+        EloquentBuilder::macro(
+            $macro,
+            function () {
+                // empty
+            }
+        );
+
+        // Prepare
+        $alias->setClasses([EloquentBuilder::class]);
+        $alias->detectMethods();
+
+        // Test
+        $this->assertNotNull($this->getAliasMacro($alias, EloquentBuilder::class, $macro));
+    }
+
+    protected function getAliasMacro(Alias $alias, string $class, string $method): ?Macro
+    {
+        return Arr::first(
+            $alias->getMethods(),
+            function ($macro) use ($class, $method) {
+                return $macro instanceof Macro
+                    && $macro->getDeclaringClass() === "\\{$class}"
+                    && $macro->getName() === $method;
+            }
+        );
+    }
+}
+
+/**
+ * @internal
+ * @noinspection PhpMultipleClassesDeclarationsInOneFile
+ */
+class AliasMock extends Alias
+{
+    public function __construct()
+    {
+        // no need to call parent
+    }
+
+    /**
+     * @param string[] $classes
+     */
+    public function setClasses(array $classes)
+    {
+        $this->classes = $classes;
+    }
+
+    public function detectMethods()
+    {
+        parent::detectMethods();
+    }
+}

tests/Console/EloquentCommandTest.php

@@ -0,0 +1,68 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console;
+
+use Barryvdh\LaravelIdeHelper\Console\EloquentCommand;
+use Barryvdh\LaravelIdeHelper\Tests\TestCase;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Filesystem\Filesystem;
+use Mockery;
+use ReflectionClass;
+
+class EloquentCommandTest extends TestCase
+{
+    public function testCommand()
+    {
+        $modelFilename = $this->getVendorModelFilename();
+        $modelSource = file_get_contents($modelFilename);
+        if (false !== strpos($modelSource, '* @mixin')) {
+            $msg = sprintf('Class %s already contains the @mixin markers', Model::class);
+            $this->markTestSkipped($msg);
+        }
+
+        $actualContent = null;
+        $mockFilesystem = Mockery::mock(Filesystem::class);
+        $mockFilesystem
+            ->shouldReceive('get')
+            // We don't care about actual args (filename)
+            ->andReturn('abstract class Model implements'); // This is enough to trigger the replacement logic
+        $mockFilesystem
+            ->shouldReceive('put')
+            ->with(
+                Mockery::any(), // First arg is path, we don't care
+                Mockery::capture($actualContent)
+            )
+            ->andReturn(1) // Simulate we wrote _something_ to the file
+            ->once();
+
+        $this->instance(Filesystem::class, $mockFilesystem);
+        $command = $this->app->make(EloquentCommand::class);
+
+        $tester = $this->runCommand($command);
+
+        $this->assertMatchesTxtSnapshot($actualContent);
+
+        $display = $tester->getDisplay();
+        $this->assertMatchesRegularExpression(
+            ';Unexpected no document on Illuminate\\\Database\\\Eloquent\\\Model;',
+            $display
+        );
+        $modelClassFilePath = preg_quote(
+            str_replace('/', DIRECTORY_SEPARATOR, '/vendor/laravel/framework/src/Illuminate/Database/Eloquent/Model.php')
+        );
+        $this->assertMatchesRegularExpression(
+            ';Wrote expected docblock to .*' . $modelClassFilePath . ';',
+            $display
+        );
+    }
+
+    private function getVendorModelFilename(): string
+    {
+        $class = Model::class;
+        $reflectedClass = new ReflectionClass($class);
+
+        return $reflectedClass->getFileName();
+    }
+}

tests/Console/MetaCommand/MetaCommandTest.php

@@ -0,0 +1,84 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\MetaCommand;
+
+use Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider;
+use Barryvdh\LaravelIdeHelper\Tests\TestCase;
+use Illuminate\Filesystem\Filesystem;
+use Mockery\MockInterface;
+use stdClass;
+
+class MetaCommandTest extends TestCase
+{
+    public function testCommand(): void
+    {
+        $this->mockFilesystem();
+
+        /** @var Filesystem|MockInterface $mockFileSystem */
+        $mockFileSystem = $this->app->make(Filesystem::class);
+        $this->instance('files', $mockFileSystem);
+
+        $mockFileSystem
+            ->shouldReceive('getRequire')
+            ->andReturnUsing(function ($__path, $__data) {
+                return (static function () use ($__path, $__data) {
+                    extract($__data, EXTR_SKIP);
+
+                    return require $__path;
+                })();
+            });
+
+        $this->artisan('ide-helper:meta');
+
+        // We're not testing the whole file, just some basic structure elements
+        self::assertStringContainsString("namespace PHPSTORM_META {\n", $this->mockFilesystemOutput);
+        self::assertStringContainsString("PhpStorm Meta file, to provide autocomplete information for PhpStorm\n", $this->mockFilesystemOutput);
+        self::assertStringContainsString('override(', $this->mockFilesystemOutput);
+    }
+
+    public function testUnregisterAutoloader(): void
+    {
+        $current = spl_autoload_functions();
+        $appended = function () {
+        };
+
+        $this->app->bind('registers-autoloader', function () use ($appended) {
+            spl_autoload_register($appended);
+            return new stdClass();
+        });
+
+        $this->mockFilesystem();
+
+        /** @var Filesystem|MockInterface $mockFileSystem */
+        $mockFileSystem = $this->app->make(Filesystem::class);
+        $this->instance('files', $mockFileSystem);
+
+        $mockFileSystem
+            ->shouldReceive('getRequire')
+            ->andReturnUsing(function ($__path, $__data) {
+                return (static function () use ($__path, $__data) {
+                    extract($__data, EXTR_SKIP);
+
+                    return require $__path;
+                })();
+            });
+
+        $this->artisan('ide-helper:meta');
+
+        self::assertSame(array_merge($current, [$appended]), spl_autoload_functions());
+    }
+
+    /**
+     * Get package providers.
+     *
+     * @param  \Illuminate\Foundation\Application  $app
+     *
+     * @return array
+     */
+    protected function getPackageProviders($app)
+    {
+        return [IdeHelperServiceProvider::class];
+    }
+}

tests/Console/ModelsCommand/AbstractModelsCommand.php

@@ -0,0 +1,60 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand;
+
+use Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider;
+use Barryvdh\LaravelIdeHelper\Tests\SnapshotPhpDriver;
+use Barryvdh\LaravelIdeHelper\Tests\TestCase;
+
+abstract class AbstractModelsCommand extends TestCase
+{
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $this->loadMigrationsFrom(__DIR__ . '/migrations');
+        $this->artisan('migrate');
+        $this->mockFilesystem();
+    }
+
+    /**
+     * Get package providers.
+     *
+     * @param  \Illuminate\Foundation\Application  $app
+     *
+     * @return array
+     */
+    protected function getPackageProviders($app)
+    {
+        return [IdeHelperServiceProvider::class];
+    }
+
+    protected function getEnvironmentSetUp($app)
+    {
+        parent::getEnvironmentSetUp($app);
+
+        $config = $app['config'];
+
+        $config->set('database.default', 'sqlite');
+        $config->set('database.connections.sqlite', [
+            'driver' => 'sqlite',
+            'database' => ':memory:',
+            'prefix' => '',
+        ]);
+
+        // Load the Models from the Test dir
+        $config->set('ide-helper.model_locations', [
+            dirname((new \ReflectionClass(static::class))->getFileName()) . '/Models',
+        ]);
+
+        // Don't override integer -> int for tests
+        $config->set('ide-helper.type_overrides', []);
+    }
+
+    protected function assertMatchesMockedSnapshot()
+    {
+        $this->assertMatchesSnapshot($this->mockFilesystemOutput, new SnapshotPhpDriver());
+    }
+}

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

@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+
+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 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,
+        ];
+    }
+}

tests/Console/ModelsCommand/AdvancedCasts/Test.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts;
+
+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/AdvancedCasts/__snapshots__/Test__test__1.php

@@ -0,0 +1,78 @@
+<?php
+
+declare(strict_types=1);
+
+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;
+
+/**
+ * 
+ *
+ * @property \Illuminate\Support\Carbon $cast_to_date_serialization
+ * @property \Illuminate\Support\Carbon $cast_to_datetime_serialization
+ * @property \Illuminate\Support\Carbon $cast_to_custom_datetime
+ * @property \Carbon\CarbonImmutable $cast_to_immutable_date
+ * @property \Carbon\CarbonImmutable $cast_to_immutable_custom_datetime
+ * @property \Carbon\CarbonImmutable $cast_to_immutable_datetime
+ * @property int $cast_to_timestamp
+ * @property mixed $cast_to_encrypted
+ * @property array $cast_to_encrypted_array
+ * @property \Illuminate\Support\Collection $cast_to_encrypted_collection
+ * @property array $cast_to_encrypted_json
+ * @property object $cast_to_encrypted_object
+ * @property \Illuminate\Support\Collection $cast_to_as_collection
+ * @property \Illuminate\Support\Collection $cast_to_as_enum_collection
+ * @property \ArrayObject $cast_to_as_array_object
+ * @property AdvancedCastCollection $cast_to_as_collection_using
+ * @property \Illuminate\Support\Collection<int, AdvancedCastEnum> $cast_to_as_enum_collection_of
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|AdvancedCast newModelQuery()
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|AdvancedCast newQuery()
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|AdvancedCast query()
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|AdvancedCast whereCastToAsArrayObject($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|AdvancedCast whereCastToAsCollection($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|AdvancedCast whereCastToAsEnumCollection($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|AdvancedCast whereCastToCustomDatetime($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|AdvancedCast whereCastToDateSerialization($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|AdvancedCast whereCastToDatetimeSerialization($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|AdvancedCast whereCastToEncrypted($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|AdvancedCast whereCastToEncryptedArray($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|AdvancedCast whereCastToEncryptedCollection($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|AdvancedCast whereCastToEncryptedJson($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|AdvancedCast whereCastToEncryptedObject($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|AdvancedCast whereCastToImmutableCustomDatetime($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|AdvancedCast whereCastToImmutableDate($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|AdvancedCast whereCastToImmutableDatetime($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|AdvancedCast whereCastToTimestamp($value)
+ * @mixin \Eloquent
+ */
+class AdvancedCast extends Model
+{
+    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,
+        ];
+    }
+}

tests/Console/ModelsCommand/AllowGlobDirectory/Services/Post/Models/Post.php

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

tests/Console/ModelsCommand/AllowGlobDirectory/Test.php

@@ -0,0 +1,44 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AllowGlobDirectory;
+
+use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
+use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AbstractModelsCommand;
+
+final class Test extends AbstractModelsCommand
+{
+    /** @var string */
+    private $cwd;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $this->cwd = getcwd();
+    }
+
+    protected function tearDown(): void
+    {
+        chdir($this->cwd);
+
+        parent::tearDown();
+    }
+
+    public function test(): void
+    {
+        $command = $this->app->make(ModelsCommand::class);
+
+        chdir(__DIR__);
+
+        $tester = $this->runCommand($command, [
+            '--dir' => ['Services/*/Models'],
+            '--write' => true,
+        ]);
+
+        $this->assertSame(0, $tester->getStatusCode());
+        $this->assertStringContainsString('Written new phpDocBlock to', $tester->getDisplay());
+        $this->assertMatchesMockedSnapshot();
+    }
+}

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

@@ -0,0 +1,161 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AllowGlobDirectory\Services\Post\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 string|null $decimal_nullable
+ * @property string $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 newModelQuery()
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post newQuery()
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post query()
+ * @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
+{
+}

tests/Console/ModelsCommand/ArrayCastsWithComment/Models/ArrayCastsWithComment.php

@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\ArrayCastsWithComment\Models;
+
+use Illuminate\Database\Eloquent\Model;
+
+/**
+ * @property array<int, string>|null $cast_to_array -- These three should not be duplicated
+ * @property array<int, string> $cast_to_json some-description
+ * @property \Illuminate\Support\Collection<int, string> $cast_to_collection some-description
+ *
+ * @property array|null $cast_to_encrypted_array -- These three are OK (no types)
+ * @property array $cast_to_encrypted_json some-description
+ * @property \Illuminate\Support\Collection $cast_to_encrypted_collection some-description
+ *
+ * @property string $cast_to_string -- The next three are OK (no description), this not included
+ *
+ * @property array<int, string>|null $cast_to_immutable_date
+ * @property array<int, string> $cast_to_immutable_date_serialization
+ * @property \Illuminate\Support\Collection<int, string> $cast_to_immutable_custom_datetime
+ */
+class ArrayCastsWithComment extends Model
+{
+    protected $table = 'simple_casts';
+
+    protected $casts = [
+        'cast_to_array' => 'array',
+        'cast_to_json' => 'json',
+        'cast_to_collection' => 'collection',
+
+        'cast_to_encrypted_array' => 'array',
+        'cast_to_encrypted_json' => 'json',
+        'cast_to_encrypted_collection' => 'collection',
+
+        'cast_to_string' => 'string',
+
+        'cast_to_immutable_date' => 'array',
+        'cast_to_immutable_date_serialization' => 'json',
+        'cast_to_immutable_custom_datetime' => 'collection',
+    ];
+}

tests/Console/ModelsCommand/ArrayCastsWithComment/Test.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\ArrayCastsWithComment;
+
+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/ArrayCastsWithComment/__snapshots__/Test__test__1.php

@@ -0,0 +1,94 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\ArrayCastsWithComment\Models;
+
+use Illuminate\Database\Eloquent\Model;
+
+/**
+ * 
+ *
+ * @property array<int, string>|null $cast_to_array -- These three should not be duplicated
+ * @property array<int, string> $cast_to_json some-description
+ * @property \Illuminate\Support\Collection<int, string> $cast_to_collection some-description
+ * @property array|null $cast_to_encrypted_array -- These three are OK (no types)
+ * @property array $cast_to_encrypted_json some-description
+ * @property \Illuminate\Support\Collection $cast_to_encrypted_collection some-description
+ * @property string $cast_to_string -- The next three are OK (no description), this not included
+ * @property array<int, string>|null $cast_to_immutable_date
+ * @property array<int, string> $cast_to_immutable_date_serialization
+ * @property \Illuminate\Support\Collection<int, string> $cast_to_immutable_custom_datetime
+ * @property string $cast_to_int
+ * @property string $cast_to_integer
+ * @property string $cast_to_real
+ * @property string $cast_to_float
+ * @property string $cast_to_double
+ * @property string $cast_to_decimal
+ * @property string $cast_to_bool
+ * @property string $cast_to_boolean
+ * @property string $cast_to_object
+ * @property string $cast_to_date
+ * @property string $cast_to_datetime
+ * @property string $cast_to_date_serialization
+ * @property string $cast_to_datetime_serialization
+ * @property string $cast_to_custom_datetime
+ * @property string $cast_to_immutable_datetime
+ * @property string $cast_to_immutable_datetime_serialization
+ * @property string $cast_to_timestamp
+ * @property string $cast_to_encrypted
+ * @property string $cast_to_encrypted_object
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment newModelQuery()
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment newQuery()
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment query()
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment whereCastToArray($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment whereCastToBool($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment whereCastToBoolean($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment whereCastToCollection($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment whereCastToCustomDatetime($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment whereCastToDate($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment whereCastToDateSerialization($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment whereCastToDatetime($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment whereCastToDatetimeSerialization($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment whereCastToDecimal($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment whereCastToDouble($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment whereCastToEncrypted($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment whereCastToEncryptedArray($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment whereCastToEncryptedCollection($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment whereCastToEncryptedJson($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment whereCastToEncryptedObject($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment whereCastToFloat($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment whereCastToImmutableCustomDatetime($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment whereCastToImmutableDate($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment whereCastToImmutableDateSerialization($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment whereCastToImmutableDatetime($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment whereCastToImmutableDatetimeSerialization($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment whereCastToInt($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment whereCastToInteger($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment whereCastToJson($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment whereCastToObject($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment whereCastToReal($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment whereCastToString($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|ArrayCastsWithComment whereCastToTimestamp($value)
+ * @mixin \Eloquent
+ */
+class ArrayCastsWithComment extends Model
+{
+    protected $table = 'simple_casts';
+
+    protected $casts = [
+        'cast_to_array' => 'array',
+        'cast_to_json' => 'json',
+        'cast_to_collection' => 'collection',
+
+        'cast_to_encrypted_array' => 'array',
+        'cast_to_encrypted_json' => 'json',
+        'cast_to_encrypted_collection' => 'collection',
+
+        'cast_to_string' => 'string',
+
+        'cast_to_immutable_date' => 'array',
+        'cast_to_immutable_date_serialization' => 'json',
+        'cast_to_immutable_custom_datetime' => 'collection',
+    ];
+}

tests/Console/ModelsCommand/Attributes/Models/BackedAttribute.php

@@ -0,0 +1,59 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Attributes\Models;
+
+use Illuminate\Database\Eloquent\Casts\Attribute;
+use Illuminate\Database\Eloquent\Model;
+
+class BackedAttribute extends Model
+{
+    protected function name(): Attribute
+    {
+        return new Attribute(
+            function (?string $name): ?string {
+                return $name;
+            },
+            function (?string $name): ?string {
+                return $name;
+            }
+        );
+    }
+
+    protected function nameRead(): Attribute
+    {
+        return new Attribute(
+            function (?string $name): ?string {
+                return $name;
+            },
+        );
+    }
+
+    protected function nameWrite(): Attribute
+    {
+        return new Attribute(
+            set: function (?string $name): ?string {
+                return $name;
+            },
+        );
+    }
+
+    protected function nonBackedSet(): Attribute
+    {
+        return new Attribute(
+            set: function (?string $name): ?string {
+                return $name;
+            },
+        );
+    }
+
+    protected function nonBackedGet(): Attribute
+    {
+        return new Attribute(
+            get: function (): ?string {
+                return 'test';
+            },
+        );
+    }
+}

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

@@ -0,0 +1,117 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Attributes\Models;
+
+use Illuminate\Database\Eloquent\Casts\Attribute;
+use Illuminate\Database\Eloquent\Model;
+
+class Simple extends Model
+{
+    // With a backed property
+    protected function name(): Attribute
+    {
+        return new Attribute(
+            function (?string $name): ?string {
+                return $name;
+            },
+            function (?string $name): ?string {
+                return $name;
+            }
+        );
+    }
+
+    // Without backed properties
+
+    protected function typeHintedGetAndSet(): Attribute
+    {
+        return new Attribute(
+            function (): ?string {
+                return $this->name;
+            },
+            function (?string $name) {
+                $this->name = $name;
+            }
+        );
+    }
+
+    protected function divergingTypeHintedGetAndSet(): Attribute
+    {
+        return new Attribute(
+            function (): int {
+                return strlen($this->name);
+            },
+            function (?string $name) {
+                $this->name = $name;
+            }
+        );
+    }
+
+    protected function typeHintedGet(): Attribute
+    {
+        return Attribute::get(function (): ?string {
+            return $this->name;
+        });
+    }
+
+    protected function typeHintedSet(): Attribute
+    {
+        return Attribute::set(function (?string $name) {
+            $this->name = $name;
+        });
+    }
+
+    protected function nonTypeHintedGetAndSet(): Attribute
+    {
+        return new Attribute(
+            function () {
+                return $this->name;
+            },
+            function ($name) {
+                $this->name = $name;
+            }
+        );
+    }
+
+    protected function nonTypeHintedGet(): Attribute
+    {
+        return Attribute::get(function () {
+            return $this->name;
+        });
+    }
+
+    protected function nonTypeHintedSet(): Attribute
+    {
+        return Attribute::set(function ($name) {
+            $this->name = $name;
+        });
+    }
+
+    protected function parameterlessSet(): Attribute
+    {
+        return Attribute::set(function () {
+            $this->name = null;
+        });
+    }
+
+    /**
+     * ide-helper does not recognize this method being an Attribute
+     * because the method has no actual return type;
+     * phpdoc is ignored here deliberately due to performance reasons and also
+     * isn't supported by Laravel itself.
+     *
+     * @return Attribute
+     */
+    protected function notAnAttribute()
+    {
+        return new Attribute(
+            function (?string $value): ?string {
+                return $value;
+            },
+            function (?string $value): ?string {
+                return $value;
+            }
+        );
+    }
+}

tests/Console/ModelsCommand/Attributes/Test.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Attributes;
+
+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/Attributes/__snapshots__/Test__test__1.php

@@ -0,0 +1,213 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Attributes\Models;
+
+use Illuminate\Database\Eloquent\Casts\Attribute;
+use Illuminate\Database\Eloquent\Model;
+
+/**
+ * 
+ *
+ * @property int $id
+ * @property string|null $name
+ * @property string|null $name_read
+ * @property string|null $name_write
+ * @property-read string|null $non_backed_get
+ * @property-write string|null $non_backed_set
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|BackedAttribute newModelQuery()
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|BackedAttribute newQuery()
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|BackedAttribute query()
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|BackedAttribute whereId($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|BackedAttribute whereName($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|BackedAttribute whereNameRead($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|BackedAttribute whereNameWrite($value)
+ * @mixin \Eloquent
+ */
+class BackedAttribute extends Model
+{
+    protected function name(): Attribute
+    {
+        return new Attribute(
+            function (?string $name): ?string {
+                return $name;
+            },
+            function (?string $name): ?string {
+                return $name;
+            }
+        );
+    }
+
+    protected function nameRead(): Attribute
+    {
+        return new Attribute(
+            function (?string $name): ?string {
+                return $name;
+            },
+        );
+    }
+
+    protected function nameWrite(): Attribute
+    {
+        return new Attribute(
+            set: function (?string $name): ?string {
+                return $name;
+            },
+        );
+    }
+
+    protected function nonBackedSet(): Attribute
+    {
+        return new Attribute(
+            set: function (?string $name): ?string {
+                return $name;
+            },
+        );
+    }
+
+    protected function nonBackedGet(): Attribute
+    {
+        return new Attribute(
+            get: function (): ?string {
+                return 'test';
+            },
+        );
+    }
+}
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Attributes\Models;
+
+use Illuminate\Database\Eloquent\Casts\Attribute;
+use Illuminate\Database\Eloquent\Model;
+
+/**
+ * 
+ *
+ * @property int $id
+ * @property int $diverging_type_hinted_get_and_set
+ * @property string|null $name
+ * @property-read mixed $non_type_hinted_get
+ * @property mixed $non_type_hinted_get_and_set
+ * @property-write mixed $non_type_hinted_set
+ * @property-write mixed $parameterless_set
+ * @property-read string|null $type_hinted_get
+ * @property string|null $type_hinted_get_and_set
+ * @property-write string|null $type_hinted_set
+ * @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
+ */
+class Simple extends Model
+{
+    // With a backed property
+    protected function name(): Attribute
+    {
+        return new Attribute(
+            function (?string $name): ?string {
+                return $name;
+            },
+            function (?string $name): ?string {
+                return $name;
+            }
+        );
+    }
+
+    // Without backed properties
+
+    protected function typeHintedGetAndSet(): Attribute
+    {
+        return new Attribute(
+            function (): ?string {
+                return $this->name;
+            },
+            function (?string $name) {
+                $this->name = $name;
+            }
+        );
+    }
+
+    protected function divergingTypeHintedGetAndSet(): Attribute
+    {
+        return new Attribute(
+            function (): int {
+                return strlen($this->name);
+            },
+            function (?string $name) {
+                $this->name = $name;
+            }
+        );
+    }
+
+    protected function typeHintedGet(): Attribute
+    {
+        return Attribute::get(function (): ?string {
+            return $this->name;
+        });
+    }
+
+    protected function typeHintedSet(): Attribute
+    {
+        return Attribute::set(function (?string $name) {
+            $this->name = $name;
+        });
+    }
+
+    protected function nonTypeHintedGetAndSet(): Attribute
+    {
+        return new Attribute(
+            function () {
+                return $this->name;
+            },
+            function ($name) {
+                $this->name = $name;
+            }
+        );
+    }
+
+    protected function nonTypeHintedGet(): Attribute
+    {
+        return Attribute::get(function () {
+            return $this->name;
+        });
+    }
+
+    protected function nonTypeHintedSet(): Attribute
+    {
+        return Attribute::set(function ($name) {
+            $this->name = $name;
+        });
+    }
+
+    protected function parameterlessSet(): Attribute
+    {
+        return Attribute::set(function () {
+            $this->name = null;
+        });
+    }
+
+    /**
+     * ide-helper does not recognize this method being an Attribute
+     * because the method has no actual return type;
+     * phpdoc is ignored here deliberately due to performance reasons and also
+     * isn't supported by Laravel itself.
+     *
+     * @return Attribute
+     */
+    protected function notAnAttribute()
+    {
+        return new Attribute(
+            function (?string $value): ?string {
+                return $value;
+            },
+            function (?string $value): ?string {
+                return $value;
+            }
+        );
+    }
+}

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

@@ -0,0 +1,136 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Comment\Models;
+
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\HasMany;
+use Illuminate\Database\Eloquent\Relations\HasOne;
+use Illuminate\Database\Eloquent\Relations\MorphTo;
+
+class Simple extends Model
+{
+    /**
+     * There is not comment.
+     *
+     * @return string
+     */
+    public function getNotCommentAttribute(): string
+    {
+    }
+
+    /**
+     * comment There is not format comment, invalid.
+     *
+     * @return string
+     */
+    public function getFakerCommentAttribute(): string
+    {
+    }
+
+    /**
+     * @comment There is format comment, success.
+     *
+     * @return string
+     */
+    public function getFormatCommentAttribute(): string
+    {
+    }
+
+    /**
+     * @comment There is format comment, success.
+     * This is second line, success too.
+     *
+     * @return string
+     */
+    public function getFormatCommentLineTwoAttribute(): string
+    {
+    }
+
+    /**
+     * @comment There is format comment, success.
+     * @comment This is others format comment, invalid.
+     *
+     * @return string
+     */
+    public function getManyFormatCommentAttribute(): string
+    {
+    }
+
+    /**
+     * @comment Set the user's first name.
+     * @param $value
+     */
+    public function setFirstNameAttribute($value)
+    {
+    }
+
+    /**
+     * @comment Scope a query to only include active users.
+     *
+     * @param $query
+     * @return mixed
+     */
+    public function scopeActive($query)
+    {
+        return $query;
+    }
+
+    /**
+     * @comment HasMany relations.
+     *
+     * @return HasMany
+     */
+    public function relationHasMany(): HasMany
+    {
+        return $this->hasMany(Simple::class);
+    }
+
+    /**
+     * @comment MorphTo relations.
+     * @return MorphTo
+     */
+    public function relationMorphTo(): MorphTo
+    {
+        return $this->morphTo();
+    }
+
+    /**
+     * @comment Others relations.
+     * @return HasOne
+     */
+    public function relationHasOne(): HasOne
+    {
+        return $this->hasOne(Simple::class);
+    }
+
+    /**
+     * @comment I'm a setter
+     */
+    public function setBothSameNameAttribute(): void
+    {
+    }
+
+    /**
+     * @comment I'm a getter
+     * @return string
+     */
+    public function getBothSameNameAttribute(): string
+    {
+    }
+
+    /**
+     * @comment I'm a setter
+     */
+    public function setBothWithoutGetterCommentAttribute(): void
+    {
+    }
+
+    /**
+     * @return string
+     */
+    public function getBothWithoutGetterCommentAttribute(): string
+    {
+    }
+}

tests/Console/ModelsCommand/Comment/Test.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Comment;
+
+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/Comment/__snapshots__/Test__test__1.php

@@ -0,0 +1,160 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Comment\Models;
+
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\HasMany;
+use Illuminate\Database\Eloquent\Relations\HasOne;
+use Illuminate\Database\Eloquent\Relations\MorphTo;
+
+/**
+ * 
+ *
+ * @property int $id
+ * @property string $both_same_name I'm a getter
+ * @property string $both_without_getter_comment
+ * @property-read string $faker_comment
+ * @property-read string $format_comment There is format comment, success.
+ * @property-read string $format_comment_line_two There is format comment, success.
+ * This is second line, success too.
+ * @property-read string $many_format_comment There is format comment, success.
+ * @property-read string $not_comment
+ * @property-read \Illuminate\Database\Eloquent\Collection<int, Simple> $relationHasMany HasMany relations.
+ * @property-read int|null $relation_has_many_count
+ * @property-read Simple|null $relationHasOne Others relations.
+ * @property-read Model|\Eloquent $relationMorphTo MorphTo relations.
+ * @property-write mixed $first_name Set the user's first name.
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Simple active() Scope a query to only include active users.
+ * @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
+ */
+class Simple extends Model
+{
+    /**
+     * There is not comment.
+     *
+     * @return string
+     */
+    public function getNotCommentAttribute(): string
+    {
+    }
+
+    /**
+     * comment There is not format comment, invalid.
+     *
+     * @return string
+     */
+    public function getFakerCommentAttribute(): string
+    {
+    }
+
+    /**
+     * @comment There is format comment, success.
+     *
+     * @return string
+     */
+    public function getFormatCommentAttribute(): string
+    {
+    }
+
+    /**
+     * @comment There is format comment, success.
+     * This is second line, success too.
+     *
+     * @return string
+     */
+    public function getFormatCommentLineTwoAttribute(): string
+    {
+    }
+
+    /**
+     * @comment There is format comment, success.
+     * @comment This is others format comment, invalid.
+     *
+     * @return string
+     */
+    public function getManyFormatCommentAttribute(): string
+    {
+    }
+
+    /**
+     * @comment Set the user's first name.
+     * @param $value
+     */
+    public function setFirstNameAttribute($value)
+    {
+    }
+
+    /**
+     * @comment Scope a query to only include active users.
+     *
+     * @param $query
+     * @return mixed
+     */
+    public function scopeActive($query)
+    {
+        return $query;
+    }
+
+    /**
+     * @comment HasMany relations.
+     *
+     * @return HasMany
+     */
+    public function relationHasMany(): HasMany
+    {
+        return $this->hasMany(Simple::class);
+    }
+
+    /**
+     * @comment MorphTo relations.
+     * @return MorphTo
+     */
+    public function relationMorphTo(): MorphTo
+    {
+        return $this->morphTo();
+    }
+
+    /**
+     * @comment Others relations.
+     * @return HasOne
+     */
+    public function relationHasOne(): HasOne
+    {
+        return $this->hasOne(Simple::class);
+    }
+
+    /**
+     * @comment I'm a setter
+     */
+    public function setBothSameNameAttribute(): void
+    {
+    }
+
+    /**
+     * @comment I'm a getter
+     * @return string
+     */
+    public function getBothSameNameAttribute(): string
+    {
+    }
+
+    /**
+     * @comment I'm a setter
+     */
+    public function setBothWithoutGetterCommentAttribute(): void
+    {
+    }
+
+    /**
+     * @return string
+     */
+    public function getBothWithoutGetterCommentAttribute(): string
+    {
+    }
+}

tests/Console/ModelsCommand/CustomCollection/Collections/SimpleCollection.php

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

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

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\CustomCollection\Models;
+
+use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\CustomCollection\Collections\SimpleCollection;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\HasMany;
+
+class Simple extends Model
+{
+    public function newCollection(array $models = [])
+    {
+        return new SimpleCollection($models);
+    }
+
+    public function relationHasMany(): HasMany
+    {
+        return $this->hasMany(Simple::class);
+    }
+}

tests/Console/ModelsCommand/CustomCollection/Test.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\CustomCollection;
+
+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/CustomCollection/__snapshots__/Test__test__1.php

@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\CustomCollection\Models;
+
+use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\CustomCollection\Collections\SimpleCollection;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\HasMany;
+
+/**
+ * 
+ *
+ * @property int $id
+ * @property-read SimpleCollection<int, Simple> $relationHasMany
+ * @property-read int|null $relation_has_many_count
+ * @method static SimpleCollection<int, static> all($columns = ['*'])
+ * @method static SimpleCollection<int, static> get($columns = ['*'])
+ * @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
+ */
+class Simple extends Model
+{
+    public function newCollection(array $models = [])
+    {
+        return new SimpleCollection($models);
+    }
+
+    public function relationHasMany(): HasMany
+    {
+        return $this->hasMany(Simple::class);
+    }
+}

tests/Console/ModelsCommand/CustomDate/Models/CustomDate.php

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

tests/Console/ModelsCommand/CustomDate/Test.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\CustomDate;
+
+use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
+use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AbstractModelsCommand;
+use Carbon\CarbonImmutable;
+use Illuminate\Support\Carbon;
+use Illuminate\Support\Facades\Date;
+
+class Test extends AbstractModelsCommand
+{
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        Date::use(CarbonImmutable::class);
+    }
+
+    protected function tearDown(): void
+    {
+        Date::use(Carbon::class);
+
+        parent::tearDown();
+    }
+
+    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/CustomDate/__snapshots__/Test__test__1.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\CustomDate\Models;
+
+use Illuminate\Database\Eloquent\Model;
+
+/**
+ * 
+ *
+ * @property \Carbon\CarbonImmutable|null $created_at
+ * @property \Carbon\CarbonImmutable|null $updated_at
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|CustomDate newModelQuery()
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|CustomDate newQuery()
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|CustomDate query()
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|CustomDate whereCreatedAt($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|CustomDate whereUpdatedAt($value)
+ * @mixin \Eloquent
+ */
+class CustomDate extends Model
+{
+}

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

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\CustomPhpdocTags\Models;
+
+use Illuminate\Database\Eloquent\Model;
+
+/**
+ * The `@SuppressWarnings` tag below contains no space before the `(` but when
+ * the class phpdoc is written back, one is inserted.
+ *
+ * @link https://github.com/barryvdh/laravel-ide-helper/issues/666
+ *
+ * @SuppressWarnings(PHPMD.ExcessiveClassComplexity)
+ */
+class Simple extends Model
+{
+}

tests/Console/ModelsCommand/CustomPhpdocTags/Test.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\CustomPhpdocTags;
+
+use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
+use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AbstractModelsCommand;
+
+class Test extends AbstractModelsCommand
+{
+    /**
+     * This test makes sure that custom phpdoc tags are not mangled, e.g.
+     * there are no spaces inserted etc.
+     *
+     * @link https://github.com/barryvdh/laravel-ide-helper/issues/666
+     */
+    public function testNoSpaceAfterCustomPhpdocTag(): 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/CustomPhpdocTags/__snapshots__/Test__testNoSpaceAfterCustomPhpdocTag__1.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\CustomPhpdocTags\Models;
+
+use Illuminate\Database\Eloquent\Model;
+
+/**
+ * The `@SuppressWarnings` tag below contains no space before the `(` but when
+ * the class phpdoc is written back, one is inserted.
+ *
+ * @link https://github.com/barryvdh/laravel-ide-helper/issues/666
+ * @SuppressWarnings(PHPMD.ExcessiveClassComplexity)
+ * @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
+ */
+class Simple extends Model
+{
+}

tests/Console/ModelsCommand/DoesNotGeneratePhpdocWithExternalEloquentBuilder/Builders/PostExternalQueryBuilder.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\DoesNotGeneratePhpdocWithExternalEloquentBuilder\Builders;
+
+use Illuminate\Database\Eloquent\Builder;
+
+class PostExternalQueryBuilder extends Builder
+{
+    public function isActive(): self
+    {
+        return $this;
+    }
+
+    public function isStatus(string $status): self
+    {
+        return $this;
+    }
+}

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

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\DoesNotGeneratePhpdocWithExternalEloquentBuilder\Models;
+
+use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\DoesNotGeneratePhpdocWithExternalEloquentBuilder\Builders\PostExternalQueryBuilder;
+use Illuminate\Database\Eloquent\Model;
+
+class Post extends Model
+{
+    public function newEloquentBuilder($query): PostExternalQueryBuilder
+    {
+        return new PostExternalQueryBuilder($query);
+    }
+}

tests/Console/ModelsCommand/DoesNotGeneratePhpdocWithExternalEloquentBuilder/Test.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\DoesNotGeneratePhpdocWithExternalEloquentBuilder;
+
+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_model_external_builder_methods', false);
+    }
+
+    public function test(): void
+    {
+        $command = $this->app->make(ModelsCommand::class);
+
+        $tester = $this->runCommand($command, [
+            '--nowrite' => true,
+        ]);
+
+        $this->assertSame(0, $tester->getStatusCode());
+        $this->assertStringContainsString('Model information was written to _ide_helper_models.php', $tester->getDisplay());
+        $this->assertMatchesMockedSnapshot();
+    }
+}

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

@@ -0,0 +1,166 @@
+<?php
+
+// @formatter:off
+// phpcs:ignoreFile
+/**
+ * A helper file for your Eloquent Models
+ * Copy the phpDocs from this file to the correct Model,
+ * And remove them from this file, to prevent double declarations.
+ *
+ * @author Barry vd. Heuvel <barryvdh@gmail.com>
+ */
+
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\DoesNotGeneratePhpdocWithExternalEloquentBuilder\Models{
+/**
+ * 
+ *
+ * @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 string|null $decimal_nullable
+ * @property string $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 \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\DoesNotGeneratePhpdocWithExternalEloquentBuilder\Builders\PostExternalQueryBuilder<static>|Post newModelQuery()
+ * @method static \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\DoesNotGeneratePhpdocWithExternalEloquentBuilder\Builders\PostExternalQueryBuilder<static>|Post newQuery()
+ * @method static \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\DoesNotGeneratePhpdocWithExternalEloquentBuilder\Builders\PostExternalQueryBuilder<static>|Post query()
+ * @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)
+ */
+	class Post extends \Eloquent {}
+}
+

tests/Console/ModelsCommand/DynamicRelations/Models/Dynamic.php

@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\DynamicRelations\Models;
+
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
+use Illuminate\Database\Eloquent\Relations\HasMany;
+use Illuminate\Database\Eloquent\Relations\HasOne;
+
+class Dynamic extends Model
+{
+    /** @var \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\DynamicRelations\OtherModels\Account */
+    protected $account;
+
+    // Regular relations
+    public function regularHasMany(): HasMany
+    {
+        return $this->hasMany(Dynamic::class);
+    }
+
+    // Dynamic relations
+    public function dynamicHasMany(): HasMany
+    {
+        return $this->hasMany(Dynamic::class)->where('date', '>=', $this->account->created_at);
+    }
+
+    public function dynamicHasOne(): HasOne
+    {
+        return $this->hasOne(Dynamic::class)->where('date', '>=', $this->account->created_at);
+    }
+
+    public function dynamicBelongsTo(): BelongsTo
+    {
+        return $this->belongsTo(Dynamic::class)->where('date', '>=', $this->account->created_at);
+    }
+}

tests/Console/ModelsCommand/DynamicRelations/OtherModels/Account.php

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

tests/Console/ModelsCommand/DynamicRelations/Test.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\DynamicRelations;
+
+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,
+        ]);
+
+        $errors = [
+            'Error resolving relation model of Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\DynamicRelations\Models\Dynamic:dynamicBelongsTo() : Attempt to read property "created_at" on null',
+            'Error resolving relation model of Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\DynamicRelations\Models\Dynamic:dynamicHasMany() : Attempt to read property "created_at" on null',
+            'Error resolving relation model of Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\DynamicRelations\Models\Dynamic:dynamicHasOne() : Attempt to read property "created_at" on null',
+        ];
+
+        $this->assertSame(0, $tester->getStatusCode());
+        $this->assertStringContainsString('Written new phpDocBlock to', $tester->getDisplay());
+        foreach ($errors as $error) {
+            $this->assertStringContainsString($error, $tester->getDisplay());
+        }
+        $this->assertMatchesMockedSnapshot();
+    }
+}

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

@@ -0,0 +1,48 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\DynamicRelations\Models;
+
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
+use Illuminate\Database\Eloquent\Relations\HasMany;
+use Illuminate\Database\Eloquent\Relations\HasOne;
+
+/**
+ * 
+ *
+ * @property-read \Illuminate\Database\Eloquent\Collection<int, Dynamic> $regularHasMany
+ * @property-read int|null $regular_has_many_count
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Dynamic newModelQuery()
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Dynamic newQuery()
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Dynamic query()
+ * @mixin \Eloquent
+ */
+class Dynamic extends Model
+{
+    /** @var \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\DynamicRelations\OtherModels\Account */
+    protected $account;
+
+    // Regular relations
+    public function regularHasMany(): HasMany
+    {
+        return $this->hasMany(Dynamic::class);
+    }
+
+    // Dynamic relations
+    public function dynamicHasMany(): HasMany
+    {
+        return $this->hasMany(Dynamic::class)->where('date', '>=', $this->account->created_at);
+    }
+
+    public function dynamicHasOne(): HasOne
+    {
+        return $this->hasOne(Dynamic::class)->where('date', '>=', $this->account->created_at);
+    }
+
+    public function dynamicBelongsTo(): BelongsTo
+    {
+        return $this->belongsTo(Dynamic::class)->where('date', '>=', $this->account->created_at);
+    }
+}

tests/Console/ModelsCommand/Factories/CustomSpace/ModelWithCustomNamespaceFactory.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\CustomSpace;
+
+use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Models\ModelWithCustomNamespace;
+use Illuminate\Database\Eloquent\Factories\Factory;
+
+class ModelWithCustomNamespaceFactory extends Factory
+{
+    /**
+     * The name of the factory's corresponding model.
+     *
+     * @var string
+     */
+    protected $model = ModelWithCustomNamespace::class;
+
+    /**
+     * Define the model's default state.
+     *
+     * @return array
+     */
+    public function definition()
+    {
+        return [
+            //
+        ];
+    }
+}

tests/Console/ModelsCommand/Factories/Factories/ModelWithFactoryFactory.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Factories;
+
+use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Models\ModelWithFactory;
+use Illuminate\Database\Eloquent\Factories\Factory;
+
+class ModelWithFactoryFactory extends Factory
+{
+    /**
+     * The name of the factory's corresponding model.
+     *
+     * @var string
+     */
+    protected $model = ModelWithFactory::class;
+
+    /**
+     * Define the model's default state.
+     *
+     * @return array
+     */
+    public function definition()
+    {
+        return [
+            //
+        ];
+    }
+}

tests/Console/ModelsCommand/Factories/Factories/ModelWithNestedFactoryFactory.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Factories;
+
+use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Models\ModelWithNestedFactory;
+use Illuminate\Database\Eloquent\Factories\Factory;
+
+class ModelWithNestedFactoryFactory extends Factory
+{
+    /**
+     * The name of the factory's corresponding model.
+     *
+     * @var string
+     */
+    protected $model = ModelWithNestedFactory::class;
+
+    /**
+     * Define the model's default state.
+     *
+     * @return array
+     */
+    public function definition()
+    {
+        return [
+            //
+        ];
+    }
+}

tests/Console/ModelsCommand/Factories/Models/ModelWithCustomNamespace.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Models;
+
+use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\CustomSpace\ModelWithCustomNamespaceFactory;
+use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Illuminate\Database\Eloquent\Model;
+
+class ModelWithCustomNamespace extends Model
+{
+    use HasFactory;
+
+    /**
+     * Create a new factory instance for the model.
+     *
+     * @return \Illuminate\Database\Eloquent\Factories\Factory
+     */
+    protected static function newFactory()
+    {
+        return ModelWithCustomNamespaceFactory::new();
+    }
+}

tests/Console/ModelsCommand/Factories/Models/ModelWithFactory.php

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

tests/Console/ModelsCommand/Factories/Models/ModelWithNestedFactory.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Models;
+
+class ModelWithNestedFactory extends ModelWithFactory
+{
+}

tests/Console/ModelsCommand/Factories/Models/ModelWithoutFactory.php

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

tests/Console/ModelsCommand/Factories/Test.php

@@ -0,0 +1,45 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories;
+
+use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
+use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AbstractModelsCommand;
+use Closure;
+use Illuminate\Database\Eloquent\Factories\Factory;
+use Illuminate\Support\Str;
+
+class Test extends AbstractModelsCommand
+{
+    public function testFactory(): void
+    {
+        Factory::guessFactoryNamesUsing(static::getFactoryNameResolver());
+
+        $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->assertStringNotContainsString('not found', $tester->getDisplay());
+        $this->assertMatchesMockedSnapshot();
+    }
+
+    public static function getFactoryNameResolver(): Closure
+    {
+        // This mimics the default resolver, but with adjusted test namespaces.
+        // Illuminate\Database\Eloquent\Factories\Factory::resolveFactoryName
+        return function (string $modelName): string {
+            $appNamespace = 'Barryvdh\\LaravelIdeHelper\\Tests\\Console\\ModelsCommand\\Factories\\';
+
+            $modelName = Str::startsWith($modelName, $appNamespace . 'Models\\')
+                ? Str::after($modelName, $appNamespace . 'Models\\')
+                : Str::after($modelName, $appNamespace);
+
+            return $appNamespace . 'Factories\\' . $modelName . 'Factory';
+        };
+    }
+}

tests/Console/ModelsCommand/Factories/__snapshots__/Test__testFactory__1.php

@@ -0,0 +1,94 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Models;
+
+use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\CustomSpace\ModelWithCustomNamespaceFactory;
+use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Illuminate\Database\Eloquent\Model;
+
+/**
+ * 
+ *
+ * @method static \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\CustomSpace\ModelWithCustomNamespaceFactory factory($count = null, $state = [])
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|ModelWithCustomNamespace newModelQuery()
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|ModelWithCustomNamespace newQuery()
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|ModelWithCustomNamespace query()
+ * @mixin \Eloquent
+ */
+class ModelWithCustomNamespace extends Model
+{
+    use HasFactory;
+
+    /**
+     * Create a new factory instance for the model.
+     *
+     * @return \Illuminate\Database\Eloquent\Factories\Factory
+     */
+    protected static function newFactory()
+    {
+        return ModelWithCustomNamespaceFactory::new();
+    }
+}
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Models;
+
+use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Illuminate\Database\Eloquent\Model;
+
+/**
+ * 
+ *
+ * @method static \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Factories\ModelWithFactoryFactory factory($count = null, $state = [])
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|ModelWithFactory newModelQuery()
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|ModelWithFactory newQuery()
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|ModelWithFactory query()
+ * @mixin \Eloquent
+ */
+class ModelWithFactory extends Model
+{
+    use HasFactory;
+}
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Models;
+
+/**
+ * 
+ *
+ * @method static \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Factories\ModelWithNestedFactoryFactory factory($count = null, $state = [])
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|ModelWithNestedFactory newModelQuery()
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|ModelWithNestedFactory newQuery()
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|ModelWithNestedFactory query()
+ * @mixin \Eloquent
+ */
+class ModelWithNestedFactory extends ModelWithFactory
+{
+}
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Models;
+
+use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Illuminate\Database\Eloquent\Model;
+
+/**
+ * 
+ *
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|ModelWithoutFactory newModelQuery()
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|ModelWithoutFactory newQuery()
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|ModelWithoutFactory query()
+ * @mixin \Eloquent
+ */
+class ModelWithoutFactory extends Model
+{
+    use HasFactory;
+}

tests/Console/ModelsCommand/GenerateBasicPhpDocWithEnumDefaults/Enums/PostStatus.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateBasicPhpDocWithEnumDefaults\Enums;
+
+enum PostStatus
+{
+    case Published;
+
+    case Unpublished;
+
+    case Archived;
+}

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

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateBasicPhpDocWithEnumDefaults\Models;
+
+use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateBasicPhpDocWithEnumDefaults\Enums\PostStatus;
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Model;
+
+class Post extends Model
+{
+    public function scopeHasStatus(Builder $query, ?PostStatus $status = PostStatus::Published)
+    {
+        //
+    }
+}