mirror of
https://github.com/barryvdh/laravel-ide-helper.git
synced 2026-08-18 18:13:11 +00:00
Compare commits
92
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
cc26683e8e | ||
|
|
5060909c37 | ||
|
|
3a53071650 | ||
|
|
04c8d5dd2f | ||
|
|
3f742fd665 | ||
|
|
e1b1ef74aa | ||
|
|
7fd3b7aff0 | ||
|
|
1002cb567d | ||
|
|
3e0c12ee0e | ||
|
|
ad7e37676f | ||
|
|
9027494e97 | ||
|
|
c3f795e909 | ||
|
|
2fba281b14 | ||
|
|
39bcb60b7c | ||
|
|
16f685aa9f | ||
|
|
392d5cfc80 | ||
|
|
3d8fccd700 | ||
|
|
e9b62b6ee0 | ||
|
|
37dfcf9e14 | ||
|
|
573c9f3f57 | ||
|
|
fd3cfbe09d | ||
|
|
3bd70eafd0 | ||
|
|
5aca186d92 | ||
|
|
148f956272 | ||
|
|
cff155b0d3 | ||
|
|
d87ec5835d | ||
|
|
b0dcd7c62f | ||
|
|
2ac73f2953 | ||
|
|
c95825a745 | ||
|
|
db606f30d1 | ||
|
|
b106f7ee85 | ||
|
|
d61d20357e | ||
|
|
e9283c40a2 | ||
|
|
12a0d7d54c | ||
|
|
9ef25f60e7 | ||
|
|
8dff6bb5ff | ||
|
|
53854ea7d9 | ||
|
|
1fa84a3b65 | ||
|
|
5e973967a7 | ||
|
|
8d00250cba | ||
|
|
877f5ed0a7 | ||
|
|
fafe264b3c | ||
|
|
108f6269c1 | ||
|
|
c488262f97 | ||
|
|
83e3f39b39 | ||
|
|
31979ed485 | ||
|
|
6d96f0bd1a | ||
|
|
cff244b9b5 | ||
|
|
4dfc08a854 | ||
|
|
6c4ba2ad38 | ||
|
|
1815a6140a | ||
|
|
7c469e4073 | ||
|
|
ae0a06d406 | ||
|
|
e0b2f86326 | ||
|
|
cdefaeed42 | ||
|
|
c775aec1bb | ||
|
|
0fa96e572d | ||
|
|
8eec4f1ff5 | ||
|
|
d567978ebe | ||
|
|
09623f216c | ||
|
|
3d4e37798e | ||
|
|
713a4758f9 | ||
|
|
8d441ec99f | ||
|
|
dba153f1e0 | ||
|
|
40485e7350 | ||
|
|
ead24b10f6 | ||
|
|
187ce9beeb | ||
|
|
6b43ac616d | ||
|
|
980a87e250 | ||
|
|
299a81b9bb | ||
|
|
06c1fab9b5 | ||
|
|
271682a2a6 | ||
|
|
bb1caed698 | ||
|
|
55268cd47a | ||
|
|
088968c3fc | ||
|
|
655e057626 | ||
|
|
c8d85a0d34 | ||
|
|
4c656cc71d | ||
|
|
0fe9774dfb | ||
|
|
030f6f1f35 | ||
|
|
154300fb06 | ||
|
|
05d9c3cd65 | ||
|
|
beda399e7e | ||
|
|
0bbca8f5e2 | ||
|
|
f8381565ad | ||
|
|
cffcd07e98 | ||
|
|
9c6380da4a | ||
|
|
e509790805 | ||
|
|
791ba555f4 | ||
|
|
c324438731 | ||
|
|
4e4da0825a | ||
|
|
66ea6aa57b |
+1
-3
@@ -6,9 +6,7 @@
|
||||
/.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
|
||||
/.php-cs-fixer* export-ignore
|
||||
/phpunit.xml.dist export-ignore
|
||||
/psalm-baseline.xml export-ignore
|
||||
/psalm.xml export-ignore
|
||||
|
||||
@@ -12,7 +12,7 @@ jobs:
|
||||
runs-on: ubuntu-22.04
|
||||
steps:
|
||||
- name: Git checkout
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/checkout@v7
|
||||
|
||||
- name: Validate Composer configuration
|
||||
run: composer validate --strict
|
||||
@@ -23,6 +23,6 @@ jobs:
|
||||
composer global require ergebnis/composer-normalize
|
||||
composer normalize
|
||||
|
||||
- uses: stefanzweifel/git-auto-commit-action@v5
|
||||
- uses: stefanzweifel/git-auto-commit-action@v7
|
||||
with:
|
||||
commit_message: normalize composer.json
|
||||
|
||||
@@ -13,7 +13,7 @@ jobs:
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/checkout@v7
|
||||
|
||||
- name: Setup PHP
|
||||
uses: shivammathur/setup-php@v2
|
||||
@@ -27,7 +27,7 @@ jobs:
|
||||
- run: composer fix-style
|
||||
continue-on-error: true
|
||||
|
||||
- uses: stefanzweifel/git-auto-commit-action@v5
|
||||
- uses: stefanzweifel/git-auto-commit-action@v7
|
||||
with:
|
||||
commit_message: composer fix-style
|
||||
commit_author: laravel-ide-helper <[email protected]>
|
||||
|
||||
@@ -32,7 +32,7 @@ jobs:
|
||||
# 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
|
||||
- uses: release-drafter/release-drafter@v7
|
||||
# (Optional) specify config name to use, relative to .github/. Default: release-drafter.yml
|
||||
# with:
|
||||
# config-name: my-config.yml
|
||||
|
||||
@@ -7,25 +7,30 @@ on:
|
||||
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]
|
||||
php: [8.5, 8.4, 8.3, 8.2]
|
||||
laravel: [12.x, 13.x]
|
||||
exclude:
|
||||
- laravel: 13.x
|
||||
php: 8.2
|
||||
|
||||
name: P${{ matrix.php }} - Laravel${{ matrix.laravel }}
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/checkout@v7
|
||||
with:
|
||||
path: src
|
||||
|
||||
@@ -63,7 +68,6 @@ jobs:
|
||||
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
|
||||
|
||||
@@ -12,7 +12,7 @@ jobs:
|
||||
runs-on: ubuntu-22.04
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: actions/checkout@v7
|
||||
|
||||
- name: Setup PHP
|
||||
uses: shivammathur/setup-php@v2
|
||||
@@ -25,4 +25,4 @@ jobs:
|
||||
run: composer install --prefer-dist --no-progress --no-suggest
|
||||
|
||||
- name: Analyze
|
||||
run: composer analyze
|
||||
run: vendor/bin/phpstan --no-progress --error-format=github
|
||||
|
||||
@@ -7,32 +7,41 @@ on:
|
||||
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]
|
||||
os: [ubuntu-latest]
|
||||
php: [8.5, 8.4, 8.3, 8.2]
|
||||
laravel: [12.x, 13.x, ~11.15]
|
||||
stability: [prefer-lowest, prefer-stable]
|
||||
include:
|
||||
- os: windows-latest
|
||||
php: 8.3
|
||||
laravel: 12.x
|
||||
stability: prefer-stable
|
||||
exclude:
|
||||
- laravel: 13.x
|
||||
php: 8.2
|
||||
|
||||
steps:
|
||||
- name: Set git to use LF
|
||||
if: ${{ matrix.os == 'windows-2019' }}
|
||||
if: "${{ matrix.os == 'windows-latest' }}"
|
||||
run: |
|
||||
git config --global core.autocrlf false
|
||||
git config --global core.eol lf
|
||||
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/checkout@v7
|
||||
|
||||
- name: Setup PHP
|
||||
uses: shivammathur/setup-php@v2
|
||||
|
||||
@@ -16,7 +16,7 @@ jobs:
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/checkout@v7
|
||||
with:
|
||||
ref: ${{ github.event.release.target_commitish }}
|
||||
|
||||
@@ -27,7 +27,7 @@ jobs:
|
||||
release-notes: ${{ github.event.release.body }}
|
||||
|
||||
- name: Commit updated CHANGELOG
|
||||
uses: stefanzweifel/git-auto-commit-action@v5
|
||||
uses: stefanzweifel/git-auto-commit-action@v7
|
||||
with:
|
||||
branch: ${{ github.event.release.target_commitish }}
|
||||
commit_message: Update CHANGELOG
|
||||
|
||||
+2
-1
@@ -1,5 +1,6 @@
|
||||
.phpunit.result.cache
|
||||
|
||||
/auth.json
|
||||
/build
|
||||
/.idea
|
||||
/.php-cs-fixer.cache
|
||||
/.php-cs-fixer.php
|
||||
|
||||
@@ -3,7 +3,7 @@ require __DIR__ . '/vendor/autoload.php';
|
||||
|
||||
$finder = PhpCsFixer\Finder::create()
|
||||
->in(__DIR__)
|
||||
->exclude('tests');
|
||||
->exclude(['tests', 'build']);
|
||||
|
||||
$config = require __DIR__ . '/.php-cs-fixer.common.php';
|
||||
|
||||
|
||||
+195
@@ -1,5 +1,197 @@
|
||||
# Changelog
|
||||
|
||||
## v3.7.0 - 2026-03-17
|
||||
|
||||
### What's Changed
|
||||
|
||||
* Skip calling fake() when required parameters exist (Socialite compatibility) by @Jaspur in https://github.com/barryvdh/laravel-ide-helper/pull/1746
|
||||
* Make Soft Deleted Relationships Nullable by @evan-burrell in https://github.com/barryvdh/laravel-ide-helper/pull/1749
|
||||
* Support all DNF types from PHP RFC by @gurmanolog in https://github.com/barryvdh/laravel-ide-helper/pull/1751
|
||||
* Replace psalm with larastan by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1755
|
||||
* perf: reduce redundant lookups and file I/O in generation hot paths by @pataar in https://github.com/barryvdh/laravel-ide-helper/pull/1757
|
||||
* fix: wrap bare intersection types in parentheses when adding nullable by @pataar in https://github.com/barryvdh/laravel-ide-helper/pull/1756
|
||||
* feat(ModelsCommand): add configuration option to disable model query methods by @pataar in https://github.com/barryvdh/laravel-ide-helper/pull/1692
|
||||
* ci: add PHP 8.5 to integration test matrix by @pataar in https://github.com/barryvdh/laravel-ide-helper/pull/1760
|
||||
* chore: update test snapshots after merge order issue by @pataar in https://github.com/barryvdh/laravel-ide-helper/pull/1762
|
||||
* Laravel 13.x Compatibility by @laravel-shift in https://github.com/barryvdh/laravel-ide-helper/pull/1763
|
||||
* fix: Correct indentation in camel case config comment block by @isaackaara in https://github.com/barryvdh/laravel-ide-helper/pull/1767
|
||||
* fix: Place PHPDoc before class attributes when writing to models by @isaackaara in https://github.com/barryvdh/laravel-ide-helper/pull/1765
|
||||
* fix: Don't extend root's parent class for facade stubs in helper file by @isaackaara in https://github.com/barryvdh/laravel-ide-helper/pull/1766
|
||||
* Fix PHPDoc placement before PHP 8 class attributes and add regression tests by @Copilot in https://github.com/barryvdh/laravel-ide-helper/pull/1769
|
||||
* fix: Skip autoload exception when class existence is being checked by @isaackaara in https://github.com/barryvdh/laravel-ide-helper/pull/1764
|
||||
* Remove closure in attribute test by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1772
|
||||
* Bump branch alias to 3.6 by @jnoordsij in https://github.com/barryvdh/laravel-ide-helper/pull/1774
|
||||
|
||||
### New Contributors
|
||||
|
||||
* @Jaspur made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1746
|
||||
* @evan-burrell made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1749
|
||||
* @gurmanolog made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1751
|
||||
* @laravel-shift made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1763
|
||||
* @isaackaara made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1767
|
||||
* @Copilot made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1769
|
||||
|
||||
**Full Changelog**: https://github.com/barryvdh/laravel-ide-helper/compare/v3.6.1...v3.7.0
|
||||
|
||||
## v3.6.1 - 2025-12-10
|
||||
|
||||
### What's Changed
|
||||
|
||||
* Fix `methodsto` typo in README by @peterchrjoergensen in https://github.com/barryvdh/laravel-ide-helper/pull/1723
|
||||
* Bump actions/checkout from 4 to 5 in the deps group by @dependabot[bot] in https://github.com/barryvdh/laravel-ide-helper/pull/1731
|
||||
* Fix typos in documentation and code comments by @kei1111 in https://github.com/barryvdh/laravel-ide-helper/pull/1733
|
||||
* Add php 8.5 support by @sergiy-petrov in https://github.com/barryvdh/laravel-ide-helper/pull/1735
|
||||
* Fix alias fake error by @WentTheFox in https://github.com/barryvdh/laravel-ide-helper/pull/1745
|
||||
* Remove calls to PHP 8.5-deprecated `setAccessible` by @jnoordsij in https://github.com/barryvdh/laravel-ide-helper/pull/1744
|
||||
* Bump the deps group across 1 directory with 2 updates by @dependabot[bot] in https://github.com/barryvdh/laravel-ide-helper/pull/1743
|
||||
* Add support for `decimal` column type by @BrainStone in https://github.com/barryvdh/laravel-ide-helper/pull/1739
|
||||
|
||||
### New Contributors
|
||||
|
||||
* @peterchrjoergensen made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1723
|
||||
* @kei1111 made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1733
|
||||
* @WentTheFox made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1745
|
||||
* @BrainStone made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1739
|
||||
|
||||
**Full Changelog**: https://github.com/barryvdh/laravel-ide-helper/compare/v3.6.0...v3.6.1
|
||||
|
||||
## v3.6.0 - 2025-07-18
|
||||
|
||||
### What's Changed
|
||||
|
||||
* fix: Change AsArrayObject cast to be Laravel's ArrayObject by @wsamoht in https://github.com/barryvdh/laravel-ide-helper/pull/1675
|
||||
* Add extends declaration for Macroable classes to fix missing inherited methods by @KentarouTakeda in https://github.com/barryvdh/laravel-ide-helper/pull/1674
|
||||
* fix(meta): ignore aliases in the autoloader (Fixes #1671) by @pataar in https://github.com/barryvdh/laravel-ide-helper/pull/1686
|
||||
* feat(ModelsCommand): add support for the new Scope attribute by @pataar in https://github.com/barryvdh/laravel-ide-helper/pull/1694
|
||||
* fix type change for scope default float parameter by @nivseb in https://github.com/barryvdh/laravel-ide-helper/pull/1697
|
||||
* Revert #1629 - *Allow adding custom Macroable classes* by @erikn69 in https://github.com/barryvdh/laravel-ide-helper/pull/1707
|
||||
* Configurable macro return type defaults by @erikn69 in https://github.com/barryvdh/laravel-ide-helper/pull/1711
|
||||
* docs(readme): add Laravel 12 support information by @SantosVilanculos in https://github.com/barryvdh/laravel-ide-helper/pull/1717
|
||||
* Add multi-level directory support for translation files by @RosiersRobin in https://github.com/barryvdh/laravel-ide-helper/pull/1718
|
||||
* Support `AsCollection::of($map)`, `AsCollection::using($class, $map)` by @erikn69 in https://github.com/barryvdh/laravel-ide-helper/pull/1714
|
||||
* fix: Fixed wrong doc for SoftDeletes `withTrashed` method by @eldair in https://github.com/barryvdh/laravel-ide-helper/pull/1688
|
||||
* Support other OS on tests by @erikn69 in https://github.com/barryvdh/laravel-ide-helper/pull/1715
|
||||
* Fix tests on windows by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1720
|
||||
* Bump stefanzweifel/git-auto-commit-action from 5 to 6 in the deps group by @dependabot[bot] in https://github.com/barryvdh/laravel-ide-helper/pull/1719
|
||||
* Update .gitattributes - avoid all `.php-cs-fixer` files on vendor by @erikn69 in https://github.com/barryvdh/laravel-ide-helper/pull/1708
|
||||
* fix(ModelsCommand): use 'string' as realType for 'encrypted' casts by @pataar in https://github.com/barryvdh/laravel-ide-helper/pull/1698
|
||||
* Trim strings and bump reflection docblock by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1721
|
||||
* Add magic *_exists properties by @erikn69 in https://github.com/barryvdh/laravel-ide-helper/pull/1712
|
||||
|
||||
### New Contributors
|
||||
|
||||
* @wsamoht made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1675
|
||||
* @nivseb made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1697
|
||||
* @SantosVilanculos made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1717
|
||||
* @RosiersRobin made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1718
|
||||
|
||||
**Full Changelog**: https://github.com/barryvdh/laravel-ide-helper/compare/v3.5.5...v3.6.0
|
||||
|
||||
## v3.5.5 - 2025-02-21
|
||||
|
||||
### What's Changed
|
||||
|
||||
* Fix for incorrect config item types in meta file by @eldair in https://github.com/barryvdh/laravel-ide-helper/pull/1662
|
||||
* Prevent generation of incorrect property annotation by @skyler544 in https://github.com/barryvdh/laravel-ide-helper/pull/1665
|
||||
* Fix MorphTo Model Doc Generation by @yparitcher in https://github.com/barryvdh/laravel-ide-helper/pull/1668
|
||||
* Laravel 12 support by @jonnott in https://github.com/barryvdh/laravel-ide-helper/pull/1672
|
||||
|
||||
### New Contributors
|
||||
|
||||
* @eldair made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1662
|
||||
* @skyler544 made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1665
|
||||
* @yparitcher made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1668
|
||||
* @jonnott made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1672
|
||||
|
||||
**Full Changelog**: https://github.com/barryvdh/laravel-ide-helper/compare/v3.5.4...v3.5.5
|
||||
|
||||
## v3.5.4 - 2025-01-14
|
||||
|
||||
### What's Changed
|
||||
|
||||
* Convert auth() helper to use Auth facade by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1656
|
||||
* Check if returnType from docblock is not null by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1658
|
||||
|
||||
**Full Changelog**: https://github.com/barryvdh/laravel-ide-helper/compare/v3.5.3...v3.5.4
|
||||
|
||||
## v3.5.3 - 2025-01-08
|
||||
|
||||
### What's Changed
|
||||
|
||||
* Catch meta, tweak auth by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1654
|
||||
* Check if macro is valid by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1655
|
||||
* feat: use generics of return type to determine resulting models by @Bloemendaal in https://github.com/barryvdh/laravel-ide-helper/pull/1653
|
||||
|
||||
### New Contributors
|
||||
|
||||
* @Bloemendaal made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1653
|
||||
|
||||
**Full Changelog**: https://github.com/barryvdh/laravel-ide-helper/compare/v3.5.2...v3.5.3
|
||||
|
||||
## v3.5.2 - 2025-01-06
|
||||
|
||||
### Fixes
|
||||
|
||||
Fix empty/anonymous closure in meta command.
|
||||
|
||||
**Full Changelog**: https://github.com/barryvdh/laravel-ide-helper/compare/v3.5.1...v3.5.2
|
||||
|
||||
## v3.5.1 - 2025-01-06
|
||||
|
||||
### What's Changed
|
||||
|
||||
* Remove duplicate config, fix ->can() by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1650
|
||||
|
||||
**Full Changelog**: https://github.com/barryvdh/laravel-ide-helper/compare/v3.5.0...v3.5.1
|
||||
|
||||
## v3.5.0 - 2025-01-06
|
||||
|
||||
### What's Changed
|
||||
|
||||
* Add phpstorm meta argument hints by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1640
|
||||
* Add meta override for user return types by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1642
|
||||
* Use forked ContextFactory by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1643
|
||||
* Remove php parser by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1644
|
||||
* Also add eloquent template tags from base class by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1645
|
||||
* Add more metadata by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1646
|
||||
* Fixed generating PHPDoc for methods with class templates by @chack1172 in https://github.com/barryvdh/laravel-ide-helper/pull/1647
|
||||
* Feat guess macro types by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1648
|
||||
* Allow adding custom Macroable classes. by @mathieutu in https://github.com/barryvdh/laravel-ide-helper/pull/1629
|
||||
* Add special `dev` to composer keywords by @jnoordsij in https://github.com/barryvdh/laravel-ide-helper/pull/1649
|
||||
|
||||
### New Contributors
|
||||
|
||||
* @chack1172 made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1647
|
||||
* @mathieutu made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1629
|
||||
* @jnoordsij made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1649
|
||||
|
||||
**Full Changelog**: https://github.com/barryvdh/laravel-ide-helper/compare/v3.4.0...v3.5.0
|
||||
|
||||
## v3.4.0 - 2024-12-29
|
||||
|
||||
### What's Changed
|
||||
|
||||
* fix: add @template TModel of static for Eloquent by @imzyf in https://github.com/barryvdh/laravel-ide-helper/pull/1631
|
||||
* Add templates to Eloquent by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1634
|
||||
* Update testsuite for Generator, simplify service provider and mock by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1635
|
||||
* Add option for only eloquent by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1636
|
||||
* Add weak generics for array type objects by @LauJosefsen in https://github.com/barryvdh/laravel-ide-helper/pull/1621
|
||||
* Make all "note" in README apply quote style by @hms5232 in https://github.com/barryvdh/laravel-ide-helper/pull/1590
|
||||
* Update README.md by @Mtillmann in https://github.com/barryvdh/laravel-ide-helper/pull/1587
|
||||
* Rename view var by @barryvdh and @pb30 in https://github.com/barryvdh/laravel-ide-helper/pull/1637 and https://github.com/barryvdh/laravel-ide-helper/pull/1563
|
||||
* Format IDE helper by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1638
|
||||
* Add TLDR section, update options by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1639
|
||||
|
||||
### New Contributors
|
||||
|
||||
* @imzyf made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1631
|
||||
* @LauJosefsen made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1621
|
||||
* @hms5232 made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1590
|
||||
* @Mtillmann made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1587
|
||||
* @pb30 made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1563
|
||||
|
||||
**Full Changelog**: https://github.com/barryvdh/laravel-ide-helper/compare/v3.3.0...v3.4.0
|
||||
|
||||
## v3.3.0 - 2024-12-18
|
||||
|
||||
### What's Changed
|
||||
@@ -54,11 +246,14 @@
|
||||
- Fix type of hashed model property to `string`
|
||||
|
||||
### Changed
|
||||
|
||||
- Update view "version" variable name to avoid potential conflicts
|
||||
|
||||
- Add support for EloquentBuilder generics introduced in Laravel 11.15.
|
||||
|
||||
- Drop support for Laravel versions earlier than 11.15.
|
||||
|
||||
|
||||
### Added
|
||||
|
||||
- Introduce `enforce_nullable_relationships` configuration option to control how nullable Eloquent relationships are enforced during static analysis. This provides flexibility for scenarios where application logic ensures data integrity without relying on database constraints. [#1580 / jeramyhing](https://github.com/barryvdh/laravel-ide-helper/pull/1580)
|
||||
|
||||
@@ -11,7 +11,7 @@
|
||||
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.
|
||||
The 3.x branch supports Laravel 10 and later. For older version, use the 2.x releases.
|
||||
|
||||
- [Installation](#installation)
|
||||
- [Usage](#usage)
|
||||
@@ -51,7 +51,7 @@ php artisan ide-helper:models -RW
|
||||
|
||||
If you don't want the full _ide_helper.php file, you can run add `--write-eloquent-helper` to the model command to generate small version, which is required for the `@mixin \Eloquent` to be able to add the QueryBuilder methods.
|
||||
|
||||
If you don't want to add all the phpdocs to your Models directly, you can use `--nowrite` to create a seperate file. The `--write-mixin` option can be used to only add a `@mixin` to your models, but add the generated phpdocs in a seperate file. This avoids having the results marked as duplicate.
|
||||
If you don't want to add all the phpdocs to your Models directly, you can use `--nowrite` to create a separate file. The `--write-mixin` option can be used to only add a `@mixin` to your models, but add the generated phpdocs in a separate file. This avoids having the results marked as duplicate.
|
||||
|
||||
|
||||
_Check out [this Laracasts video](https://laracasts.com/series/how-to-be-awesome-in-phpstorm/episodes/15) for a quick introduction/explanation!_
|
||||
@@ -210,11 +210,11 @@ Eloquent allows calling `where<Attribute>` on your models, e.g. `Post::whereTitl
|
||||
|
||||
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
|
||||
#### Magic `*_count` and `*_exists` 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.
|
||||
You may use the [`::withCount`](https://laravel.com/docs/master/eloquent-relationships#counting-related-models) and [`::withExists`](https://laravel.com/docs/master/eloquent-relationships#other-aggregate-functions) methods to count the number results from a relationship without actually loading them. Those results are then placed in attributes following the `<columnname>_count` and `<columnname>_exists` 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`.
|
||||
By default, these attributes are generated in the phpdoc. You can turn them off by setting the config `write_model_relation_count_properties` and `write_model_relation_exists_properties` to `false`.
|
||||
|
||||
#### Generics annotations
|
||||
|
||||
|
||||
+18
-17
@@ -11,7 +11,8 @@
|
||||
"netbeans",
|
||||
"sublime",
|
||||
"codeintel",
|
||||
"phpdoc"
|
||||
"phpdoc",
|
||||
"dev"
|
||||
],
|
||||
"authors": [
|
||||
{
|
||||
@@ -22,25 +23,25 @@
|
||||
"require": {
|
||||
"php": "^8.2",
|
||||
"ext-json": "*",
|
||||
"barryvdh/reflection-docblock": "^2.2",
|
||||
"barryvdh/reflection-docblock": "^2.4",
|
||||
"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"
|
||||
"illuminate/console": "^11.15 || ^12 || ^13.0",
|
||||
"illuminate/database": "^11.15 || ^12 || ^13.0",
|
||||
"illuminate/filesystem": "^11.15 || ^12 || ^13.0",
|
||||
"illuminate/support": "^11.15 || ^12 || ^13.0"
|
||||
},
|
||||
"require-dev": {
|
||||
"ext-pdo_sqlite": "*",
|
||||
"friendsofphp/php-cs-fixer": "^3",
|
||||
"illuminate/config": "^11.15",
|
||||
"illuminate/view": "^11.15",
|
||||
"illuminate/config": "^11.15 || ^12 || ^13.0",
|
||||
"illuminate/view": "^11.15 || ^12 || ^13.0",
|
||||
"larastan/larastan": "^3.1",
|
||||
"mockery/mockery": "^1.4",
|
||||
"orchestra/testbench": "^9.2",
|
||||
"phpunit/phpunit": "^10.5",
|
||||
"orchestra/testbench": "^9.2 || ^10 || ^11.0",
|
||||
"phpstan/phpstan-phpunit": "^2.0",
|
||||
"phpunit/phpunit": "^10.5 || ^11.5.3 || ^12.5.12",
|
||||
"spatie/phpunit-snapshot-assertions": "^4 || ^5",
|
||||
"vimeo/psalm": "^5.4"
|
||||
"vlucas/phpdotenv": "^5"
|
||||
},
|
||||
"suggest": {
|
||||
"illuminate/events": "Required for automatic helper generation (^6|^7|^8|^9|^10|^11)."
|
||||
@@ -65,7 +66,7 @@
|
||||
},
|
||||
"extra": {
|
||||
"branch-alias": {
|
||||
"dev-master": "3.4-dev"
|
||||
"dev-master": "3.7-dev"
|
||||
},
|
||||
"laravel": {
|
||||
"providers": [
|
||||
@@ -74,7 +75,8 @@
|
||||
}
|
||||
},
|
||||
"scripts": {
|
||||
"analyze": "psalm",
|
||||
"analyze": "phpstan",
|
||||
"analyze-set-baseline": "phpstan --generate-baseline",
|
||||
"check-style": [
|
||||
"php-cs-fixer fix --diff --diff-format=udiff --dry-run",
|
||||
"php-cs-fixer fix --diff --diff-format=udiff --dry-run --config=.php_cs.tests.php"
|
||||
@@ -83,9 +85,8 @@
|
||||
"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-ci": "phpunit",
|
||||
"test-regenerate": "phpunit -d --update-snapshots"
|
||||
}
|
||||
}
|
||||
|
||||
+45
-8
@@ -49,17 +49,14 @@ return [
|
||||
|
||||
/*
|
||||
|--------------------------------------------------------------------------
|
||||
| Factory builders
|
||||
| Write model query methods
|
||||
|--------------------------------------------------------------------------
|
||||
|
|
||||
| Set to true to generate factory generators for better factory()
|
||||
| method auto-completion.
|
||||
|
|
||||
| Deprecated for Laravel 8 or latest.
|
||||
| Set to false to disable generated docs for the 'query()', 'newQuery()' and 'newModelQuery()' methods.
|
||||
|
|
||||
*/
|
||||
|
||||
'include_factory_builders' => false,
|
||||
'write_query_methods' => true,
|
||||
|
||||
/*
|
||||
|--------------------------------------------------------------------------
|
||||
@@ -85,14 +82,16 @@ return [
|
||||
|
||||
/*
|
||||
|--------------------------------------------------------------------------
|
||||
| Write model relation count properties
|
||||
| Write model relation count and exists properties
|
||||
|--------------------------------------------------------------------------
|
||||
|
|
||||
| Set to false to disable writing of relation count properties to model DocBlocks.
|
||||
| Set to false to disable writing of relation count and exists properties
|
||||
| to model DocBlocks.
|
||||
|
|
||||
*/
|
||||
|
||||
'write_model_relation_count_properties' => true,
|
||||
'write_model_relation_exists_properties' => false,
|
||||
|
||||
/*
|
||||
|--------------------------------------------------------------------------
|
||||
@@ -123,6 +122,7 @@ return [
|
||||
|
||||
'helper_files' => [
|
||||
base_path() . '/vendor/laravel/framework/src/Illuminate/Support/helpers.php',
|
||||
base_path() . '/vendor/laravel/framework/src/Illuminate/Foundation/helpers.php',
|
||||
],
|
||||
|
||||
/*
|
||||
@@ -273,6 +273,20 @@ return [
|
||||
*/
|
||||
'use_generics_annotations' => true,
|
||||
|
||||
/*
|
||||
|--------------------------------------------------------------------------
|
||||
| Default return types for macros
|
||||
|--------------------------------------------------------------------------
|
||||
|
|
||||
| Define default return types for macros without explicit return types.
|
||||
| e.g. `\Illuminate\Database\Query\Builder::class => 'static'`,
|
||||
| `\Illuminate\Support\Str::class => 'string'`
|
||||
|
|
||||
*/
|
||||
'macro_default_return_types' => [
|
||||
Illuminate\Http\Client\Factory::class => Illuminate\Http\Client\PendingRequest::class,
|
||||
],
|
||||
|
||||
/*
|
||||
|--------------------------------------------------------------------------
|
||||
| Additional relation types
|
||||
@@ -322,6 +336,29 @@ return [
|
||||
|
||||
'enforce_nullable_relationships' => true,
|
||||
|
||||
/*
|
||||
|--------------------------------------------------------------------------
|
||||
| Make soft deletable relations nullable
|
||||
|--------------------------------------------------------------------------
|
||||
|
|
||||
| When set to true (default), relationships to models using SoftDeletes trait
|
||||
| will be marked as nullable. This is because soft-deleted records are excluded
|
||||
| from queries by default, meaning even non-nullable foreign keys can return
|
||||
| null when the related model is soft-deleted.
|
||||
|
|
||||
| Default: true
|
||||
| A relationship to a soft-deletable model will include |null in the type:
|
||||
| * @property-read Team|null $team
|
||||
|
|
||||
| Option: false
|
||||
| A relationship to a soft-deletable model will NOT include |null (unless
|
||||
| nullable for other reasons such as nullable foreign key column):
|
||||
| * @property-read Team $team
|
||||
|
|
||||
*/
|
||||
|
||||
'soft_deletes_force_nullable' => true,
|
||||
|
||||
/*
|
||||
|--------------------------------------------------------------------------
|
||||
| Run artisan commands after migrations to generate model helpers
|
||||
|
||||
@@ -0,0 +1,21 @@
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) Taylor Otwell
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in
|
||||
all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
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.
|
||||
@@ -0,0 +1,5 @@
|
||||
The templates here are based on the official VS Code extension by Laravel https://github.com/laravel/vs-code-extension
|
||||
|
||||
Modifications:
|
||||
- return instead of echo
|
||||
- do not serialize to JSON
|
||||
@@ -0,0 +1,43 @@
|
||||
<?php
|
||||
|
||||
return collect(Illuminate\Support\Facades\Gate::abilities())
|
||||
->map(function ($policy, $key) {
|
||||
$reflection = new ReflectionFunction($policy);
|
||||
|
||||
$policyClass = null;
|
||||
|
||||
$closureThis = $reflection->getClosureThis();
|
||||
if ($closureThis && get_class($closureThis) === Illuminate\Auth\Access\Gate::class) {
|
||||
$vars = $reflection->getClosureUsedVariables();
|
||||
|
||||
if (isset($vars['callback'])) {
|
||||
[$policyClass, $method] = explode('@', $vars['callback']);
|
||||
|
||||
$reflection = new ReflectionMethod($policyClass, $method);
|
||||
}
|
||||
}
|
||||
return [
|
||||
'key' => $key,
|
||||
'uri' => $reflection->getFileName(),
|
||||
'policy_class' => $policyClass,
|
||||
'lineNumber' => $reflection->getStartLine(),
|
||||
];
|
||||
})
|
||||
->merge(
|
||||
collect(Illuminate\Support\Facades\Gate::policies())->flatMap(function ($policy, $model) {
|
||||
$methods = (new ReflectionClass($policy))->getMethods();
|
||||
|
||||
return collect($methods)->map(function (ReflectionMethod $method) use ($policy) {
|
||||
return [
|
||||
'key' => $method->getName(),
|
||||
'uri' => $method->getFileName(),
|
||||
'policy_class' => $policy,
|
||||
'lineNumber' => $method->getStartLine(),
|
||||
];
|
||||
})->filter(function ($ability) {
|
||||
return !in_array($ability['key'], ['allow', 'deny']);
|
||||
});
|
||||
}),
|
||||
)
|
||||
->values()
|
||||
->groupBy('key');
|
||||
@@ -0,0 +1,131 @@
|
||||
<?php
|
||||
|
||||
$local = collect(glob(config_path('/*.php')))
|
||||
->merge(glob(config_path('**/*.php')))
|
||||
->map(fn ($path) => [
|
||||
(string) Illuminate\Support\Str::of($path)
|
||||
->replace([config_path('/'), '.php'], '')
|
||||
->replace('/', '.'),
|
||||
$path,
|
||||
]);
|
||||
|
||||
$vendor = collect(glob(base_path('vendor/**/**/config/*.php')))->map(fn (
|
||||
$path
|
||||
) => [
|
||||
(string) Illuminate\Support\Str::of($path)
|
||||
->afterLast('/config/')
|
||||
->replace('.php', '')
|
||||
->replace('/', '.'),
|
||||
$path,
|
||||
]);
|
||||
|
||||
$configPaths = $local
|
||||
->merge($vendor)
|
||||
->groupBy(0)
|
||||
->map(fn ($items) => $items->pluck(1));
|
||||
|
||||
$cachedContents = [];
|
||||
$cachedParsed = [];
|
||||
|
||||
function vsCodeGetConfigValue($value, $key, $configPaths)
|
||||
{
|
||||
$parts = explode('.', $key);
|
||||
$toFind = $key;
|
||||
$found = null;
|
||||
|
||||
while (count($parts) > 0) {
|
||||
array_pop($parts);
|
||||
$toFind = implode('.', $parts);
|
||||
|
||||
if ($configPaths->has($toFind)) {
|
||||
$found = $toFind;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
if ($found === null) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$file = null;
|
||||
$line = null;
|
||||
|
||||
if ($found === $key) {
|
||||
$file = $configPaths->get($found)[0];
|
||||
} else {
|
||||
foreach ($configPaths->get($found) as $path) {
|
||||
$cachedContents[$path] ??= file_get_contents($path);
|
||||
$cachedParsed[$path] ??= token_get_all($cachedContents[$path]);
|
||||
|
||||
$keysToFind = Illuminate\Support\Str::of($key)
|
||||
->replaceFirst($found, '')
|
||||
->ltrim('.')
|
||||
->explode('.');
|
||||
|
||||
if (is_numeric($keysToFind->last())) {
|
||||
$index = $keysToFind->pop();
|
||||
|
||||
if ($index !== '0') {
|
||||
return null;
|
||||
}
|
||||
|
||||
$key = collect(explode('.', $key));
|
||||
$key->pop();
|
||||
$key = $key->implode('.');
|
||||
$value = [];
|
||||
}
|
||||
|
||||
$nextKey = $keysToFind->shift();
|
||||
$expectedDepth = 1;
|
||||
|
||||
$depth = 0;
|
||||
|
||||
foreach ($cachedParsed[$path] as $token) {
|
||||
if ($token === '[') {
|
||||
$depth++;
|
||||
}
|
||||
|
||||
if ($token === ']') {
|
||||
$depth--;
|
||||
}
|
||||
|
||||
if (!is_array($token)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$str = trim($token[1], '"\'');
|
||||
|
||||
if (
|
||||
$str === $nextKey &&
|
||||
$depth === $expectedDepth &&
|
||||
$token[0] === T_CONSTANT_ENCAPSED_STRING
|
||||
) {
|
||||
$nextKey = $keysToFind->shift();
|
||||
$expectedDepth++;
|
||||
|
||||
if ($nextKey === null) {
|
||||
$file = $path;
|
||||
$line = $token[2];
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if ($file) {
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return [
|
||||
'name' => $key,
|
||||
'value' => $value,
|
||||
'file' => $file === null ? null : str_replace(base_path('/'), '', $file),
|
||||
'line' => $line,
|
||||
];
|
||||
}
|
||||
|
||||
return collect(Illuminate\Support\Arr::dot(config()->all()))
|
||||
->map(fn ($value, $key) => vsCodeGetConfigValue($value, $key, $configPaths))
|
||||
->filter()
|
||||
->values();
|
||||
@@ -0,0 +1,64 @@
|
||||
<?php
|
||||
|
||||
return collect(app("Illuminate\Contracts\Http\Kernel")->getMiddlewareGroups())
|
||||
->merge(app("Illuminate\Contracts\Http\Kernel")->getRouteMiddleware())
|
||||
->map(function ($middleware, $key) {
|
||||
$result = [
|
||||
'class' => null,
|
||||
'uri' => null,
|
||||
'startLine' => null,
|
||||
'parameters' => null,
|
||||
'groups' => [],
|
||||
];
|
||||
|
||||
if (is_array($middleware)) {
|
||||
$result['groups'] = collect($middleware)->map(function ($m) {
|
||||
if (!class_exists($m)) {
|
||||
return [
|
||||
'class' => $m,
|
||||
'uri' => null,
|
||||
'startLine' => null,
|
||||
];
|
||||
}
|
||||
|
||||
$reflected = new ReflectionClass($m);
|
||||
$reflectedMethod = $reflected->getMethod('handle');
|
||||
|
||||
return [
|
||||
'class' => $m,
|
||||
'uri' => $reflected->getFileName(),
|
||||
'startLine' =>
|
||||
$reflectedMethod->getFileName() === $reflected->getFileName()
|
||||
? $reflectedMethod->getStartLine()
|
||||
: null,
|
||||
];
|
||||
})->all();
|
||||
|
||||
return $result;
|
||||
}
|
||||
|
||||
$reflected = new ReflectionClass($middleware);
|
||||
$reflectedMethod = $reflected->getMethod('handle');
|
||||
|
||||
$result = array_merge($result, [
|
||||
'class' => $middleware,
|
||||
'uri' => $reflected->getFileName(),
|
||||
'startLine' => $reflectedMethod->getStartLine(),
|
||||
]);
|
||||
|
||||
$parameters = collect($reflectedMethod->getParameters())
|
||||
->filter(function ($rc) {
|
||||
return $rc->getName() !== 'request' && $rc->getName() !== 'next';
|
||||
})
|
||||
->map(function ($rc) {
|
||||
return $rc->getName() . ($rc->isVariadic() ? '...' : '');
|
||||
});
|
||||
|
||||
if ($parameters->isEmpty()) {
|
||||
return $result;
|
||||
}
|
||||
|
||||
return array_merge($result, [
|
||||
'parameters' => $parameters->implode(','),
|
||||
]);
|
||||
});
|
||||
@@ -0,0 +1,46 @@
|
||||
<?php
|
||||
|
||||
function vsCodeGetRouterReflection(Illuminate\Routing\Route $route)
|
||||
{
|
||||
if ($route->getActionName() === 'Closure') {
|
||||
return new ReflectionFunction($route->getAction()['uses']);
|
||||
}
|
||||
|
||||
if (!str_contains($route->getActionName(), '@')) {
|
||||
return new ReflectionClass($route->getActionName());
|
||||
}
|
||||
|
||||
try {
|
||||
return new ReflectionMethod($route->getControllerClass(), $route->getActionMethod());
|
||||
} catch (Throwable $e) {
|
||||
$namespace = app(Illuminate\Routing\UrlGenerator::class)->getRootControllerNamespace()
|
||||
?? (app()->getNamespace() . 'Http\Controllers');
|
||||
|
||||
return new ReflectionMethod(
|
||||
$namespace . '\\' . ltrim($route->getControllerClass(), '\\'),
|
||||
$route->getActionMethod(),
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
return collect(app('router')->getRoutes()->getRoutes())
|
||||
->map(function (Illuminate\Routing\Route $route) {
|
||||
try {
|
||||
$reflection = vsCodeGetRouterReflection($route);
|
||||
} catch (Throwable $e) {
|
||||
$reflection = null;
|
||||
}
|
||||
|
||||
return [
|
||||
'method' => collect($route->methods())->filter(function ($method) {
|
||||
return $method !== 'HEAD';
|
||||
})->implode('|'),
|
||||
'uri' => $route->uri(),
|
||||
'name' => $route->getName(),
|
||||
'action' => $route->getActionName(),
|
||||
'parameters' => $route->parameterNames(),
|
||||
'filename' => $reflection ? $reflection->getFileName() : null,
|
||||
'line' => $reflection ? $reflection->getStartLine() : null,
|
||||
];
|
||||
})
|
||||
;
|
||||
@@ -0,0 +1,160 @@
|
||||
<?php
|
||||
|
||||
function vsCodeGetTranslationsFromFile(Symfony\Component\Finder\SplFileInfo $file, $path, $namespace)
|
||||
{
|
||||
if ($file->getExtension() !== 'php') {
|
||||
return null;
|
||||
}
|
||||
|
||||
$filePath = $file->getRealPath();
|
||||
|
||||
$relativePath = trim(str_replace($path, '', $file->getPath()), DIRECTORY_SEPARATOR);
|
||||
$lang = explode(DIRECTORY_SEPARATOR, $relativePath)[0] ?? null;
|
||||
|
||||
if (!$lang) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$keyPath = str_replace($path . DIRECTORY_SEPARATOR . $lang . DIRECTORY_SEPARATOR, '', $filePath);
|
||||
$keyWithSlashes = str_replace('.php', '', $keyPath);
|
||||
$baseKey = str_replace(DIRECTORY_SEPARATOR, '.', $keyWithSlashes);
|
||||
|
||||
if ($namespace) {
|
||||
$baseKey = "{$namespace}::{$baseKey}";
|
||||
}
|
||||
|
||||
try {
|
||||
$translations = require $filePath;
|
||||
} catch (Throwable $e) {
|
||||
return null;
|
||||
}
|
||||
|
||||
if (!is_array($translations)) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$fileLines = Illuminate\Support\Facades\File::lines($filePath);
|
||||
$lines = [];
|
||||
$inComment = false;
|
||||
|
||||
foreach ($fileLines as $index => $line) {
|
||||
$trimmed = trim($line);
|
||||
if (str_starts_with($trimmed, '/*')) {
|
||||
$inComment = true;
|
||||
}
|
||||
if ($inComment) {
|
||||
if (str_ends_with($trimmed, '*/')) {
|
||||
$inComment = false;
|
||||
}
|
||||
continue;
|
||||
}
|
||||
if (str_starts_with($trimmed, '//')) {
|
||||
continue;
|
||||
}
|
||||
$lines[] = [$index + 1, $trimmed];
|
||||
}
|
||||
|
||||
return [
|
||||
'k' => $baseKey,
|
||||
'la' => $lang,
|
||||
'vs' => collect(Illuminate\Support\Arr::dot($translations))
|
||||
->map(
|
||||
fn ($value, $dotKey) => vsCodeTranslationValue(
|
||||
$dotKey,
|
||||
$value,
|
||||
str_replace(base_path(DIRECTORY_SEPARATOR), '', $filePath),
|
||||
$lines
|
||||
)
|
||||
)
|
||||
->filter(),
|
||||
];
|
||||
}
|
||||
|
||||
function vsCodeTranslationValue($key, $value, $file, $lines): ?array
|
||||
{
|
||||
if (is_array($value)) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$lineNumber = 1;
|
||||
$keys = explode('.', $key);
|
||||
$currentKey = array_shift($keys);
|
||||
|
||||
foreach ($lines as $line) {
|
||||
if (
|
||||
strpos($line[1], '"' . $currentKey . '"') !== false ||
|
||||
strpos($line[1], "'" . $currentKey . "'") !== false
|
||||
) {
|
||||
$lineNumber = $line[0];
|
||||
$currentKey = array_shift($keys);
|
||||
}
|
||||
|
||||
if ($currentKey === null) {
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
return [
|
||||
'v' => $value,
|
||||
'p' => $file,
|
||||
'li' => $lineNumber,
|
||||
'pa' => preg_match_all("/\:([A-Za-z0-9_]+)/", $value, $matches)
|
||||
? $matches[1]
|
||||
: [],
|
||||
];
|
||||
}
|
||||
|
||||
function vscodeCollectTranslations(string $path, ?string $namespace = null)
|
||||
{
|
||||
$realPath = realpath($path);
|
||||
|
||||
if (!is_dir($realPath)) {
|
||||
return collect();
|
||||
}
|
||||
|
||||
return collect(Illuminate\Support\Facades\File::allFiles($realPath))
|
||||
->map(fn ($file) => vsCodeGetTranslationsFromFile($file, $path, $namespace))
|
||||
->filter();
|
||||
}
|
||||
|
||||
$loader = app('translator')->getLoader();
|
||||
$namespaces = $loader->namespaces();
|
||||
|
||||
$reflection = new ReflectionClass($loader);
|
||||
$property = $reflection->hasProperty('paths')
|
||||
? $reflection->getProperty('paths')
|
||||
: $reflection->getProperty('path');
|
||||
|
||||
$paths = Illuminate\Support\Arr::wrap($property->getValue($loader));
|
||||
|
||||
$default = collect($paths)->flatMap(
|
||||
fn ($path) => vscodeCollectTranslations($path)
|
||||
);
|
||||
|
||||
$namespaced = collect($namespaces)->flatMap(
|
||||
fn ($path, $namespace) => vscodeCollectTranslations($path, $namespace)
|
||||
);
|
||||
|
||||
$final = [];
|
||||
|
||||
foreach ($default->merge($namespaced) as $value) {
|
||||
if (!isset($value['vs']) || !is_iterable($value['vs'])) {
|
||||
continue;
|
||||
}
|
||||
|
||||
foreach ($value['vs'] as $key => $v) {
|
||||
$dotKey = "{$value['k']}.{$key}";
|
||||
|
||||
if (!isset($final[$dotKey])) {
|
||||
$final[$dotKey] = [];
|
||||
}
|
||||
|
||||
$final[$dotKey][$value['la']] = $v;
|
||||
|
||||
if ($value['la'] === Illuminate\Support\Facades\App::currentLocale()) {
|
||||
$final[$dotKey]['default'] = $v;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return collect($final);
|
||||
@@ -0,0 +1,61 @@
|
||||
<?php
|
||||
|
||||
function vsCodeFindBladeFiles($path)
|
||||
{
|
||||
$paths = [];
|
||||
|
||||
if (!is_dir($path)) {
|
||||
return $paths;
|
||||
}
|
||||
|
||||
foreach (
|
||||
Symfony\Component\Finder\Finder::create()
|
||||
->files()
|
||||
->name('*.blade.php')
|
||||
->in($path) as $file
|
||||
) {
|
||||
$paths[] = [
|
||||
'path' => str_replace(base_path(DIRECTORY_SEPARATOR), '', $file->getRealPath()),
|
||||
'isVendor' => str_contains($file->getRealPath(), base_path('vendor')),
|
||||
'key' => Illuminate\Support\Str::of($file->getRealPath())
|
||||
->replace(realpath($path), '')
|
||||
->replace('.blade.php', '')
|
||||
->ltrim(DIRECTORY_SEPARATOR)
|
||||
->replace(DIRECTORY_SEPARATOR, '.'),
|
||||
];
|
||||
}
|
||||
|
||||
return $paths;
|
||||
}
|
||||
$paths = collect(
|
||||
app('view')
|
||||
->getFinder()
|
||||
->getPaths()
|
||||
)->flatMap(function ($path) {
|
||||
return vsCodeFindBladeFiles($path);
|
||||
});
|
||||
|
||||
$hints = collect(
|
||||
app('view')
|
||||
->getFinder()
|
||||
->getHints()
|
||||
)->flatMap(function ($paths, $key) {
|
||||
return collect($paths)->flatMap(function ($path) use ($key) {
|
||||
return collect(vsCodeFindBladeFiles($path))->map(function ($value) use (
|
||||
$key
|
||||
) {
|
||||
return array_merge($value, ['key' => "{$key}::{$value['key']}"]);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
[$local, $vendor] = $paths
|
||||
->merge($hints)
|
||||
->values()
|
||||
->partition(function ($v) {
|
||||
return !$v['isVendor'];
|
||||
});
|
||||
|
||||
return $local
|
||||
->sortBy('key', SORT_NATURAL)
|
||||
->merge($vendor->sortBy('key', SORT_NATURAL));
|
||||
@@ -0,0 +1,67 @@
|
||||
parameters:
|
||||
ignoreErrors:
|
||||
-
|
||||
message: '#^File ends with a trailing whitespace\. This may cause problems when running the code in the web browser\. Remove the closing \?\> mark or remove the whitespace\.$#'
|
||||
identifier: whitespace.fileEnd
|
||||
count: 1
|
||||
path: resources/views/helper.php
|
||||
|
||||
-
|
||||
message: '#^Call to an undefined method Illuminate\\Contracts\\Filesystem\\Filesystem\:\:requireOnce\(\)\.$#'
|
||||
identifier: method.notFound
|
||||
count: 1
|
||||
path: src/Console/MetaCommand.php
|
||||
|
||||
-
|
||||
message: '#^Call to an undefined method Illuminate\\Contracts\\Foundation\\Application\:\:getBindings\(\)\.$#'
|
||||
identifier: method.notFound
|
||||
count: 1
|
||||
path: src/Console/MetaCommand.php
|
||||
|
||||
-
|
||||
message: '#^Call to an undefined method Barryvdh\\Reflection\\DocBlock\\Tag\:\:getMethodName\(\)\.$#'
|
||||
identifier: method.notFound
|
||||
count: 1
|
||||
path: src/Console/ModelsCommand.php
|
||||
|
||||
-
|
||||
message: '#^Call to an undefined method Barryvdh\\Reflection\\DocBlock\\Tag\:\:getType\(\)\.$#'
|
||||
identifier: method.notFound
|
||||
count: 1
|
||||
path: src/Console/ModelsCommand.php
|
||||
|
||||
-
|
||||
message: '#^Call to an undefined method Barryvdh\\Reflection\\DocBlock\\Tag\:\:getVariableName\(\)\.$#'
|
||||
identifier: method.notFound
|
||||
count: 1
|
||||
path: src/Console/ModelsCommand.php
|
||||
|
||||
-
|
||||
message: '#^Call to an undefined method Illuminate\\Support\\Optional\:\:getNumberOfParameters\(\)\.$#'
|
||||
identifier: method.notFound
|
||||
count: 1
|
||||
path: src/Console/ModelsCommand.php
|
||||
|
||||
-
|
||||
message: '#^Call to an undefined method Illuminate\\Support\\Optional\:\:getParameters\(\)\.$#'
|
||||
identifier: method.notFound
|
||||
count: 1
|
||||
path: src/Console/ModelsCommand.php
|
||||
|
||||
-
|
||||
message: '#^Call to an undefined method Illuminate\\Support\\Optional\:\:getReturnType\(\)\.$#'
|
||||
identifier: method.notFound
|
||||
count: 1
|
||||
path: src/Console/ModelsCommand.php
|
||||
|
||||
-
|
||||
message: '#^Call to an undefined static method Illuminate\\Database\\Eloquent\\Model\:\:newFactory\(\)\.$#'
|
||||
identifier: staticMethod.notFound
|
||||
count: 2
|
||||
path: src/Console/ModelsCommand.php
|
||||
|
||||
-
|
||||
message: '#^Call to an undefined method ReflectionFunctionAbstract\:\:getDeclaringClass\(\)\.$#'
|
||||
identifier: method.notFound
|
||||
count: 1
|
||||
path: src/Method.php
|
||||
@@ -0,0 +1,11 @@
|
||||
includes:
|
||||
- phpstan-baseline.neon
|
||||
- vendor/phpstan/phpstan-phpunit/extension.neon
|
||||
|
||||
parameters:
|
||||
level: 2
|
||||
paths:
|
||||
- src
|
||||
- resources/views
|
||||
excludePaths:
|
||||
|
||||
@@ -1,24 +0,0 @@
|
||||
<?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>
|
||||
@@ -1,16 +0,0 @@
|
||||
<?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>
|
||||
@@ -3,6 +3,7 @@
|
||||
/**
|
||||
* @var Barryvdh\LaravelIdeHelper\Alias[][] $namespaces_by_alias_ns
|
||||
* @var Barryvdh\LaravelIdeHelper\Alias[][] $namespaces_by_extends_ns
|
||||
* @var string[] $real_time_facades
|
||||
* @var bool $include_fluent
|
||||
* @var string $helpers
|
||||
*/
|
||||
@@ -29,7 +30,7 @@ $s3 = $s1 . $s2;
|
||||
<?php foreach ($namespaces_by_extends_ns as $namespace => $aliases) : ?>
|
||||
namespace <?= $namespace === '__root' ? '' : trim($namespace, '\\') ?> {
|
||||
<?php foreach ($aliases as $alias) : ?>
|
||||
<?php echo trim($alias->getDocComment($s1)) . "\n{$s1}" . $alias->getClassType() ?> <?= $alias->getExtendsClass() ?> {
|
||||
<?php echo trim($alias->getDocComment($s1)) . "\n{$s1}" . $alias->getClassType() ?> <?= $alias->getExtendsClass() ?><?php if ($alias->shouldExtendParentClass()): ?> extends <?= $alias->getParentClass() ?><?php endif; ?> {
|
||||
<?php foreach ($alias->getMethods() as $method) : ?>
|
||||
<?= trim($method->getDocComment($s2)) . "\n{$s2}" ?>public static function <?= $method->getName() ?>(<?= $method->getParamsWithDefault() ?>)
|
||||
{<?php if ($method->getDeclaringClass() !== $method->getRoot()) : ?>
|
||||
@@ -76,7 +77,7 @@ namespace <?= $namespace === '__root' ? '' : trim($namespace, '\\') ?> {
|
||||
|
||||
<?php endforeach; ?>
|
||||
|
||||
<?php foreach($real_time_facades as $name): ?>
|
||||
<?php foreach ($real_time_facades as $name): ?>
|
||||
<?php $nested = explode('\\', str_replace('\\' . class_basename($name), '', $name)); ?>
|
||||
namespace <?php echo implode('\\', $nested); ?> {
|
||||
/**
|
||||
@@ -119,12 +120,3 @@ namespace Illuminate\Support {
|
||||
}
|
||||
<?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; ?>
|
||||
|
||||
@@ -1,4 +1,16 @@
|
||||
<?= '<?php' ?>
|
||||
<?php
|
||||
/**
|
||||
* @var array $bindings
|
||||
* @var string[] $methods
|
||||
* @var string[] $configMethods
|
||||
* @var Illuminate\Support\Collection $configValues
|
||||
* @var array<string, array> $expectedArgumentSets
|
||||
* @var array $expectedArguments
|
||||
* @var string[] $userMethods
|
||||
* @var string $userModel/
|
||||
* */
|
||||
?>
|
||||
|
||||
/* @noinspection ALL */
|
||||
// @formatter:off
|
||||
@@ -21,14 +33,19 @@ namespace PHPSTORM_META {
|
||||
]));
|
||||
<?php endforeach; ?>
|
||||
|
||||
<?php if (count($factories)) : ?>
|
||||
override(\factory(0), map([
|
||||
'' => '@FactoryBuilder',
|
||||
<?php foreach ($factories as $factory) : ?>
|
||||
'<?= $factory->getName() ?>' => \<?= $factory->getName() ?>FactoryBuilder::class,
|
||||
<?php foreach ($userMethods as $method) : ?>
|
||||
override(<?= $method ?>, map([
|
||||
'' => \<?= $userModel ?>::class,
|
||||
]));
|
||||
<?php endforeach; ?>
|
||||
|
||||
<?php foreach ($configMethods as $method) : ?>
|
||||
override(<?= $method ?>, map([
|
||||
<?php foreach ($configValues as $name => $value) : ?>
|
||||
'<?= $name ?>' => '<?= $value ?>',
|
||||
<?php endforeach; ?>
|
||||
]));
|
||||
<?php endif; ?>
|
||||
<?php endforeach; ?>
|
||||
|
||||
override(\Illuminate\Foundation\Testing\Concerns\InteractsWithContainer::mock(0), map(["" => "@&\Mockery\MockInterface"]));
|
||||
override(\Illuminate\Foundation\Testing\Concerns\InteractsWithContainer::partialMock(0), map(["" => "@&\Mockery\MockInterface"]));
|
||||
@@ -65,4 +82,31 @@ namespace PHPSTORM_META {
|
||||
override(\tap(0), type(0));
|
||||
override(\optional(0), type(0));
|
||||
|
||||
<?php if ($expectedArgumentSets): ?>
|
||||
<?php foreach ($expectedArgumentSets as $name => $argumentsList) : ?>
|
||||
registerArgumentsSet('<?= $name ?>', <?php foreach ($argumentsList as $i => $arg) : ?><?php if ($i % 5 == 0) {
|
||||
echo "\n";
|
||||
} ?><?= var_export($arg, true); ?>,<?php endforeach; ?>);
|
||||
<?php endforeach; ?>
|
||||
<?php endif ?>
|
||||
|
||||
<?php if ($expectedArguments) : ?>
|
||||
<?php foreach ($expectedArguments as $arguments) : ?>
|
||||
<?php
|
||||
$classes = isset($arguments['class']) ? (array) $arguments['class'] : [null];
|
||||
$index = $arguments['index'] ?? 0;
|
||||
$argumentSet = $arguments['argumentSet'];
|
||||
$functions = [];
|
||||
foreach ($classes as $class) {
|
||||
foreach ((array) $arguments['method'] as $method) {
|
||||
$functions[] = '\\' . ($class ? ltrim($class, '\\') . '::' : '') . $method . '()';
|
||||
}
|
||||
}
|
||||
?>
|
||||
<?php foreach ($functions as $function) : ?>
|
||||
expectedArguments(<?= $function ?>, <?= $index ?>, argumentsSet('<?= $argumentSet ?>'));
|
||||
<?php endforeach; ?>
|
||||
<?php endforeach; ?>
|
||||
<?php endif; ?>
|
||||
|
||||
}
|
||||
|
||||
+114
-29
@@ -13,13 +13,16 @@ namespace Barryvdh\LaravelIdeHelper;
|
||||
|
||||
use Barryvdh\Reflection\DocBlock;
|
||||
use Barryvdh\Reflection\DocBlock\Context;
|
||||
use Barryvdh\Reflection\DocBlock\ContextFactory;
|
||||
use Barryvdh\Reflection\DocBlock\Serializer as DocBlockSerializer;
|
||||
use Barryvdh\Reflection\DocBlock\Tag\MethodTag;
|
||||
use Barryvdh\Reflection\DocBlock\Tag\TemplateTag;
|
||||
use Closure;
|
||||
use Illuminate\Config\Repository as ConfigRepository;
|
||||
use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
|
||||
use Illuminate\Database\Query\Builder as QueryBuilder;
|
||||
use Illuminate\Support\Facades\Facade;
|
||||
use Illuminate\Support\Traits\Macroable;
|
||||
use ReflectionClass;
|
||||
use Throwable;
|
||||
|
||||
@@ -34,6 +37,7 @@ class Alias
|
||||
protected $classType = 'class';
|
||||
protected $short;
|
||||
protected $namespace = '__root';
|
||||
protected $parentClass;
|
||||
protected $root = null;
|
||||
protected $classes = [];
|
||||
protected $methods = [];
|
||||
@@ -47,6 +51,9 @@ class Alias
|
||||
/** @var ConfigRepository */
|
||||
protected $config;
|
||||
|
||||
/** @var string[] */
|
||||
protected $templateNames;
|
||||
|
||||
/**
|
||||
* @param ConfigRepository $config
|
||||
* @param string $alias
|
||||
@@ -79,10 +86,11 @@ class Alias
|
||||
$this->detectNamespace();
|
||||
$this->detectClassType();
|
||||
$this->detectExtendsNamespace();
|
||||
$this->detectParentClass();
|
||||
|
||||
if (!empty($this->namespace)) {
|
||||
try {
|
||||
$this->classAliases = (new UsesResolver())->loadFromClass($this->root);
|
||||
$this->classAliases = (new ContextFactory())->createFromReflector(new ReflectionClass($this->root))->getNamespaceAliases();
|
||||
} catch (Throwable $e) {
|
||||
$this->classAliases = [];
|
||||
}
|
||||
@@ -93,7 +101,12 @@ class Alias
|
||||
}
|
||||
|
||||
if ($facade === '\Illuminate\Database\Eloquent\Model') {
|
||||
$this->usedMethods = ['decrement', 'increment'];
|
||||
$this->usedMethods = [
|
||||
'decrement' => true,
|
||||
'decrementEach' => true,
|
||||
'increment' => true,
|
||||
'incrementEach' => true,
|
||||
];
|
||||
}
|
||||
}
|
||||
|
||||
@@ -163,6 +176,25 @@ class Alias
|
||||
return $this->extendsNamespace;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the parent class of the class which this alias extends
|
||||
*
|
||||
* @return null|string
|
||||
*/
|
||||
public function getParentClass()
|
||||
{
|
||||
return $this->parentClass;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if this class should extend the parent class
|
||||
*/
|
||||
public function shouldExtendParentClass()
|
||||
{
|
||||
return $this->parentClass
|
||||
&& !is_subclass_of($this->extends, Facade::class);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the Alias by which this class is called
|
||||
*
|
||||
@@ -221,11 +253,17 @@ class Alias
|
||||
return;
|
||||
}
|
||||
|
||||
$reflection = new \ReflectionMethod($facade, 'fake');
|
||||
if ($reflection->getNumberOfRequiredParameters() > 0) {
|
||||
return;
|
||||
}
|
||||
|
||||
$real = $facade::getFacadeRoot();
|
||||
|
||||
try {
|
||||
$facade::fake();
|
||||
$fake = $facade::getFacadeRoot();
|
||||
|
||||
if ($fake !== $real) {
|
||||
$this->addClass(get_class($fake));
|
||||
}
|
||||
@@ -260,6 +298,18 @@ class Alias
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Detect the parent class
|
||||
*/
|
||||
protected function detectParentClass()
|
||||
{
|
||||
$reflection = new ReflectionClass($this->root);
|
||||
|
||||
$parentClass = $reflection->getParentClass();
|
||||
|
||||
$this->parentClass = $parentClass ? '\\' . $parentClass->getName() : null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Detect the class type
|
||||
*/
|
||||
@@ -280,9 +330,8 @@ class Alias
|
||||
/**
|
||||
* Get the real root of a facade
|
||||
*
|
||||
* @return bool|string
|
||||
*/
|
||||
protected function detectRoot()
|
||||
protected function detectRoot(): void
|
||||
{
|
||||
$facade = $this->facade;
|
||||
|
||||
@@ -337,19 +386,19 @@ class Alias
|
||||
$method = new \ReflectionMethod($className, $name);
|
||||
$class = new ReflectionClass($className);
|
||||
|
||||
if (!in_array($magic, $this->usedMethods)) {
|
||||
if (!isset($this->usedMethods[$magic])) {
|
||||
if ($class !== $this->root) {
|
||||
$this->methods[] = new Method(
|
||||
$method,
|
||||
$this->alias,
|
||||
$class,
|
||||
$magic,
|
||||
$this->interfaces,
|
||||
$this->classAliases,
|
||||
$this->getReturnTypeNormalizers($class)
|
||||
$this->getReturnTypeNormalizers($class),
|
||||
$this->getTemplateNames()
|
||||
);
|
||||
}
|
||||
$this->usedMethods[] = $magic;
|
||||
$this->usedMethods[$magic] = true;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -357,7 +406,6 @@ class Alias
|
||||
/**
|
||||
* Get the methods for one or multiple classes.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
protected function detectMethods()
|
||||
{
|
||||
@@ -367,44 +415,48 @@ class Alias
|
||||
$methods = $reflection->getMethods(\ReflectionMethod::IS_PUBLIC);
|
||||
if ($methods) {
|
||||
foreach ($methods as $method) {
|
||||
if (!in_array($method->name, $this->usedMethods)) {
|
||||
if (!isset($this->usedMethods[$method->name])) {
|
||||
// Only add the methods to the output when the root is not the same as the class.
|
||||
// And don't add the __*() methods
|
||||
if ($this->extends !== $class && substr($method->name, 0, 2) !== '__') {
|
||||
$this->methods[] = new Method(
|
||||
$method,
|
||||
$this->alias,
|
||||
$reflection,
|
||||
$method->name,
|
||||
$this->interfaces,
|
||||
$this->classAliases,
|
||||
$this->getReturnTypeNormalizers($reflection)
|
||||
$this->getReturnTypeNormalizers($reflection),
|
||||
$this->getTemplateNames(),
|
||||
);
|
||||
}
|
||||
$this->usedMethods[] = $method->name;
|
||||
$this->usedMethods[$method->name] = true;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// 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) {
|
||||
if ($class === EloquentBuilder::class || in_array(Macroable::class, $reflection->getTraitNames())) {
|
||||
$properties = $reflection->getStaticProperties();
|
||||
$macros = isset($properties['macros']) ? $properties['macros'] : [];
|
||||
foreach ($macros as $macro_name => $macro_func) {
|
||||
if (!in_array($macro_name, $this->usedMethods)) {
|
||||
if (!isset($this->usedMethods[$macro_name])) {
|
||||
try {
|
||||
$method = $this->getMacroFunction($macro_func);
|
||||
} catch (Throwable $e) {
|
||||
// Invalid method, skip
|
||||
continue;
|
||||
}
|
||||
// Add macros
|
||||
$this->methods[] = new Macro(
|
||||
$this->getMacroFunction($macro_func),
|
||||
$this->alias,
|
||||
$method,
|
||||
$reflection,
|
||||
$macro_name,
|
||||
$this->interfaces,
|
||||
$this->classAliases,
|
||||
$this->getReturnTypeNormalizers($reflection)
|
||||
);
|
||||
$this->usedMethods[] = $macro_name;
|
||||
$this->usedMethods[$macro_name] = true;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -476,30 +528,62 @@ class Alias
|
||||
/**
|
||||
* @param $prefix
|
||||
* @return string
|
||||
* @throws \ReflectionException
|
||||
*/
|
||||
public function getPhpDocTemplates($prefix = "\t\t")
|
||||
{
|
||||
$templateDoc = new DocBlock('');
|
||||
$serializer = new DocBlockSerializer(1, $prefix);
|
||||
|
||||
foreach ($this->getTemplateNames() as $templateName) {
|
||||
$template = new TemplateTag('template', $templateName);
|
||||
$template->setBound('static');
|
||||
$template->setDocBlock($templateDoc);
|
||||
$templateDoc->appendTag($template);
|
||||
}
|
||||
|
||||
return $serializer->getDocComment($templateDoc);
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string[]
|
||||
*/
|
||||
public function getTemplateNames()
|
||||
{
|
||||
if (!isset($this->templateNames)) {
|
||||
$this->detectTemplateNames();
|
||||
}
|
||||
return $this->templateNames;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return void
|
||||
* @throws \ReflectionException
|
||||
*/
|
||||
protected function detectTemplateNames()
|
||||
{
|
||||
$templateNames = [];
|
||||
foreach ($this->classes as $class) {
|
||||
$reflection = new ReflectionClass($class);
|
||||
$traits = collect($reflection->getTraitNames());
|
||||
|
||||
$phpdoc = new DocBlock($reflection);
|
||||
$templates = $phpdoc->getTagsByName('template');
|
||||
/** @var TemplateTag $template */
|
||||
foreach ($templates as $template) {
|
||||
$templateNames[] = $template->getTemplateName();
|
||||
}
|
||||
|
||||
foreach ($traits as $trait) {
|
||||
$phpdoc = new DocBlock(new ReflectionClass($trait));
|
||||
$templates = $phpdoc->getTagsByName('template');
|
||||
|
||||
/** @var DocBlock\Tag\TemplateTag $template */
|
||||
/** @var TemplateTag $template */
|
||||
foreach ($templates as $template) {
|
||||
$template->setBound('static');
|
||||
$template->setDocBlock($templateDoc);
|
||||
$templateDoc->appendTag($template);
|
||||
$templateNames[] = $template->getTemplateName();
|
||||
}
|
||||
}
|
||||
}
|
||||
return $serializer->getDocComment($templateDoc);
|
||||
$this->templateNames = $templateNames;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -510,12 +594,13 @@ class Alias
|
||||
*/
|
||||
protected function removeDuplicateMethodsFromPhpDoc()
|
||||
{
|
||||
$methodNames = array_map(function (Method $method) {
|
||||
return $method->getName();
|
||||
}, $this->getMethods());
|
||||
$methodNames = [];
|
||||
foreach ($this->getMethods() as $method) {
|
||||
$methodNames[$method->getName()] = true;
|
||||
}
|
||||
|
||||
foreach ($this->phpdoc->getTags() as $tag) {
|
||||
if ($tag instanceof MethodTag && in_array($tag->getMethodName(), $methodNames)) {
|
||||
if ($tag instanceof MethodTag && isset($methodNames[$tag->getMethodName()])) {
|
||||
$this->phpdoc->deleteTag($tag);
|
||||
}
|
||||
}
|
||||
|
||||
+201
-8
@@ -11,11 +11,13 @@
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Console;
|
||||
|
||||
use Barryvdh\LaravelIdeHelper\Factories;
|
||||
use Dotenv\Parser\Entry;
|
||||
use Dotenv\Parser\Parser;
|
||||
use Illuminate\Console\Command;
|
||||
use Illuminate\Contracts\Config\Repository;
|
||||
use Illuminate\Contracts\View\Factory;
|
||||
use Illuminate\Filesystem\Filesystem;
|
||||
use Illuminate\Support\Collection;
|
||||
use RuntimeException;
|
||||
use Symfony\Component\Console\Input\InputOption;
|
||||
use Symfony\Component\Console\Output\OutputInterface;
|
||||
@@ -64,6 +66,23 @@ class MetaCommand extends Command
|
||||
'\Psr\Container\ContainerInterface::get(0)',
|
||||
];
|
||||
|
||||
protected $configMethods = [
|
||||
'\config()',
|
||||
'\Illuminate\Config\Repository::get()',
|
||||
'\Illuminate\Support\Facades\Config::get()',
|
||||
];
|
||||
|
||||
protected $userMethods = [
|
||||
'\auth()->user()',
|
||||
'\Illuminate\Contracts\Auth\Guard::user()',
|
||||
'\Illuminate\Support\Facades\Auth::user()',
|
||||
'\request()->user()',
|
||||
'\Illuminate\Http\Request::user()',
|
||||
'\Illuminate\Support\Facades\Request::user()',
|
||||
];
|
||||
|
||||
protected $templateCache = [];
|
||||
|
||||
/**
|
||||
*
|
||||
* @param Filesystem $files
|
||||
@@ -88,9 +107,6 @@ class MetaCommand extends Command
|
||||
*/
|
||||
public function handle()
|
||||
{
|
||||
// Needs to run before exception handler is registered
|
||||
$factories = $this->config->get('ide-helper.include_factory_builders') ? Factories::all() : [];
|
||||
|
||||
$ourAutoloader = $this->registerClassAutoloadExceptions();
|
||||
|
||||
$bindings = [];
|
||||
@@ -108,7 +124,7 @@ class MetaCommand extends Command
|
||||
}
|
||||
|
||||
$reflectionClass = new \ReflectionClass($concrete);
|
||||
if (is_object($concrete) && !$reflectionClass->isAnonymous()) {
|
||||
if (is_object($concrete) && !$reflectionClass->isAnonymous() && $abstract !== get_class($concrete)) {
|
||||
$bindings[$abstract] = get_class($concrete);
|
||||
}
|
||||
} catch (\Throwable $e) {
|
||||
@@ -120,10 +136,21 @@ class MetaCommand extends Command
|
||||
|
||||
$this->unregisterClassAutoloadExceptions($ourAutoloader);
|
||||
|
||||
$content = $this->view->make('meta', [
|
||||
$configValues = $this->loadTemplate('configs')->pluck('value', 'name')->map(function ($value, $key) {
|
||||
return gettype($value);
|
||||
});
|
||||
|
||||
$defaultUserModel = $this->config->get('auth.providers.users.model', $this->config->get('auth.model', 'App\User'));
|
||||
|
||||
$content = $this->view->make('ide-helper::meta', [
|
||||
'bindings' => $bindings,
|
||||
'methods' => $this->methods,
|
||||
'factories' => $factories,
|
||||
'configMethods' => $this->configMethods,
|
||||
'configValues' => $configValues,
|
||||
'expectedArgumentSets' => $this->getExpectedArgumentSets(),
|
||||
'expectedArguments' => $this->getExpectedArguments(),
|
||||
'userModel' => $defaultUserModel,
|
||||
'userMethods' => $this->userMethods,
|
||||
])->render();
|
||||
|
||||
$filename = $this->option('filename');
|
||||
@@ -160,13 +187,164 @@ class MetaCommand extends Command
|
||||
*/
|
||||
protected function registerClassAutoloadExceptions(): callable
|
||||
{
|
||||
$autoloader = function ($class) {
|
||||
$aliases = array_filter([...$this->getAbstracts(), 'config'], fn ($abstract) => !str_contains($abstract, '\\'));
|
||||
|
||||
$autoloader = function ($class) use ($aliases) {
|
||||
// ignore aliases as they're meant to be resolved elsewhere
|
||||
if (in_array($class, $aliases, true)) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Don't throw when class existence is being checked via class_exists(),
|
||||
// interface_exists(), trait_exists(), or enum_exists(). These functions
|
||||
// expect the autoloader to return gracefully when the class doesn't exist.
|
||||
// Throwing here would break libraries that use class_exists() to check for
|
||||
// optional dependencies (e.g. Doctrine ORM checking for removed classes).
|
||||
$existsFunctions = ['class_exists', 'interface_exists', 'trait_exists', 'enum_exists'];
|
||||
foreach (debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 3) as $frame) {
|
||||
if (isset($frame['function']) && in_array($frame['function'], $existsFunctions, true)) {
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
throw new \ReflectionException("Class '$class' not found.");
|
||||
};
|
||||
|
||||
spl_autoload_register($autoloader);
|
||||
|
||||
return $autoloader;
|
||||
}
|
||||
|
||||
protected function getExpectedArgumentSets()
|
||||
{
|
||||
return [
|
||||
'auth' => $this->loadTemplate('auth')->keys()->filter()->toArray(),
|
||||
'configs' => $this->loadTemplate('configs')->pluck('name')->filter()->toArray(),
|
||||
'middleware' => $this->loadTemplate('middleware')->keys()->filter()->toArray(),
|
||||
'routes' => $this->loadTemplate('routes')->pluck('name')->filter()->toArray(),
|
||||
'views' => $this->loadTemplate('views')->pluck('key')->filter()->map(function ($value) {
|
||||
return (string) $value;
|
||||
})->toArray(),
|
||||
'translations' => $this->loadTemplate('translations')->filter()->keys()->toArray(),
|
||||
'env' => $this->getEnv(),
|
||||
];
|
||||
}
|
||||
|
||||
protected function getExpectedArguments()
|
||||
{
|
||||
return [
|
||||
[
|
||||
'class' => '\Illuminate\Support\Facades\Gate',
|
||||
'method' => [
|
||||
'has',
|
||||
'allows',
|
||||
'denies',
|
||||
'check',
|
||||
'any',
|
||||
'none',
|
||||
'authorize',
|
||||
'inspect',
|
||||
],
|
||||
'argumentSet' => 'auth',
|
||||
],
|
||||
[
|
||||
'class' => ['\Illuminate\Support\Facades\Route', '\Illuminate\Support\Facades\Auth', 'Illuminate\Foundation\Auth\Access\Authorizable'],
|
||||
'method' => ['can', 'cannot', 'cant'],
|
||||
'argumentSet' => 'auth',
|
||||
],
|
||||
[
|
||||
'class' => ['Illuminate\Contracts\Auth\Access\Authorizable'],
|
||||
'method' => ['can'],
|
||||
'argumentSet' => 'auth',
|
||||
],
|
||||
[
|
||||
'class' => ['\Illuminate\Config\Repository', '\Illuminate\Support\Facades\Config'],
|
||||
'method' => [
|
||||
// 'get', // config() and Config::Get() are added with return type hints already
|
||||
'getMany',
|
||||
'set',
|
||||
'string',
|
||||
'integer',
|
||||
'boolean',
|
||||
'float',
|
||||
'array',
|
||||
'prepend',
|
||||
'push',
|
||||
],
|
||||
'argumentSet' => 'configs',
|
||||
],
|
||||
[
|
||||
'class' => ['\Illuminate\Support\Facades\Route', '\Illuminate\Routing\Router'],
|
||||
'method' => ['middleware', 'withoutMiddleware'],
|
||||
'argumentSet' => 'middleware',
|
||||
],
|
||||
[
|
||||
'method' => ['route', 'to_route', 'signedRoute'],
|
||||
'argumentSet' => 'routes',
|
||||
],
|
||||
[
|
||||
'class' => [
|
||||
'\Illuminate\Support\Facades\Redirect',
|
||||
'\Illuminate\Support\Facades\URL',
|
||||
'\Illuminate\Routing\Redirector',
|
||||
'\Illuminate\Routing\UrlGenerator',
|
||||
],
|
||||
'method' => ['route', 'signedRoute', 'temporarySignedRoute'],
|
||||
'argumentSet' => 'routes',
|
||||
],
|
||||
[
|
||||
'method' => 'view',
|
||||
'argumentSet' => 'views',
|
||||
],
|
||||
[
|
||||
'class' => ['\Illuminate\Support\Facades\View', '\Illuminate\View\Factory'],
|
||||
'method' => 'make',
|
||||
'argumentSet' => 'views',
|
||||
],
|
||||
[
|
||||
'method' => ['__', 'trans'],
|
||||
'argumentSet' => 'translations',
|
||||
],
|
||||
[
|
||||
'class' => ['\Illuminate\Contracts\Translation\Translator'],
|
||||
'method' => ['get'],
|
||||
'argumentSet' => 'translations',
|
||||
],
|
||||
[
|
||||
'method' => 'env',
|
||||
'argumentSet' => 'env',
|
||||
],
|
||||
[
|
||||
'class' => '\Illuminate\Support\Env',
|
||||
'method' => 'get',
|
||||
'argumentSet' => 'env',
|
||||
],
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* @return Collection
|
||||
*/
|
||||
protected function loadTemplate($name)
|
||||
{
|
||||
if (!isset($this->templateCache[$name])) {
|
||||
$file = __DIR__ . '/../../php-templates/' . basename($name) . '.php';
|
||||
try {
|
||||
$value = $this->files->requireOnce($file) ?: [];
|
||||
} catch (\Throwable $e) {
|
||||
$value = [];
|
||||
$this->warn('Cannot load template for ' . $name . ': ' . $e->getMessage());
|
||||
}
|
||||
|
||||
if (!$value instanceof Collection) {
|
||||
$value = collect($value);
|
||||
}
|
||||
$this->templateCache[$name] = $value;
|
||||
}
|
||||
|
||||
return $this->templateCache[$name];
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the console command options.
|
||||
*
|
||||
@@ -181,6 +359,21 @@ class MetaCommand extends Command
|
||||
];
|
||||
}
|
||||
|
||||
protected function getEnv()
|
||||
{
|
||||
$envPath = base_path('.env');
|
||||
if (!file_exists($envPath)) {
|
||||
return [];
|
||||
}
|
||||
|
||||
$parser = new Parser();
|
||||
$entries = $parser->parse(file_get_contents($envPath));
|
||||
|
||||
return collect($entries)->map(function (Entry $entry) {
|
||||
return $entry->getName();
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove our custom autoloader that we pushed onto the autoload stack
|
||||
*
|
||||
|
||||
+230
-47
@@ -16,6 +16,7 @@ use Barryvdh\LaravelIdeHelper\Generator;
|
||||
use Barryvdh\LaravelIdeHelper\Parsers\PhpDocReturnTypeParser;
|
||||
use Barryvdh\Reflection\DocBlock;
|
||||
use Barryvdh\Reflection\DocBlock\Context;
|
||||
use Barryvdh\Reflection\DocBlock\ContextFactory;
|
||||
use Barryvdh\Reflection\DocBlock\Serializer as DocBlockSerializer;
|
||||
use Barryvdh\Reflection\DocBlock\Tag;
|
||||
use Composer\ClassMapGenerator\ClassMapGenerator;
|
||||
@@ -43,13 +44,13 @@ use Illuminate\Database\Eloquent\Relations\MorphTo;
|
||||
use Illuminate\Database\Eloquent\Relations\MorphToMany;
|
||||
use Illuminate\Database\Eloquent\Relations\Pivot;
|
||||
use Illuminate\Database\Eloquent\Relations\Relation;
|
||||
use Illuminate\Database\Eloquent\SoftDeletingScope;
|
||||
use Illuminate\Database\Schema\Builder;
|
||||
use Illuminate\Filesystem\Filesystem;
|
||||
use Illuminate\Support\Arr;
|
||||
use Illuminate\Support\Collection;
|
||||
use Illuminate\Support\Str;
|
||||
use Illuminate\View\Factory as ViewFactory;
|
||||
use phpDocumentor\Reflection\Types\ContextFactory;
|
||||
use ReflectionClass;
|
||||
use ReflectionNamedType;
|
||||
use ReflectionObject;
|
||||
@@ -114,6 +115,7 @@ class ModelsCommand extends Command
|
||||
|
||||
protected $write_model_magic_where;
|
||||
protected $write_model_relation_count_properties;
|
||||
protected $write_model_relation_exists_properties;
|
||||
protected $properties = [];
|
||||
protected $methods = [];
|
||||
protected $write = false;
|
||||
@@ -122,6 +124,14 @@ class ModelsCommand extends Command
|
||||
protected $reset;
|
||||
protected $phpstorm_noinspections;
|
||||
protected $write_model_external_builder_methods;
|
||||
/**
|
||||
* @var array<string, \SplFileObject>
|
||||
*/
|
||||
protected $fileCache = [];
|
||||
/**
|
||||
* @var array<string, Context>
|
||||
*/
|
||||
protected $contextCache = [];
|
||||
/**
|
||||
* @var array<string, true>
|
||||
*/
|
||||
@@ -173,6 +183,8 @@ class ModelsCommand extends Command
|
||||
$this->write_model_external_builder_methods = $this->laravel['config']->get('ide-helper.write_model_external_builder_methods', true);
|
||||
$this->write_model_relation_count_properties =
|
||||
$this->laravel['config']->get('ide-helper.write_model_relation_count_properties', true);
|
||||
$this->write_model_relation_exists_properties =
|
||||
$this->laravel['config']->get('ide-helper.write_model_relation_exists_properties', false);
|
||||
|
||||
$this->write = $this->write_mixin ? true : $this->write;
|
||||
//If filename is default and Write is not specified, ask what to do
|
||||
@@ -410,9 +422,6 @@ class ModelsCommand extends Command
|
||||
$params = [];
|
||||
|
||||
switch ($type) {
|
||||
case 'encrypted':
|
||||
$realType = 'mixed';
|
||||
break;
|
||||
case 'boolean':
|
||||
case 'bool':
|
||||
$realType = 'bool';
|
||||
@@ -420,6 +429,7 @@ class ModelsCommand extends Command
|
||||
case 'decimal':
|
||||
$realType = 'numeric';
|
||||
break;
|
||||
case 'encrypted':
|
||||
case 'string':
|
||||
case 'hashed':
|
||||
$realType = 'string';
|
||||
@@ -453,7 +463,7 @@ class ModelsCommand extends Command
|
||||
$realType = '\Illuminate\Support\Collection<array-key, mixed>';
|
||||
break;
|
||||
case AsArrayObject::class:
|
||||
$realType = '\ArrayObject<array-key, mixed>';
|
||||
$realType = '\Illuminate\Database\Eloquent\Casts\ArrayObject<array-key, mixed>';
|
||||
break;
|
||||
default:
|
||||
// In case of an optional custom cast parameter , only evaluate
|
||||
@@ -475,7 +485,11 @@ class ModelsCommand extends Command
|
||||
}
|
||||
|
||||
if (Str::startsWith($type, AsCollection::class)) {
|
||||
$realType = $this->getTypeInModel($model, $params[0] ?? null) ?? '\Illuminate\Support\Collection';
|
||||
$realType = $this->getTypeInModel($model, $params[0] ?? null) ?: '\Illuminate\Support\Collection';
|
||||
$relatedModel = $this->getTypeInModel($model, $params[1] ?? null);
|
||||
if ($relatedModel) {
|
||||
$realType = $this->getCollectionTypeHint($realType, $relatedModel);
|
||||
}
|
||||
}
|
||||
|
||||
if (Str::startsWith($type, AsEnumCollection::class)) {
|
||||
@@ -521,7 +535,7 @@ class ModelsCommand extends Command
|
||||
}
|
||||
|
||||
if ($isNullable) {
|
||||
$type .= '|null';
|
||||
$type = $this->wrapIntersectionType($type) . '|null';
|
||||
} else {
|
||||
$type = str_replace($nullString, '', $type);
|
||||
}
|
||||
@@ -529,6 +543,22 @@ class ModelsCommand extends Command
|
||||
return $type;
|
||||
}
|
||||
|
||||
/**
|
||||
* Wraps a bare intersection type in parentheses for correct DNF syntax.
|
||||
*
|
||||
* For example, `A&B` becomes `(A&B)` so that adding `|null` produces
|
||||
* `(A&B)|null` instead of the ambiguous `A&B|null`.
|
||||
* Types that are already parenthesized or contain union types are returned as-is.
|
||||
*/
|
||||
protected function wrapIntersectionType(string $type): string
|
||||
{
|
||||
if (str_contains($type, '&') && !str_contains($type, '|') && $type[0] !== '(') {
|
||||
return '(' . $type . ')';
|
||||
}
|
||||
|
||||
return $type;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the override type for the give type.
|
||||
*
|
||||
@@ -579,6 +609,8 @@ class ModelsCommand extends Command
|
||||
'float', 'real', 'float4',
|
||||
'double', 'float8' => 'float',
|
||||
|
||||
'decimal', 'numeric' => 'numeric',
|
||||
|
||||
default => 'string',
|
||||
};
|
||||
}
|
||||
@@ -628,6 +660,10 @@ class ModelsCommand extends Command
|
||||
)
|
||||
);
|
||||
});
|
||||
// https://github.com/barryvdh/laravel-ide-helper/issues/1664
|
||||
$reflections = array_filter($reflections, function (\ReflectionMethod $methodReflection) {
|
||||
return !($methodReflection->getName() === 'getUseFactoryAttribute');
|
||||
});
|
||||
sort($reflections);
|
||||
foreach ($reflections as $reflection) {
|
||||
$type = $this->getReturnTypeFromReflection($reflection);
|
||||
@@ -665,9 +701,11 @@ class ModelsCommand extends Command
|
||||
$comment = $this->getCommentFromDocBlock($reflection);
|
||||
$this->setProperty($name, null, null, true, $comment);
|
||||
}
|
||||
} elseif (Str::startsWith($method, 'scope') && $method !== 'scopeQuery' && $method !== 'scope' && $method !== 'scopes') {
|
||||
} elseif (!empty($reflection->getAttributes('Illuminate\Database\Eloquent\Attributes\Scope')) || (Str::startsWith($method, 'scope') && $method !== 'scopeQuery' && $method !== 'scope' && $method !== 'scopes')) {
|
||||
$scopeUsingAttribute = !empty($reflection->getAttributes('Illuminate\Database\Eloquent\Attributes\Scope'));
|
||||
|
||||
//Magic scope<name>Attribute
|
||||
$name = Str::camel(substr($method, 5));
|
||||
$name = $scopeUsingAttribute ? $method : Str::camel(substr($method, 5));
|
||||
if (!empty($name)) {
|
||||
$comment = $this->getCommentFromDocBlock($reflection);
|
||||
$args = $this->getParameters($reflection);
|
||||
@@ -683,13 +721,16 @@ class ModelsCommand extends Command
|
||||
);
|
||||
$this->setMethod($name, $builder . '<static>|' . $modelName, $args, $comment);
|
||||
}
|
||||
} elseif (in_array($method, ['query', 'newQuery', 'newModelQuery'])) {
|
||||
} elseif (in_array($method, ['query', 'newQuery', 'newModelQuery'])
|
||||
) {
|
||||
if ($this->laravel['config']->get('ide-helper.write_query_methods', true)) {
|
||||
$builder = $this->getClassNameInDestinationFile($model, get_class($model->newModelQuery()));
|
||||
|
||||
$this->setMethod(
|
||||
$method,
|
||||
$builder . '<static>|' . $this->getClassNameInDestinationFile($model, get_class($model))
|
||||
);
|
||||
}
|
||||
|
||||
if ($this->write_model_external_builder_methods) {
|
||||
$this->writeModelExternalBuilderMethods($model);
|
||||
@@ -708,14 +749,19 @@ class ModelsCommand extends Command
|
||||
$type = (string)$this->getReturnTypeFromDocBlock($reflection);
|
||||
}
|
||||
|
||||
$file = new \SplFileObject($reflection->getFileName());
|
||||
$fileName = $reflection->getFileName();
|
||||
if (!isset($this->fileCache[$fileName])) {
|
||||
$this->fileCache[$fileName] = new \SplFileObject($fileName);
|
||||
}
|
||||
$file = $this->fileCache[$fileName];
|
||||
$file->seek($reflection->getStartLine() - 1);
|
||||
|
||||
$code = '';
|
||||
$lines = [];
|
||||
while ($file->key() < $reflection->getEndLine()) {
|
||||
$code .= $file->current();
|
||||
$lines[] = $file->current();
|
||||
$file->next();
|
||||
}
|
||||
$code = implode('', $lines);
|
||||
$code = trim(preg_replace('/\s\s+/', '', $code));
|
||||
$begin = strpos($code, 'function(');
|
||||
$code = substr($code, $begin, strrpos($code, '}') - $begin + 1);
|
||||
@@ -812,6 +858,15 @@ class ModelsCommand extends Command
|
||||
// What kind of comments should be added to the relation count here?
|
||||
);
|
||||
}
|
||||
if ($this->write_model_relation_exists_properties) {
|
||||
$this->setProperty(
|
||||
Str::snake($method) . '_exists',
|
||||
'bool|null',
|
||||
true,
|
||||
false
|
||||
// What kind of comments should be added to the relation count here?
|
||||
);
|
||||
}
|
||||
} elseif (
|
||||
$relationReturnType === 'morphTo' ||
|
||||
(
|
||||
@@ -819,10 +874,16 @@ class ModelsCommand extends Command
|
||||
$relation === 'morphTo'
|
||||
)
|
||||
) {
|
||||
$matches = [];
|
||||
$returnType = $this->getReturnTypeFromDocBlock($reflection);
|
||||
if ($returnType !== null) {
|
||||
preg_match('/MorphTo<(?:contravariant\s+)?(.+?)(?:,|>)/i', $returnType, $matches);
|
||||
}
|
||||
|
||||
// Model isn't specified because relation is polymorphic
|
||||
$this->setProperty(
|
||||
$method,
|
||||
$this->getClassNameInDestinationFile($model, Model::class) . '|\Eloquent',
|
||||
$matches[1] ?? $this->getClassNameInDestinationFile($model, Model::class) . '|\Eloquent',
|
||||
true,
|
||||
null,
|
||||
$comment,
|
||||
@@ -861,7 +922,6 @@ class ModelsCommand extends Command
|
||||
|
||||
if (in_array($relation, ['hasOne', 'hasOneThrough', 'morphOne'], true)) {
|
||||
$defaultProp = $reflectionObj->getProperty('withDefault');
|
||||
$defaultProp->setAccessible(true);
|
||||
|
||||
return !$defaultProp->getValue($relationObj);
|
||||
}
|
||||
@@ -871,7 +931,6 @@ class ModelsCommand extends Command
|
||||
}
|
||||
|
||||
$fkProp = $reflectionObj->getProperty('foreignKey');
|
||||
$fkProp->setAccessible(true);
|
||||
|
||||
$enforceNullableRelation = $this->laravel['config']->get('ide-helper.enforce_nullable_relationships', true);
|
||||
|
||||
@@ -885,9 +944,73 @@ class ModelsCommand extends Command
|
||||
}
|
||||
}
|
||||
|
||||
if (
|
||||
$this->relatedModelUsesSoftDeletes($relationObj)
|
||||
&& !$this->relationIncludesNonTrashedParents($relationObj)
|
||||
) {
|
||||
return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check whether the relation explicitly opts into returning non-soft-deleted parents
|
||||
* via ->withTrashed(), in which case the SoftDeletes-based nullability no longer applies.
|
||||
*
|
||||
* Returns false for ->onlyTrashed() and ->withoutTrashed(), which still leave the
|
||||
* relation potentially empty depending on the parent's soft-delete state.
|
||||
*
|
||||
* @param Relation $relationObj
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
protected function relationIncludesNonTrashedParents(Relation $relationObj): bool
|
||||
{
|
||||
$query = $relationObj->getQuery();
|
||||
|
||||
if (!in_array(SoftDeletingScope::class, $query->removedScopes(), true)) {
|
||||
return false;
|
||||
}
|
||||
|
||||
$relatedModel = $relationObj->getRelated();
|
||||
|
||||
if (!method_exists($relatedModel, 'getQualifiedDeletedAtColumn')) {
|
||||
return true;
|
||||
}
|
||||
|
||||
$deletedAtColumn = $relatedModel->getQualifiedDeletedAtColumn();
|
||||
|
||||
foreach ($query->getQuery()->wheres ?? [] as $where) {
|
||||
if (
|
||||
($where['column'] ?? null) === $deletedAtColumn
|
||||
&& in_array($where['type'] ?? null, ['Null', 'NotNull'], true)
|
||||
) {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if the related model uses the SoftDeletes trait
|
||||
*
|
||||
* @param Relation $relationObj
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
protected function relatedModelUsesSoftDeletes(Relation $relationObj): bool
|
||||
{
|
||||
if (!$this->laravel['config']->get('ide-helper.soft_deletes_force_nullable', true)) {
|
||||
return false;
|
||||
}
|
||||
|
||||
$relatedModel = $relationObj->getRelated();
|
||||
|
||||
return in_array('Illuminate\\Database\\Eloquent\\SoftDeletes', class_uses_recursive($relatedModel));
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if the morphTo relation is nullable
|
||||
*
|
||||
@@ -904,7 +1027,6 @@ class ModelsCommand extends Command
|
||||
}
|
||||
|
||||
$fkProp = $reflectionObj->getProperty('foreignKey');
|
||||
$fkProp->setAccessible(true);
|
||||
|
||||
foreach (Arr::wrap($fkProp->getValue($relationObj)) as $foreignKey) {
|
||||
if (isset($this->nullableColumns[$foreignKey])) {
|
||||
@@ -935,7 +1057,7 @@ class ModelsCommand extends Command
|
||||
if ($type !== null) {
|
||||
$newType = $this->getTypeOverride($type);
|
||||
if ($nullable) {
|
||||
$newType .= '|null';
|
||||
$newType = $this->wrapIntersectionType($newType) . '|null';
|
||||
}
|
||||
$this->properties[$name]['type'] = $newType;
|
||||
}
|
||||
@@ -1086,6 +1208,7 @@ class ModelsCommand extends Command
|
||||
|
||||
$serializer = new DocBlockSerializer();
|
||||
$docComment = $serializer->getDocComment($phpdoc);
|
||||
$mixinClassName = null;
|
||||
|
||||
if ($this->write_mixin) {
|
||||
$phpdocMixin = new DocBlock($reflection, new Context($namespace));
|
||||
@@ -1122,6 +1245,14 @@ class ModelsCommand extends Command
|
||||
$replace = "{$modelDocComment}\n";
|
||||
$pos = strpos($contents, "final class {$classname}") ?: strpos($contents, "class {$classname}");
|
||||
if ($pos !== false) {
|
||||
// If PHP 8 attributes (e.g. #[ObservedBy(...)]) precede the class
|
||||
// declaration, insert the docblock before the first attribute so that
|
||||
// the resulting order is: docblock → attributes → class.
|
||||
$before = substr($contents, 0, $pos);
|
||||
if (preg_match('/((?:#\[.+?\]\s*)+)$/s', $before, $matches)) {
|
||||
$pos -= strlen($matches[1]);
|
||||
$replace = "{$modelDocComment}\n";
|
||||
}
|
||||
$contents = substr_replace($contents, $replace, $pos, 0);
|
||||
}
|
||||
}
|
||||
@@ -1174,7 +1305,7 @@ class ModelsCommand extends Command
|
||||
$default = '[]';
|
||||
} elseif (is_null($default)) {
|
||||
$default = 'null';
|
||||
} elseif (is_int($default)) {
|
||||
} elseif (is_int($default) || is_float($default)) {
|
||||
//$default = $default;
|
||||
} elseif ($default instanceof \UnitEnum) {
|
||||
$default = '\\' . get_class($default) . '::' . $default->name;
|
||||
@@ -1227,13 +1358,18 @@ class ModelsCommand extends Command
|
||||
}
|
||||
}
|
||||
|
||||
protected ?array $cachedRelationTypes = null;
|
||||
protected ?array $cachedRelationReturnTypes = null;
|
||||
|
||||
/**
|
||||
* Returns the available relation types
|
||||
*/
|
||||
protected function getRelationTypes(): array
|
||||
{
|
||||
$configuredRelations = $this->laravel['config']->get('ide-helper.additional_relation_types', []);
|
||||
return array_merge(self::RELATION_TYPES, $configuredRelations);
|
||||
return $this->cachedRelationTypes ??= array_merge(
|
||||
self::RELATION_TYPES,
|
||||
$this->laravel['config']->get('ide-helper.additional_relation_types', [])
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -1241,7 +1377,7 @@ class ModelsCommand extends Command
|
||||
*/
|
||||
protected function getRelationReturnTypes(): array
|
||||
{
|
||||
return $this->laravel['config']->get('ide-helper.additional_relation_return_types', []);
|
||||
return $this->cachedRelationReturnTypes ??= $this->laravel['config']->get('ide-helper.additional_relation_return_types', []);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -1257,9 +1393,6 @@ class ModelsCommand extends Command
|
||||
*/
|
||||
protected function getAttributeTypes(Model $model, \ReflectionMethod $reflectionMethod): Collection
|
||||
{
|
||||
// Private/protected ReflectionMethods require setAccessible prior to PHP 8.1
|
||||
$reflectionMethod->setAccessible(true);
|
||||
|
||||
/** @var Attribute $attribute */
|
||||
$attribute = $reflectionMethod->invoke($model);
|
||||
|
||||
@@ -1319,11 +1452,7 @@ class ModelsCommand extends Command
|
||||
*/
|
||||
protected function getCommentFromDocBlock(\ReflectionMethod $reflection)
|
||||
{
|
||||
$phpDocContext = (new ContextFactory())->createFromReflector($reflection);
|
||||
$context = new Context(
|
||||
$phpDocContext->getNamespace(),
|
||||
$phpDocContext->getNamespaceAliases()
|
||||
);
|
||||
$context = $this->getDocBlockContext($reflection);
|
||||
$comment = '';
|
||||
$phpdoc = new DocBlock($reflection, $context);
|
||||
|
||||
@@ -1344,11 +1473,7 @@ class ModelsCommand extends Command
|
||||
*/
|
||||
protected function getReturnTypeFromDocBlock(\ReflectionMethod $reflection, ?\Reflector $reflectorForContext = null)
|
||||
{
|
||||
$phpDocContext = (new ContextFactory())->createFromReflector($reflectorForContext ?? $reflection);
|
||||
$context = new Context(
|
||||
$phpDocContext->getNamespace(),
|
||||
$phpDocContext->getNamespaceAliases()
|
||||
);
|
||||
$context = $this->getDocBlockContext($reflectorForContext ?? $reflection);
|
||||
$type = null;
|
||||
$phpdoc = new DocBlock($reflection, $context);
|
||||
|
||||
@@ -1366,6 +1491,31 @@ class ModelsCommand extends Command
|
||||
return $type;
|
||||
}
|
||||
|
||||
protected function getDocBlockContext(\Reflector $reflector): Context
|
||||
{
|
||||
if ($reflector instanceof \ReflectionMethod) {
|
||||
$key = $reflector->getDeclaringClass()->getName();
|
||||
} elseif ($reflector instanceof ReflectionClass) {
|
||||
$key = $reflector->getName();
|
||||
} else {
|
||||
$phpDocContext = (new ContextFactory())->createFromReflector($reflector);
|
||||
return new Context(
|
||||
$phpDocContext->getNamespace(),
|
||||
$phpDocContext->getNamespaceAliases()
|
||||
);
|
||||
}
|
||||
|
||||
if (!isset($this->contextCache[$key])) {
|
||||
$phpDocContext = (new ContextFactory())->createFromReflector($reflector);
|
||||
$this->contextCache[$key] = new Context(
|
||||
$phpDocContext->getNamespace(),
|
||||
$phpDocContext->getNamespaceAliases()
|
||||
);
|
||||
}
|
||||
|
||||
return $this->contextCache[$key];
|
||||
}
|
||||
|
||||
protected function getReturnTypeFromReflection(\ReflectionMethod $reflection): ?string
|
||||
{
|
||||
$returnType = $reflection->getReturnType();
|
||||
@@ -1395,7 +1545,7 @@ class ModelsCommand extends Command
|
||||
if (in_array('Illuminate\\Database\\Eloquent\\SoftDeletes', $traits)) {
|
||||
$modelName = $this->getClassNameInDestinationFile($model, get_class($model));
|
||||
$builder = $this->getClassNameInDestinationFile($model, \Illuminate\Database\Eloquent\Builder::class);
|
||||
$this->setMethod('withTrashed', $builder . '<static>|' . $modelName, []);
|
||||
$this->setMethod('withTrashed', $builder . '<static>|' . $modelName, ['bool $withTrashed = true']);
|
||||
$this->setMethod('withoutTrashed', $builder . '<static>|' . $modelName, []);
|
||||
$this->setMethod('onlyTrashed', $builder . '<static>|' . $modelName, []);
|
||||
}
|
||||
@@ -1571,7 +1721,10 @@ class ModelsCommand extends Command
|
||||
*/
|
||||
protected function getUsedClassNames(ReflectionClass $reflection): array
|
||||
{
|
||||
$namespaceAliases = array_flip((new ContextFactory())->createFromReflector($reflection)->getNamespaceAliases());
|
||||
$context = $this->getDocBlockContext($reflection);
|
||||
$namespaceAliases = array_flip(array_map(function ($alias) {
|
||||
return ltrim($alias, '\\');
|
||||
}, $context->getNamespaceAliases()));
|
||||
$namespaceAliases[$reflection->getName()] = $reflection->getShortName();
|
||||
|
||||
return $namespaceAliases;
|
||||
@@ -1615,7 +1768,8 @@ class ModelsCommand extends Command
|
||||
$type = implode('|', $types);
|
||||
|
||||
if ($paramType->allowsNull()) {
|
||||
if (count($types) == 1) {
|
||||
// Use ?Type syntax only for single named types, not for intersection types
|
||||
if (count($types) == 1 && !str_starts_with($type, '(')) {
|
||||
$type = '?' . $type;
|
||||
} else {
|
||||
$type .= '|null';
|
||||
@@ -1633,7 +1787,7 @@ class ModelsCommand extends Command
|
||||
|
||||
preg_match(
|
||||
'/@param ((?:(?:[\w?|\\\\<>])+(?:\[])?)+)/',
|
||||
$docComment ?? '',
|
||||
$docComment,
|
||||
$matches
|
||||
);
|
||||
$type = $matches[1] ?? '';
|
||||
@@ -1688,24 +1842,53 @@ class ModelsCommand extends Command
|
||||
return $type;
|
||||
}
|
||||
|
||||
protected function extractReflectionTypes(ReflectionType $reflection_type)
|
||||
protected function extractReflectionTypes(ReflectionType $reflection_type): array
|
||||
{
|
||||
if ($reflection_type instanceof ReflectionNamedType) {
|
||||
$types[] = $this->getReflectionNamedType($reflection_type);
|
||||
} else {
|
||||
$types = [];
|
||||
foreach ($reflection_type->getTypes() as $named_type) {
|
||||
if ($named_type->getName() === 'null') {
|
||||
continue;
|
||||
return [$this->getReflectionNamedType($reflection_type)];
|
||||
}
|
||||
|
||||
$types[] = $this->getReflectionNamedType($named_type);
|
||||
if ($reflection_type instanceof \ReflectionIntersectionType) {
|
||||
return [$this->formatIntersectionType($reflection_type)];
|
||||
}
|
||||
|
||||
if ($reflection_type instanceof \ReflectionUnionType) {
|
||||
return $this->extractUnionTypes($reflection_type);
|
||||
}
|
||||
|
||||
// Unknown type - return empty array as fallback
|
||||
return [];
|
||||
}
|
||||
|
||||
protected function extractUnionTypes(\ReflectionUnionType $union_type): array
|
||||
{
|
||||
$types = [];
|
||||
|
||||
foreach ($union_type->getTypes() as $inner_type) {
|
||||
if ($inner_type instanceof ReflectionNamedType) {
|
||||
if ($inner_type->getName() === 'null') {
|
||||
continue;
|
||||
}
|
||||
$types[] = $this->getReflectionNamedType($inner_type);
|
||||
} elseif ($inner_type instanceof \ReflectionIntersectionType) {
|
||||
$types[] = $this->formatIntersectionType($inner_type);
|
||||
}
|
||||
// ReflectionUnionType cannot be nested per PHP's DNF rules
|
||||
}
|
||||
|
||||
return $types;
|
||||
}
|
||||
|
||||
protected function formatIntersectionType(\ReflectionIntersectionType $intersection_type): string
|
||||
{
|
||||
$parts = [];
|
||||
foreach ($intersection_type->getTypes() as $type) {
|
||||
$parts[] = $this->getReflectionNamedType($type);
|
||||
}
|
||||
|
||||
return '(' . implode('&', $parts) . ')';
|
||||
}
|
||||
|
||||
protected function getReflectionNamedType(ReflectionNamedType $paramType): string
|
||||
{
|
||||
$parameterName = $paramType->getName();
|
||||
|
||||
@@ -1,36 +0,0 @@
|
||||
<?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');
|
||||
}
|
||||
}
|
||||
+41
-31
@@ -17,10 +17,6 @@ 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;
|
||||
|
||||
@@ -61,9 +57,13 @@ 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', []));
|
||||
Macro::setDefaultReturnTypes($this->config->get('ide-helper.macro_default_return_types', [
|
||||
\Illuminate\Http\Client\Factory::class => \Illuminate\Http\Client\PendingRequest::class,
|
||||
]));
|
||||
|
||||
// Make all interface classes absolute
|
||||
foreach ($this->interfaces as &$interface) {
|
||||
$interface = '\\' . ltrim($interface, '\\');
|
||||
@@ -74,18 +74,17 @@ class Generator
|
||||
/**
|
||||
* Generate the helper file contents;
|
||||
*
|
||||
* @return string;
|
||||
* @return string
|
||||
*/
|
||||
public function generate()
|
||||
{
|
||||
$app = app();
|
||||
return $this->view->make('helper')
|
||||
return $this->view->make('ide-helper::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('helpers', $this->detectHelpers())
|
||||
->with('include_fluent', $this->config->get('ide-helper.include_fluent', true))
|
||||
->with('factories', $this->config->get('ide-helper.include_factory_builders') ? Factories::all() : [])
|
||||
->render();
|
||||
}
|
||||
|
||||
@@ -105,7 +104,7 @@ class Generator
|
||||
}
|
||||
|
||||
$app = app();
|
||||
return $this->view->make('helper')
|
||||
return $this->view->make('ide-helper::helper')
|
||||
->with('namespaces_by_extends_ns', [])
|
||||
->with('namespaces_by_alias_ns', ['__root' => [$alias]])
|
||||
->with('real_time_facades', [])
|
||||
@@ -115,6 +114,24 @@ class Generator
|
||||
->render();
|
||||
}
|
||||
|
||||
protected function detectHelpers()
|
||||
{
|
||||
$helpers = $this->helpers;
|
||||
|
||||
$replacements = [
|
||||
'($guard is null ? \Illuminate\Contracts\Auth\Factory : \Illuminate\Contracts\Auth\StatefulGuard)' => '\\Auth',
|
||||
];
|
||||
foreach ($replacements as $search => $replace) {
|
||||
$helpers = Str::replace(
|
||||
"@return {$search}",
|
||||
"@return $replace|$search",
|
||||
$helpers
|
||||
);
|
||||
}
|
||||
|
||||
return $helpers;
|
||||
}
|
||||
|
||||
protected function detectDrivers()
|
||||
{
|
||||
$defaultUserModel = config('auth.providers.users.model', config('auth.model', 'App\User'));
|
||||
@@ -213,8 +230,10 @@ class Generator
|
||||
foreach ($realTimeFacadeFiles as $file) {
|
||||
try {
|
||||
$name = $this->getFullyQualifiedClassNameInFile($file);
|
||||
if ($name) {
|
||||
$facades[$name] = $name;
|
||||
} catch (\Exception $e) {
|
||||
}
|
||||
} catch (\Throwable $e) {
|
||||
continue;
|
||||
}
|
||||
}
|
||||
@@ -226,26 +245,17 @@ class Generator
|
||||
{
|
||||
$contents = file_get_contents($path);
|
||||
|
||||
$parsers = new Php7(new Emulative());
|
||||
// Match namespace
|
||||
preg_match('/namespace\s+([^;]+);/', $contents, $namespaceMatch);
|
||||
$namespace = isset($namespaceMatch[1]) ? $namespaceMatch[1] : '';
|
||||
|
||||
$parsed = collect($parsers->parse($contents) ?: []);
|
||||
// Match class name
|
||||
preg_match('/class\s+([a-zA-Z0-9_]+)/', $contents, $classMatch);
|
||||
$className = isset($classMatch[1]) ? $classMatch[1] : '';
|
||||
|
||||
$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;
|
||||
// Combine namespace and class name
|
||||
if ($namespace && $className) {
|
||||
return $namespace . '\\' . $className;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -20,10 +20,6 @@ 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 implements DeferrableProvider
|
||||
{
|
||||
@@ -65,12 +61,6 @@ class IdeHelperServiceProvider extends ServiceProvider implements DeferrableProv
|
||||
$configPath = __DIR__ . '/../config/ide-helper.php';
|
||||
$this->mergeConfigFrom($configPath, 'ide-helper');
|
||||
|
||||
$this->app->when([GeneratorCommand::class, MetaCommand::class, ModelsCommand::class])
|
||||
->needs(\Illuminate\Contracts\View\Factory::class)
|
||||
->give(function () {
|
||||
return $this->createLocalViewFactory();
|
||||
});
|
||||
|
||||
$this->commands(
|
||||
[
|
||||
GeneratorCommand::class,
|
||||
@@ -95,20 +85,4 @@ class IdeHelperServiceProvider extends ServiceProvider implements DeferrableProv
|
||||
EloquentCommand::class,
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* @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;
|
||||
}
|
||||
}
|
||||
|
||||
+51
-10
@@ -9,11 +9,12 @@ use Illuminate\Support\Collection;
|
||||
|
||||
class Macro extends Method
|
||||
{
|
||||
protected static $macroDefaults = [];
|
||||
|
||||
/**
|
||||
* Macro constructor.
|
||||
*
|
||||
* @param \ReflectionFunctionAbstract $method
|
||||
* @param string $alias
|
||||
* @param \ReflectionClass $class
|
||||
* @param null $methodName
|
||||
* @param array $interfaces
|
||||
@@ -22,16 +23,19 @@ class Macro extends Method
|
||||
*/
|
||||
public function __construct(
|
||||
$method,
|
||||
$alias,
|
||||
$class,
|
||||
$methodName = null,
|
||||
$interfaces = [],
|
||||
$classAliases = [],
|
||||
$returnTypeNormalizers = []
|
||||
) {
|
||||
parent::__construct($method, $alias, $class, $methodName, $interfaces, $classAliases, $returnTypeNormalizers);
|
||||
parent::__construct($method, $class, $methodName, $interfaces, $classAliases, $returnTypeNormalizers);
|
||||
}
|
||||
|
||||
public static function setDefaultReturnTypes(array $map = [])
|
||||
{
|
||||
static::$macroDefaults = array_merge(static::$macroDefaults, $map);
|
||||
}
|
||||
/**
|
||||
* @param \ReflectionFunctionAbstract $method
|
||||
*/
|
||||
@@ -69,29 +73,66 @@ class Macro extends Method
|
||||
|
||||
$type = $this->concatReflectionTypes($return);
|
||||
|
||||
/** @psalm-suppress UndefinedClass */
|
||||
if (!$return instanceof \ReflectionUnionType) {
|
||||
/** @phpstan-ignore method.notFound */
|
||||
$type .= $this->root === "\\{$builder}" && $return->getName() === $builder ? '|static' : '';
|
||||
$type .= $return->allowsNull() ? '|null' : '';
|
||||
}
|
||||
|
||||
$this->phpdoc->appendTag(Tag::createInstance("@return {$type}"));
|
||||
}
|
||||
|
||||
$class = ltrim($this->declaringClassName, '\\');
|
||||
if (!$this->phpdoc->hasTag('return') && isset(static::$macroDefaults[$class])) {
|
||||
$type = static::$macroDefaults[$class];
|
||||
$this->phpdoc->appendTag(Tag::createInstance("@return {$type}"));
|
||||
}
|
||||
}
|
||||
|
||||
protected function concatReflectionTypes(?\ReflectionType $type): string
|
||||
{
|
||||
/** @psalm-suppress UndefinedClass */
|
||||
$returnTypes = $type instanceof \ReflectionUnionType
|
||||
? $type->getTypes()
|
||||
: [$type];
|
||||
if ($type instanceof \ReflectionNamedType) {
|
||||
return $type->getName();
|
||||
}
|
||||
|
||||
return Collection::make($returnTypes)
|
||||
if ($type instanceof \ReflectionIntersectionType) {
|
||||
return $this->formatIntersectionType($type);
|
||||
}
|
||||
|
||||
if ($type instanceof \ReflectionUnionType) {
|
||||
return $this->formatUnionType($type);
|
||||
}
|
||||
|
||||
// Unknown or null type
|
||||
return '';
|
||||
}
|
||||
|
||||
protected function formatUnionType(\ReflectionUnionType $type): string
|
||||
{
|
||||
return Collection::make($type->getTypes())
|
||||
->map(function (\ReflectionType $inner) {
|
||||
if ($inner instanceof \ReflectionNamedType) {
|
||||
return $inner->getName();
|
||||
}
|
||||
if ($inner instanceof \ReflectionIntersectionType) {
|
||||
return $this->formatIntersectionType($inner);
|
||||
}
|
||||
// ReflectionUnionType cannot be nested per PHP's DNF rules
|
||||
return null;
|
||||
})
|
||||
->filter()
|
||||
->map->getName()
|
||||
->implode('|');
|
||||
}
|
||||
|
||||
protected function formatIntersectionType(\ReflectionIntersectionType $type): string
|
||||
{
|
||||
$parts = Collection::make($type->getTypes())
|
||||
->map(fn (\ReflectionNamedType $t) => $t->getName())
|
||||
->toArray();
|
||||
|
||||
return '(' . implode('&', $parts) . ')';
|
||||
}
|
||||
|
||||
protected function addLocationToPhpDoc()
|
||||
{
|
||||
if ($this->method->name === '__invoke') {
|
||||
|
||||
+56
-6
@@ -39,16 +39,19 @@ class Method
|
||||
protected $classAliases;
|
||||
protected $returnTypeNormalizers;
|
||||
|
||||
/** @var string[] */
|
||||
protected $templateNames = [];
|
||||
|
||||
/**
|
||||
* @param \ReflectionMethod|\ReflectionFunctionAbstract $method
|
||||
* @param string $alias
|
||||
* @param \ReflectionClass $class
|
||||
* @param string|null $methodName
|
||||
* @param array $interfaces
|
||||
* @param array $classAliases
|
||||
* @param array $returnTypeNormalizers
|
||||
* @param string[] $templateNames
|
||||
*/
|
||||
public function __construct($method, $alias, $class, $methodName = null, $interfaces = [], array $classAliases = [], array $returnTypeNormalizers = [])
|
||||
public function __construct($method, $class, $methodName = null, $interfaces = [], array $classAliases = [], array $returnTypeNormalizers = [], array $templateNames = [])
|
||||
{
|
||||
$this->method = $method;
|
||||
$this->interfaces = $interfaces;
|
||||
@@ -56,6 +59,7 @@ class Method
|
||||
$this->returnTypeNormalizers = $returnTypeNormalizers;
|
||||
$this->name = $methodName ?: $method->name;
|
||||
$this->real_name = $method->isClosure() ? $this->name : $method->name;
|
||||
$this->templateNames = $templateNames;
|
||||
$this->initClassDefinedProperties($method, $class);
|
||||
|
||||
//Reference the 'real' function in the declaring class
|
||||
@@ -72,6 +76,8 @@ class Method
|
||||
} catch (\Exception $e) {
|
||||
}
|
||||
|
||||
$this->removePhpDocParamTagsForOptionalParameters();
|
||||
|
||||
//Get the parameters, including formatted default values
|
||||
$this->getParameters($method);
|
||||
|
||||
@@ -84,7 +90,7 @@ class Method
|
||||
*/
|
||||
protected function initPhpDoc($method)
|
||||
{
|
||||
$this->phpdoc = new DocBlock($method, new Context($this->namespace, $this->classAliases));
|
||||
$this->phpdoc = new DocBlock($method, new Context($this->namespace, $this->classAliases, generics: $this->templateNames));
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -173,7 +179,7 @@ class Method
|
||||
/**
|
||||
* Get the parameters for this method
|
||||
*
|
||||
* @param bool $implode Wether to implode the array or not
|
||||
* @param bool $implode Whether to implode the array or not
|
||||
* @return string
|
||||
*/
|
||||
public function getParams($implode = true)
|
||||
@@ -203,7 +209,7 @@ class Method
|
||||
/**
|
||||
* Get the parameters for this method including default values
|
||||
*
|
||||
* @param bool $implode Wether to implode the array or not
|
||||
* @param bool $implode Whether to implode the array or not
|
||||
* @return string
|
||||
*/
|
||||
public function getParamsWithDefault($implode = true)
|
||||
@@ -244,6 +250,50 @@ class Method
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove @param tags for optional reflection parameters so generated stubs match arity
|
||||
* checks in static analysis (optional params still appear in the PHP signature).
|
||||
*/
|
||||
protected function removePhpDocParamTagsForOptionalParameters(): void
|
||||
{
|
||||
if (!$this->method instanceof \ReflectionMethod) {
|
||||
return;
|
||||
}
|
||||
|
||||
$declaring = $this->method->getDeclaringClass()->getName();
|
||||
if (
|
||||
$declaring !== \Illuminate\Database\Query\Builder::class
|
||||
&& $declaring !== \Illuminate\Database\Eloquent\Builder::class
|
||||
) {
|
||||
return;
|
||||
}
|
||||
|
||||
foreach ($this->method->getParameters() as $param) {
|
||||
if (!$param->isOptional() || $param->isVariadic()) {
|
||||
continue;
|
||||
}
|
||||
if (!$param->isDefaultValueAvailable()) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$default = $param->getDefaultValue();
|
||||
// Keep @param for null/array defaults (nullable and list defaults stay documented).
|
||||
// Strip only non-null scalars (e.g. $boolean = 'and', $not = false) so tools that
|
||||
// count @param tags do not report false "missing argument" errors on shortened calls.
|
||||
if ($default === null || is_array($default) || !is_scalar($default)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$varName = '$' . $param->getName();
|
||||
$paramTags = $this->phpdoc->getTagsByName('param');
|
||||
foreach (array_values($paramTags) as $tag) {
|
||||
if ($tag instanceof ParamTag && $tag->getVariableName() === $varName) {
|
||||
$this->phpdoc->deleteTag($tag);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Normalize the parameters
|
||||
*
|
||||
@@ -386,7 +436,7 @@ class Method
|
||||
}
|
||||
if ($method) {
|
||||
$namespace = $method->getDeclaringClass()->getNamespaceName();
|
||||
$phpdoc = new DocBlock($method, new Context($namespace, $this->classAliases));
|
||||
$phpdoc = new DocBlock($method, new Context($namespace, $this->classAliases, generics: $this->templateNames));
|
||||
|
||||
if (strpos($phpdoc->getText(), '{@inheritdoc}') !== false) {
|
||||
//Not at the end yet, try another parent/interface..
|
||||
|
||||
@@ -1,124 +0,0 @@
|
||||
<?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);
|
||||
}
|
||||
}
|
||||
@@ -9,6 +9,7 @@ use Barryvdh\LaravelIdeHelper\Macro;
|
||||
use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
|
||||
use Illuminate\Database\Query\Builder;
|
||||
use Illuminate\Support\Arr;
|
||||
use Illuminate\Support\Facades\Facade;
|
||||
|
||||
/**
|
||||
* @internal
|
||||
@@ -66,6 +67,37 @@ class AliasTest extends TestCase
|
||||
$this->assertNotNull($this->getAliasMacro($alias, EloquentBuilder::class, $macro));
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers ::detectFake
|
||||
*/
|
||||
public function testNoExceptionOnRequiredFakeParameters(): void
|
||||
{
|
||||
// Mock
|
||||
$alias = new AliasMock();
|
||||
|
||||
// Prepare
|
||||
$alias->setFacade(MockFacade::class);
|
||||
$this->expectNotToPerformAssertions();
|
||||
|
||||
// Test
|
||||
$alias->detectFake();
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers ::detectTemplateNames
|
||||
*/
|
||||
public function testTemplateNamesAreDetected(): void
|
||||
{
|
||||
// Mock
|
||||
$alias = new AliasMock();
|
||||
|
||||
// Prepare
|
||||
$alias->setClasses([EloquentBuilder::class]);
|
||||
|
||||
// Test
|
||||
$this->assertSame(['TModel', 'TValue'], $alias->getTemplateNames());
|
||||
}
|
||||
|
||||
protected function getAliasMacro(Alias $alias, string $class, string $method): ?Macro
|
||||
{
|
||||
return Arr::first(
|
||||
@@ -82,6 +114,7 @@ class AliasTest extends TestCase
|
||||
/**
|
||||
* @internal
|
||||
* @noinspection PhpMultipleClassesDeclarationsInOneFile
|
||||
* @template TValue
|
||||
*/
|
||||
class AliasMock extends Alias
|
||||
{
|
||||
@@ -102,4 +135,26 @@ class AliasMock extends Alias
|
||||
{
|
||||
parent::detectMethods();
|
||||
}
|
||||
|
||||
public function detectFake()
|
||||
{
|
||||
parent::detectFake();
|
||||
}
|
||||
|
||||
public function setFacade(string $facade)
|
||||
{
|
||||
$this->facade = $facade;
|
||||
}
|
||||
}
|
||||
|
||||
class MockFacade extends Facade
|
||||
{
|
||||
protected static function getFacadeAccessor()
|
||||
{
|
||||
return 'Illuminate\Foundation\Exceptions\Handler';
|
||||
}
|
||||
|
||||
public static function fake(string $test1, $test2 = null)
|
||||
{
|
||||
}
|
||||
}
|
||||
|
||||
@@ -5,7 +5,6 @@ declare(strict_types=1);
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\GeneratorCommand;
|
||||
|
||||
use Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider;
|
||||
use Barryvdh\LaravelIdeHelper\Tests\SnapshotPhpDriver;
|
||||
use Barryvdh\LaravelIdeHelper\Tests\TestCase;
|
||||
|
||||
abstract class AbstractGeneratorCommand extends TestCase
|
||||
@@ -27,9 +26,4 @@ abstract class AbstractGeneratorCommand extends TestCase
|
||||
{
|
||||
return [IdeHelperServiceProvider::class];
|
||||
}
|
||||
|
||||
protected function assertMatchesMockedSnapshot()
|
||||
{
|
||||
$this->assertMatchesSnapshot($this->mockFilesystemOutput, new SnapshotPhpDriver());
|
||||
}
|
||||
}
|
||||
|
||||
@@ -6,18 +6,30 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\GeneratorCommand\GenerateIdeHe
|
||||
|
||||
use Barryvdh\LaravelIdeHelper\Console\GeneratorCommand;
|
||||
use Barryvdh\LaravelIdeHelper\Tests\Console\GeneratorCommand\AbstractGeneratorCommand;
|
||||
use Illuminate\Support\Arr;
|
||||
use Illuminate\Support\Facades\DB;
|
||||
|
||||
class Test extends AbstractGeneratorCommand
|
||||
{
|
||||
public function testGenerator(): void
|
||||
{
|
||||
Arr::macro('arr_custom_macro', function () {
|
||||
});
|
||||
DB::macro('db_custom_macro', function () {
|
||||
});
|
||||
$this->app['config']->set('ide-helper.macro_default_return_types', [Arr::class => 'Custom_Fake_Class']);
|
||||
|
||||
$command = $this->app->make(GeneratorCommand::class);
|
||||
|
||||
$tester = $this->runCommand($command);
|
||||
|
||||
$this->assertSame(0, $tester->getStatusCode());
|
||||
|
||||
$this->assertStringContainsString('A new helper file was written to _ide_helper.php', $tester->getDisplay());
|
||||
$this->assertStringContainsString('public static function configure($basePath = null)', $this->mockFilesystemOutput);
|
||||
$this->assertStringContainsString('* @return \Custom_Fake_Class', $this->mockFilesystemOutput);
|
||||
$this->assertStringContainsString('public static function arr_custom_macro()', $this->mockFilesystemOutput);
|
||||
$this->assertStringContainsString('public static function db_custom_macro()', $this->mockFilesystemOutput);
|
||||
}
|
||||
|
||||
public function testFilename(): void
|
||||
|
||||
@@ -27,7 +27,7 @@ class MetaCommandTest extends TestCase
|
||||
|
||||
$mockFileSystem
|
||||
->shouldReceive('getRequire')
|
||||
->andReturnUsing(function ($__path, $__data) {
|
||||
->andReturnUsing(function ($__path, $__data = []) {
|
||||
return (static function () use ($__path, $__data) {
|
||||
extract($__data, EXTR_SKIP);
|
||||
|
||||
@@ -60,7 +60,7 @@ class MetaCommandTest extends TestCase
|
||||
|
||||
$mockFileSystem
|
||||
->shouldReceive('getRequire')
|
||||
->andReturnUsing(function ($__path, $__data) {
|
||||
->andReturnUsing(function ($__path, $__data = []) {
|
||||
return (static function () use ($__path, $__data) {
|
||||
extract($__data, EXTR_SKIP);
|
||||
|
||||
|
||||
@@ -5,7 +5,6 @@ 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
|
||||
@@ -51,10 +50,7 @@ abstract class AbstractModelsCommand extends TestCase
|
||||
|
||||
// Don't override integer -> int for tests
|
||||
$config->set('ide-helper.type_overrides', []);
|
||||
}
|
||||
|
||||
protected function assertMatchesMockedSnapshot()
|
||||
{
|
||||
$this->assertMatchesSnapshot($this->mockFilesystemOutput, new SnapshotPhpDriver());
|
||||
$config->set('ide-helper.write_model_relation_exists_properties', true);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,21 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts\Collections;
|
||||
|
||||
use Illuminate\Contracts\Support\Arrayable;
|
||||
use JsonSerializable;
|
||||
|
||||
class AdvancedCastMap implements Arrayable, JsonSerializable
|
||||
{
|
||||
public function toArray(): array
|
||||
{
|
||||
return [];
|
||||
}
|
||||
|
||||
public function jsonSerialize(): array
|
||||
{
|
||||
return $this->toArray();
|
||||
}
|
||||
}
|
||||
@@ -5,6 +5,7 @@ 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\Collections\AdvancedCastMap;
|
||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts\Enums\AdvancedCastEnum;
|
||||
use Illuminate\Database\Eloquent\Casts\AsArrayObject;
|
||||
use Illuminate\Database\Eloquent\Casts\AsCollection;
|
||||
@@ -29,7 +30,9 @@ class AdvancedCast extends Model
|
||||
'cast_to_encrypted_json' => 'encrypted:json',
|
||||
'cast_to_encrypted_object' => 'encrypted:object',
|
||||
'cast_to_as_collection' => AsCollection::class,
|
||||
'cast_to_as_collection_of' => AsCollection::class . ':,' . AdvancedCastMap::class, // since 12.10
|
||||
'cast_to_as_collection_using' => AsCollection::using(AdvancedCastCollection::class),
|
||||
'cast_to_as_collection_using_and_map' => AsCollection::class . ':' . AdvancedCastCollection::class . ',' . AdvancedCastMap::class, // since 12.10
|
||||
'cast_to_as_enum_collection' => AsEnumCollection::class,
|
||||
'cast_to_as_enum_collection_of' => AsEnumCollection::of(AdvancedCastEnum::class),
|
||||
'cast_to_as_array_object' => AsArrayObject::class,
|
||||
|
||||
@@ -5,6 +5,7 @@ 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\Collections\AdvancedCastMap;
|
||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts\Enums\AdvancedCastEnum;
|
||||
use Illuminate\Database\Eloquent\Casts\AsArrayObject;
|
||||
use Illuminate\Database\Eloquent\Casts\AsCollection;
|
||||
@@ -12,8 +13,6 @@ 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
|
||||
@@ -21,15 +20,17 @@ use Illuminate\Database\Eloquent\Model;
|
||||
* @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 string $cast_to_encrypted
|
||||
* @property array<array-key, mixed> $cast_to_encrypted_array
|
||||
* @property \Illuminate\Support\Collection<array-key, mixed> $cast_to_encrypted_collection
|
||||
* @property array<array-key, mixed> $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<array-key, mixed> $cast_to_as_array_object
|
||||
* @property \Illuminate\Database\Eloquent\Casts\ArrayObject<array-key, mixed> $cast_to_as_array_object
|
||||
* @property \Illuminate\Support\Collection<int, AdvancedCastMap> $cast_to_as_collection_of
|
||||
* @property AdvancedCastCollection $cast_to_as_collection_using
|
||||
* @property AdvancedCastCollection<int, AdvancedCastMap> $cast_to_as_collection_using_and_map
|
||||
* @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()
|
||||
@@ -69,7 +70,9 @@ class AdvancedCast extends Model
|
||||
'cast_to_encrypted_json' => 'encrypted:json',
|
||||
'cast_to_encrypted_object' => 'encrypted:object',
|
||||
'cast_to_as_collection' => AsCollection::class,
|
||||
'cast_to_as_collection_of' => AsCollection::class . ':,' . AdvancedCastMap::class, // since 12.10
|
||||
'cast_to_as_collection_using' => AsCollection::using(AdvancedCastCollection::class),
|
||||
'cast_to_as_collection_using_and_map' => AsCollection::class . ':' . AdvancedCastCollection::class . ',' . AdvancedCastMap::class, // since 12.10
|
||||
'cast_to_as_enum_collection' => AsEnumCollection::class,
|
||||
'cast_to_as_enum_collection_of' => AsEnumCollection::of(AdvancedCastEnum::class),
|
||||
'cast_to_as_array_object' => AsArrayObject::class,
|
||||
|
||||
@@ -7,8 +7,6 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AllowGlobDirecto
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property int $id
|
||||
* @property string|null $char_nullable
|
||||
* @property string $char_not_nullable
|
||||
@@ -44,8 +42,8 @@ use Illuminate\Database\Eloquent\Model;
|
||||
* @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 numeric|null $decimal_nullable
|
||||
* @property numeric $decimal_not_nullable
|
||||
* @property int|null $boolean_nullable
|
||||
* @property int $boolean_not_nullable
|
||||
* @property string|null $enum_nullable
|
||||
|
||||
@@ -7,8 +7,6 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\ArrayCastsWithCo
|
||||
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
|
||||
|
||||
@@ -8,8 +8,6 @@ use Illuminate\Database\Eloquent\Casts\Attribute;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property int $id
|
||||
* @property string|null $name
|
||||
* @property string|null $name_read
|
||||
@@ -85,8 +83,6 @@ 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
|
||||
|
||||
@@ -10,8 +10,6 @@ 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
|
||||
@@ -23,6 +21,7 @@ use Illuminate\Database\Eloquent\Relations\MorphTo;
|
||||
* @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 bool|null $relation_has_many_exists
|
||||
* @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.
|
||||
|
||||
@@ -9,11 +9,10 @@ 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
|
||||
* @property-read bool|null $relation_has_many_exists
|
||||
* @method static SimpleCollection<int, static> all($columns = ['*'])
|
||||
* @method static SimpleCollection<int, static> get($columns = ['*'])
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple newModelQuery()
|
||||
|
||||
@@ -7,8 +7,6 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\CustomDate\Model
|
||||
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()
|
||||
|
||||
@@ -0,0 +1,218 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\DnfTypes\Models;
|
||||
|
||||
use ArrayAccess;
|
||||
use Countable;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
use Iterator;
|
||||
use Stringable;
|
||||
use Traversable;
|
||||
|
||||
/**
|
||||
* Test model covering all DNF type scenarios from PHP RFC.
|
||||
*
|
||||
* @see https://wiki.php.net/rfc/dnf_types
|
||||
*/
|
||||
class DnfTypeModel extends Model
|
||||
{
|
||||
// =========================================================================
|
||||
// RFC Example 1: (A&B)|null - Intersection with null
|
||||
// =========================================================================
|
||||
|
||||
/**
|
||||
* Basic DNF: intersection OR null.
|
||||
*/
|
||||
public function getBasicDnfAttribute(): (Countable&Iterator)|null
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
// =========================================================================
|
||||
// RFC Example 2: (A&B)|D - Intersection OR single type (no null)
|
||||
// =========================================================================
|
||||
|
||||
/**
|
||||
* Intersection OR single class type.
|
||||
*/
|
||||
public function getIntersectionOrClassAttribute(): (Countable&Iterator)|\stdClass
|
||||
{
|
||||
return new \stdClass();
|
||||
}
|
||||
|
||||
// =========================================================================
|
||||
// RFC Example 3: C|(X&D)|null - Single type OR intersection OR null
|
||||
// =========================================================================
|
||||
|
||||
/**
|
||||
* Single type OR intersection OR null.
|
||||
*/
|
||||
public function getSingleOrIntersectionOrNullAttribute(): \stdClass|(Countable&Iterator)|null
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
// =========================================================================
|
||||
// RFC Example 4: (A&B&D)|int|null - Triple intersection OR primitive OR null
|
||||
// =========================================================================
|
||||
|
||||
/**
|
||||
* Triple intersection OR primitive OR null.
|
||||
*/
|
||||
public function getTripleIntersectionAttribute(): (Countable&Iterator&Traversable)|int|null
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
// =========================================================================
|
||||
// RFC Example 5: (A&B)|(C&D)|null - Multiple intersection segments
|
||||
// =========================================================================
|
||||
|
||||
/**
|
||||
* Multiple intersection segments OR null.
|
||||
*/
|
||||
public function getMultipleIntersectionsAttribute(): (Countable&Iterator)|(ArrayAccess&Stringable)|null
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
// =========================================================================
|
||||
// RFC Example 6: (A&B)|(C&D)|(E&F) - Multiple intersections without null
|
||||
// =========================================================================
|
||||
|
||||
/**
|
||||
* Multiple intersection segments without null.
|
||||
*/
|
||||
public function getMultipleIntersectionsNoNullAttribute(): (Countable&Iterator)|(ArrayAccess&Stringable)|(Traversable&Countable)
|
||||
{
|
||||
return new class () implements Countable, Iterator {
|
||||
public function count(): int
|
||||
{
|
||||
return 0;
|
||||
}
|
||||
|
||||
public function current(): mixed
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
public function key(): mixed
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
public function next(): void
|
||||
{
|
||||
}
|
||||
|
||||
public function rewind(): void
|
||||
{
|
||||
}
|
||||
|
||||
public function valid(): bool
|
||||
{
|
||||
return false;
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
// =========================================================================
|
||||
// Pure intersection type (A&B) - No union, just intersection
|
||||
// =========================================================================
|
||||
|
||||
/**
|
||||
* Pure intersection type without union.
|
||||
*/
|
||||
public function getPureIntersectionAttribute(): Countable&Iterator
|
||||
{
|
||||
return new class () implements Countable, Iterator {
|
||||
public function count(): int
|
||||
{
|
||||
return 0;
|
||||
}
|
||||
|
||||
public function current(): mixed
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
public function key(): mixed
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
public function next(): void
|
||||
{
|
||||
}
|
||||
|
||||
public function rewind(): void
|
||||
{
|
||||
}
|
||||
|
||||
public function valid(): bool
|
||||
{
|
||||
return false;
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
// =========================================================================
|
||||
// Parameter context: DNF types in method parameters
|
||||
// =========================================================================
|
||||
|
||||
/**
|
||||
* Scope with DNF parameter: (A&B)|null.
|
||||
*/
|
||||
public function scopeWithBasicDnfParam(
|
||||
\Illuminate\Database\Query\Builder $query,
|
||||
(Countable&Iterator)|null $param
|
||||
): \Illuminate\Database\Query\Builder {
|
||||
return $query;
|
||||
}
|
||||
|
||||
/**
|
||||
* Scope with complex DNF parameter: C|(A&B)|null.
|
||||
*/
|
||||
public function scopeWithComplexDnfParam(
|
||||
\Illuminate\Database\Query\Builder $query,
|
||||
\stdClass|(Countable&Iterator)|null $param
|
||||
): \Illuminate\Database\Query\Builder {
|
||||
return $query;
|
||||
}
|
||||
|
||||
/**
|
||||
* Scope with multiple intersection parameters.
|
||||
*/
|
||||
public function scopeWithMultipleIntersectionParam(
|
||||
\Illuminate\Database\Query\Builder $query,
|
||||
(Countable&Iterator)|(ArrayAccess&Stringable) $param
|
||||
): \Illuminate\Database\Query\Builder {
|
||||
return $query;
|
||||
}
|
||||
|
||||
/**
|
||||
* Scope with intersection OR primitive parameter.
|
||||
*/
|
||||
public function scopeWithIntersectionOrPrimitive(
|
||||
\Illuminate\Database\Query\Builder $query,
|
||||
(Countable&Iterator)|int $param
|
||||
): \Illuminate\Database\Query\Builder {
|
||||
return $query;
|
||||
}
|
||||
|
||||
// =========================================================================
|
||||
// Mixed: DNF in both parameter and return type
|
||||
// =========================================================================
|
||||
|
||||
/**
|
||||
* DNF in both parameter and return type.
|
||||
*/
|
||||
public function scopeWithDnfParamAndReturn(
|
||||
\Illuminate\Database\Query\Builder $query,
|
||||
(Countable&Iterator)|null $param
|
||||
): (Countable&Iterator)|\Illuminate\Database\Query\Builder {
|
||||
return $query;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,24 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\DnfTypes;
|
||||
|
||||
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();
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,234 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\DnfTypes\Models;
|
||||
|
||||
use ArrayAccess;
|
||||
use Countable;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
use Iterator;
|
||||
use Stringable;
|
||||
use Traversable;
|
||||
|
||||
/**
|
||||
* Test model covering all DNF type scenarios from PHP RFC.
|
||||
*
|
||||
* @see https://wiki.php.net/rfc/dnf_types
|
||||
* @property-read (\Countable&\Iterator)|null $basic_dnf
|
||||
* @property-read (\Countable&\Iterator)|\stdClass $intersection_or_class
|
||||
* @property-read (\Countable&\Iterator)|(\ArrayAccess&\Stringable)|null $multiple_intersections
|
||||
* @property-read (\Countable&\Iterator)|(\ArrayAccess&\Stringable)|(\Traversable&\Countable) $multiple_intersections_no_null
|
||||
* @property-read (\Countable&\Iterator) $pure_intersection
|
||||
* @property-read \stdClass|(\Countable&\Iterator)|null $single_or_intersection_or_null
|
||||
* @property-read (\Countable&\Iterator&\Traversable)|int|null $triple_intersection
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|DnfTypeModel newModelQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|DnfTypeModel newQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|DnfTypeModel query()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|DnfTypeModel withBasicDnfParam((\Countable&\Iterator)|null $param)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|DnfTypeModel withComplexDnfParam(\stdClass|(\Countable&\Iterator)|null $param)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|DnfTypeModel withDnfParamAndReturn((\Countable&\Iterator)|null $param)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|DnfTypeModel withIntersectionOrPrimitive((\Countable&\Iterator)|int $param)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|DnfTypeModel withMultipleIntersectionParam((\Countable&\Iterator)|(\ArrayAccess&\Stringable) $param)
|
||||
* @mixin \Eloquent
|
||||
*/
|
||||
class DnfTypeModel extends Model
|
||||
{
|
||||
// =========================================================================
|
||||
// RFC Example 1: (A&B)|null - Intersection with null
|
||||
// =========================================================================
|
||||
|
||||
/**
|
||||
* Basic DNF: intersection OR null.
|
||||
*/
|
||||
public function getBasicDnfAttribute(): (Countable&Iterator)|null
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
// =========================================================================
|
||||
// RFC Example 2: (A&B)|D - Intersection OR single type (no null)
|
||||
// =========================================================================
|
||||
|
||||
/**
|
||||
* Intersection OR single class type.
|
||||
*/
|
||||
public function getIntersectionOrClassAttribute(): (Countable&Iterator)|\stdClass
|
||||
{
|
||||
return new \stdClass();
|
||||
}
|
||||
|
||||
// =========================================================================
|
||||
// RFC Example 3: C|(X&D)|null - Single type OR intersection OR null
|
||||
// =========================================================================
|
||||
|
||||
/**
|
||||
* Single type OR intersection OR null.
|
||||
*/
|
||||
public function getSingleOrIntersectionOrNullAttribute(): \stdClass|(Countable&Iterator)|null
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
// =========================================================================
|
||||
// RFC Example 4: (A&B&D)|int|null - Triple intersection OR primitive OR null
|
||||
// =========================================================================
|
||||
|
||||
/**
|
||||
* Triple intersection OR primitive OR null.
|
||||
*/
|
||||
public function getTripleIntersectionAttribute(): (Countable&Iterator&Traversable)|int|null
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
// =========================================================================
|
||||
// RFC Example 5: (A&B)|(C&D)|null - Multiple intersection segments
|
||||
// =========================================================================
|
||||
|
||||
/**
|
||||
* Multiple intersection segments OR null.
|
||||
*/
|
||||
public function getMultipleIntersectionsAttribute(): (Countable&Iterator)|(ArrayAccess&Stringable)|null
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
// =========================================================================
|
||||
// RFC Example 6: (A&B)|(C&D)|(E&F) - Multiple intersections without null
|
||||
// =========================================================================
|
||||
|
||||
/**
|
||||
* Multiple intersection segments without null.
|
||||
*/
|
||||
public function getMultipleIntersectionsNoNullAttribute(): (Countable&Iterator)|(ArrayAccess&Stringable)|(Traversable&Countable)
|
||||
{
|
||||
return new class () implements Countable, Iterator {
|
||||
public function count(): int
|
||||
{
|
||||
return 0;
|
||||
}
|
||||
|
||||
public function current(): mixed
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
public function key(): mixed
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
public function next(): void
|
||||
{
|
||||
}
|
||||
|
||||
public function rewind(): void
|
||||
{
|
||||
}
|
||||
|
||||
public function valid(): bool
|
||||
{
|
||||
return false;
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
// =========================================================================
|
||||
// Pure intersection type (A&B) - No union, just intersection
|
||||
// =========================================================================
|
||||
|
||||
/**
|
||||
* Pure intersection type without union.
|
||||
*/
|
||||
public function getPureIntersectionAttribute(): Countable&Iterator
|
||||
{
|
||||
return new class () implements Countable, Iterator {
|
||||
public function count(): int
|
||||
{
|
||||
return 0;
|
||||
}
|
||||
|
||||
public function current(): mixed
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
public function key(): mixed
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
public function next(): void
|
||||
{
|
||||
}
|
||||
|
||||
public function rewind(): void
|
||||
{
|
||||
}
|
||||
|
||||
public function valid(): bool
|
||||
{
|
||||
return false;
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
// =========================================================================
|
||||
// Parameter context: DNF types in method parameters
|
||||
// =========================================================================
|
||||
|
||||
/**
|
||||
* Scope with DNF parameter: (A&B)|null.
|
||||
*/
|
||||
public function scopeWithBasicDnfParam(
|
||||
\Illuminate\Database\Query\Builder $query,
|
||||
(Countable&Iterator)|null $param
|
||||
): \Illuminate\Database\Query\Builder {
|
||||
return $query;
|
||||
}
|
||||
|
||||
/**
|
||||
* Scope with complex DNF parameter: C|(A&B)|null.
|
||||
*/
|
||||
public function scopeWithComplexDnfParam(
|
||||
\Illuminate\Database\Query\Builder $query,
|
||||
\stdClass|(Countable&Iterator)|null $param
|
||||
): \Illuminate\Database\Query\Builder {
|
||||
return $query;
|
||||
}
|
||||
|
||||
/**
|
||||
* Scope with multiple intersection parameters.
|
||||
*/
|
||||
public function scopeWithMultipleIntersectionParam(
|
||||
\Illuminate\Database\Query\Builder $query,
|
||||
(Countable&Iterator)|(ArrayAccess&Stringable) $param
|
||||
): \Illuminate\Database\Query\Builder {
|
||||
return $query;
|
||||
}
|
||||
|
||||
/**
|
||||
* Scope with intersection OR primitive parameter.
|
||||
*/
|
||||
public function scopeWithIntersectionOrPrimitive(
|
||||
\Illuminate\Database\Query\Builder $query,
|
||||
(Countable&Iterator)|int $param
|
||||
): \Illuminate\Database\Query\Builder {
|
||||
return $query;
|
||||
}
|
||||
|
||||
// =========================================================================
|
||||
// Mixed: DNF in both parameter and return type
|
||||
// =========================================================================
|
||||
|
||||
/**
|
||||
* DNF in both parameter and return type.
|
||||
*/
|
||||
public function scopeWithDnfParamAndReturn(
|
||||
\Illuminate\Database\Query\Builder $query,
|
||||
(Countable&Iterator)|null $param
|
||||
): (Countable&Iterator)|\Illuminate\Database\Query\Builder {
|
||||
return $query;
|
||||
}
|
||||
}
|
||||
+2
-4
@@ -13,8 +13,6 @@
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\DoesNotGeneratePhpdocWithExternalEloquentBuilder\Models{
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property int $id
|
||||
* @property string|null $char_nullable
|
||||
* @property string $char_not_nullable
|
||||
@@ -50,8 +48,8 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\DoesNotGenerateP
|
||||
* @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 numeric|null $decimal_nullable
|
||||
* @property numeric $decimal_not_nullable
|
||||
* @property int|null $boolean_nullable
|
||||
* @property int $boolean_not_nullable
|
||||
* @property string|null $enum_nullable
|
||||
|
||||
@@ -10,10 +10,9 @@ 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
|
||||
* @property-read bool|null $regular_has_many_exists
|
||||
* @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()
|
||||
|
||||
@@ -9,8 +9,6 @@ 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()
|
||||
@@ -41,8 +39,6 @@ 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()
|
||||
@@ -60,8 +56,6 @@ 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()
|
||||
@@ -81,8 +75,6 @@ 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()
|
||||
|
||||
+2
-4
@@ -9,8 +9,6 @@ use Illuminate\Database\Eloquent\Builder;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property int $id
|
||||
* @property string|null $char_nullable
|
||||
* @property string $char_not_nullable
|
||||
@@ -46,8 +44,8 @@ use Illuminate\Database\Eloquent\Model;
|
||||
* @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 numeric|null $decimal_nullable
|
||||
* @property numeric $decimal_not_nullable
|
||||
* @property int|null $boolean_nullable
|
||||
* @property int $boolean_not_nullable
|
||||
* @property string|null $enum_nullable
|
||||
|
||||
@@ -7,8 +7,6 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateBasicPhp
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property int $id
|
||||
* @property string|null $char_nullable
|
||||
* @property string $char_not_nullable
|
||||
@@ -44,8 +42,8 @@ use Illuminate\Database\Eloquent\Model;
|
||||
* @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 numeric|null $decimal_nullable
|
||||
* @property numeric $decimal_not_nullable
|
||||
* @property int|null $boolean_nullable
|
||||
* @property int $boolean_not_nullable
|
||||
* @property string|null $enum_nullable
|
||||
|
||||
+2
-4
@@ -7,8 +7,6 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateBasicPhp
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property int $id
|
||||
* @property string|null $charNullable
|
||||
* @property string $charNotNullable
|
||||
@@ -44,8 +42,8 @@ use Illuminate\Database\Eloquent\Model;
|
||||
* @property float $floatNotNullable
|
||||
* @property float|null $doubleNullable
|
||||
* @property float $doubleNotNullable
|
||||
* @property string|null $decimalNullable
|
||||
* @property string $decimalNotNullable
|
||||
* @property numeric|null $decimalNullable
|
||||
* @property numeric $decimalNotNullable
|
||||
* @property int|null $booleanNullable
|
||||
* @property int $booleanNotNullable
|
||||
* @property string|null $enumNullable
|
||||
|
||||
+2
-4
@@ -7,8 +7,6 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateBasicPhp
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property int $id
|
||||
* @property string|null $char_nullable
|
||||
* @property string $char_not_nullable
|
||||
@@ -44,8 +42,8 @@ use Illuminate\Database\Eloquent\Model;
|
||||
* @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 numeric|null $decimal_nullable
|
||||
* @property numeric $decimal_not_nullable
|
||||
* @property int|null $boolean_nullable
|
||||
* @property int $boolean_not_nullable
|
||||
* @property string|null $enum_nullable
|
||||
|
||||
@@ -67,8 +67,6 @@ class WithCollection extends Model
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateMixinCollection\Models{
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property-read \Illuminate\Support\Collection<int, string> $collection
|
||||
* @property-read \Illuminate\Support\Collection<\Illuminate\Support\Collection, \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateMixinCollection\NonModels\CollectionModel<\Illuminate\Support\Collection, \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateMixinCollection\NonModels\CollectionModel<int, \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateMixinCollection\NonModels\NonModel>>> $collection_with_nested_template
|
||||
* @property-read \Illuminate\Support\Collection<int, \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateMixinCollection\NonModels\NonModel> $collection_with_non_model_template
|
||||
|
||||
@@ -0,0 +1,251 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpDocWithTypedScopeParameter\Models;
|
||||
|
||||
use Illuminate\Database\Eloquent\Builder;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
class Comment extends Model
|
||||
{
|
||||
/**
|
||||
* @comment Scope with required boolean parameter
|
||||
*/
|
||||
protected function scopeTyped01(Builder $query, bool $value)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional boolean parameter and default true
|
||||
*/
|
||||
protected function scopeTyped02(Builder $query, bool $value = true)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional boolean parameter and default false
|
||||
*/
|
||||
protected function scopeTyped03(Builder $query, bool $value = false)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with required string parameter
|
||||
*/
|
||||
protected function scopeTyped04(Builder $query, string $value)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional string parameter and default value
|
||||
*/
|
||||
protected function scopeTyped05(Builder $query, string $value = 'dummy123')
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with required integer parameter
|
||||
*/
|
||||
protected function scopeTyped06(Builder $query, int $value)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional integer parameter and default positive value
|
||||
*/
|
||||
protected function scopeTyped07(Builder $query, int $value = 123)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional integer parameter and default negative value
|
||||
*/
|
||||
protected function scopeTyped08(Builder $query, int $value = -123)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with required float parameter
|
||||
*/
|
||||
protected function scopeTyped09(Builder $query, float $value)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional float parameter and default positive integer value
|
||||
*/
|
||||
protected function scopeTyped10(Builder $query, float $value = 123)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional float parameter and default negative integer value
|
||||
*/
|
||||
protected function scopeTyped11(Builder $query, float $value = -123)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional float parameter and default positive float value
|
||||
*/
|
||||
protected function scopeTyped12(Builder $query, float $value = 1.23)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional float parameter and default negative float value
|
||||
*/
|
||||
protected function scopeTyped13(Builder $query, float $value = -1.23)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with required nullable boolean parameter
|
||||
*/
|
||||
protected function scopeTyped14(Builder $query, ?bool $value)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional nullable boolean parameter and default true
|
||||
*/
|
||||
protected function scopeTyped15(Builder $query, ?bool $value = true)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional nullable boolean parameter and default false
|
||||
*/
|
||||
protected function scopeTyped16(Builder $query, ?bool $value = false)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional nullable boolean parameter and default null
|
||||
*/
|
||||
protected function scopeTyped17(Builder $query, ?bool $value = null)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with required nullable string parameter
|
||||
*/
|
||||
protected function scopeTyped18(Builder $query, ?string $value)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional nullable string parameter and default value
|
||||
*/
|
||||
protected function scopeTyped19(Builder $query, ?string $value = 'dummy123')
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional nullable string parameter and default null
|
||||
*/
|
||||
protected function scopeTyped20(Builder $query, ?string $value = null)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with required nullable integer parameter
|
||||
*/
|
||||
protected function scopeTyped21(Builder $query, ?int $value)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional nullable integer parameter and default positive value
|
||||
*/
|
||||
protected function scopeTyped22(Builder $query, ?int $value = 123)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional nullable integer parameter and default negative value
|
||||
*/
|
||||
protected function scopeTyped23(Builder $query, ?int $value = -123)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional nullable integer parameter and default null
|
||||
*/
|
||||
protected function scopeTyped24(Builder $query, ?int $value = null)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with required float nullable parameter
|
||||
*/
|
||||
protected function scopeTyped25(Builder $query, ?float $value)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional nullable float parameter and default positive integer value
|
||||
*/
|
||||
protected function scopeTyped26(Builder $query, ?float $value = 123)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional nullable float parameter and default negative integer value
|
||||
*/
|
||||
protected function scopeTyped27(Builder $query, ?float $value = -123)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional float parameter and default positive float value
|
||||
*/
|
||||
protected function scopeTyped28(Builder $query, ?float $value = 1.23)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional float parameter and default negative float value
|
||||
*/
|
||||
protected function scopeTyped29(Builder $query, ?float $value = -1.23)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional float parameter and default null
|
||||
*/
|
||||
protected function scopeTyped30(Builder $query, ?float $value = null)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,24 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpDocWithTypedScopeParameter;
|
||||
|
||||
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();
|
||||
}
|
||||
}
|
||||
+287
@@ -0,0 +1,287 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpDocWithTypedScopeParameter\Models;
|
||||
|
||||
use Illuminate\Database\Eloquent\Builder;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
* @method static Builder<static>|Comment newModelQuery()
|
||||
* @method static Builder<static>|Comment newQuery()
|
||||
* @method static Builder<static>|Comment query()
|
||||
* @method static Builder<static>|Comment typed01(bool $value) Scope with required boolean parameter
|
||||
* @method static Builder<static>|Comment typed02(bool $value = true) Scope with optional boolean parameter and default true
|
||||
* @method static Builder<static>|Comment typed03(bool $value = false) Scope with optional boolean parameter and default false
|
||||
* @method static Builder<static>|Comment typed04(string $value) Scope with required string parameter
|
||||
* @method static Builder<static>|Comment typed05(string $value = 'dummy123') Scope with optional string parameter and default value
|
||||
* @method static Builder<static>|Comment typed06(int $value) Scope with required integer parameter
|
||||
* @method static Builder<static>|Comment typed07(int $value = 123) Scope with optional integer parameter and default positive value
|
||||
* @method static Builder<static>|Comment typed08(int $value = -123) Scope with optional integer parameter and default negative value
|
||||
* @method static Builder<static>|Comment typed09(float $value) Scope with required float parameter
|
||||
* @method static Builder<static>|Comment typed10(float $value = 123) Scope with optional float parameter and default positive integer value
|
||||
* @method static Builder<static>|Comment typed11(float $value = -123) Scope with optional float parameter and default negative integer value
|
||||
* @method static Builder<static>|Comment typed12(float $value = 1.23) Scope with optional float parameter and default positive float value
|
||||
* @method static Builder<static>|Comment typed13(float $value = -1.23) Scope with optional float parameter and default negative float value
|
||||
* @method static Builder<static>|Comment typed14(?bool $value) Scope with required nullable boolean parameter
|
||||
* @method static Builder<static>|Comment typed15(?bool $value = true) Scope with optional nullable boolean parameter and default true
|
||||
* @method static Builder<static>|Comment typed16(?bool $value = false) Scope with optional nullable boolean parameter and default false
|
||||
* @method static Builder<static>|Comment typed17(?bool $value = null) Scope with optional nullable boolean parameter and default null
|
||||
* @method static Builder<static>|Comment typed18(?string $value) Scope with required nullable string parameter
|
||||
* @method static Builder<static>|Comment typed19(?string $value = 'dummy123') Scope with optional nullable string parameter and default value
|
||||
* @method static Builder<static>|Comment typed20(?string $value = null) Scope with optional nullable string parameter and default null
|
||||
* @method static Builder<static>|Comment typed21(?int $value) Scope with required nullable integer parameter
|
||||
* @method static Builder<static>|Comment typed22(?int $value = 123) Scope with optional nullable integer parameter and default positive value
|
||||
* @method static Builder<static>|Comment typed23(?int $value = -123) Scope with optional nullable integer parameter and default negative value
|
||||
* @method static Builder<static>|Comment typed24(?int $value = null) Scope with optional nullable integer parameter and default null
|
||||
* @method static Builder<static>|Comment typed25(?float $value) Scope with required float nullable parameter
|
||||
* @method static Builder<static>|Comment typed26(?float $value = 123) Scope with optional nullable float parameter and default positive integer value
|
||||
* @method static Builder<static>|Comment typed27(?float $value = -123) Scope with optional nullable float parameter and default negative integer value
|
||||
* @method static Builder<static>|Comment typed28(?float $value = 1.23) Scope with optional float parameter and default positive float value
|
||||
* @method static Builder<static>|Comment typed29(?float $value = -1.23) Scope with optional float parameter and default negative float value
|
||||
* @method static Builder<static>|Comment typed30(?float $value = null) Scope with optional float parameter and default null
|
||||
* @mixin \Eloquent
|
||||
*/
|
||||
class Comment extends Model
|
||||
{
|
||||
/**
|
||||
* @comment Scope with required boolean parameter
|
||||
*/
|
||||
protected function scopeTyped01(Builder $query, bool $value)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional boolean parameter and default true
|
||||
*/
|
||||
protected function scopeTyped02(Builder $query, bool $value = true)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional boolean parameter and default false
|
||||
*/
|
||||
protected function scopeTyped03(Builder $query, bool $value = false)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with required string parameter
|
||||
*/
|
||||
protected function scopeTyped04(Builder $query, string $value)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional string parameter and default value
|
||||
*/
|
||||
protected function scopeTyped05(Builder $query, string $value = 'dummy123')
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with required integer parameter
|
||||
*/
|
||||
protected function scopeTyped06(Builder $query, int $value)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional integer parameter and default positive value
|
||||
*/
|
||||
protected function scopeTyped07(Builder $query, int $value = 123)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional integer parameter and default negative value
|
||||
*/
|
||||
protected function scopeTyped08(Builder $query, int $value = -123)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with required float parameter
|
||||
*/
|
||||
protected function scopeTyped09(Builder $query, float $value)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional float parameter and default positive integer value
|
||||
*/
|
||||
protected function scopeTyped10(Builder $query, float $value = 123)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional float parameter and default negative integer value
|
||||
*/
|
||||
protected function scopeTyped11(Builder $query, float $value = -123)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional float parameter and default positive float value
|
||||
*/
|
||||
protected function scopeTyped12(Builder $query, float $value = 1.23)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional float parameter and default negative float value
|
||||
*/
|
||||
protected function scopeTyped13(Builder $query, float $value = -1.23)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with required nullable boolean parameter
|
||||
*/
|
||||
protected function scopeTyped14(Builder $query, ?bool $value)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional nullable boolean parameter and default true
|
||||
*/
|
||||
protected function scopeTyped15(Builder $query, ?bool $value = true)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional nullable boolean parameter and default false
|
||||
*/
|
||||
protected function scopeTyped16(Builder $query, ?bool $value = false)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional nullable boolean parameter and default null
|
||||
*/
|
||||
protected function scopeTyped17(Builder $query, ?bool $value = null)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with required nullable string parameter
|
||||
*/
|
||||
protected function scopeTyped18(Builder $query, ?string $value)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional nullable string parameter and default value
|
||||
*/
|
||||
protected function scopeTyped19(Builder $query, ?string $value = 'dummy123')
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional nullable string parameter and default null
|
||||
*/
|
||||
protected function scopeTyped20(Builder $query, ?string $value = null)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with required nullable integer parameter
|
||||
*/
|
||||
protected function scopeTyped21(Builder $query, ?int $value)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional nullable integer parameter and default positive value
|
||||
*/
|
||||
protected function scopeTyped22(Builder $query, ?int $value = 123)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional nullable integer parameter and default negative value
|
||||
*/
|
||||
protected function scopeTyped23(Builder $query, ?int $value = -123)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional nullable integer parameter and default null
|
||||
*/
|
||||
protected function scopeTyped24(Builder $query, ?int $value = null)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with required float nullable parameter
|
||||
*/
|
||||
protected function scopeTyped25(Builder $query, ?float $value)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional nullable float parameter and default positive integer value
|
||||
*/
|
||||
protected function scopeTyped26(Builder $query, ?float $value = 123)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional nullable float parameter and default negative integer value
|
||||
*/
|
||||
protected function scopeTyped27(Builder $query, ?float $value = -123)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional float parameter and default positive float value
|
||||
*/
|
||||
protected function scopeTyped28(Builder $query, ?float $value = 1.23)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional float parameter and default negative float value
|
||||
*/
|
||||
protected function scopeTyped29(Builder $query, ?float $value = -1.23)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional float parameter and default null
|
||||
*/
|
||||
protected function scopeTyped30(Builder $query, ?float $value = null)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
}
|
||||
+2
-4
@@ -13,8 +13,6 @@
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithExternalEloquentBuilder\Models{
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property int $id
|
||||
* @property string|null $char_nullable
|
||||
* @property string $char_not_nullable
|
||||
@@ -50,8 +48,8 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWi
|
||||
* @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 numeric|null $decimal_nullable
|
||||
* @property numeric $decimal_not_nullable
|
||||
* @property int|null $boolean_nullable
|
||||
* @property int $boolean_not_nullable
|
||||
* @property string|null $enum_nullable
|
||||
|
||||
+2
-4
@@ -8,8 +8,6 @@ use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithExte
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property int $id
|
||||
* @property string|null $char_nullable
|
||||
* @property string $char_not_nullable
|
||||
@@ -45,8 +43,8 @@ use Illuminate\Database\Eloquent\Model;
|
||||
* @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 numeric|null $decimal_nullable
|
||||
* @property numeric $decimal_not_nullable
|
||||
* @property int|null $boolean_nullable
|
||||
* @property int $boolean_not_nullable
|
||||
* @property string|null $enum_nullable
|
||||
|
||||
+4
-5
@@ -9,8 +9,6 @@ use Illuminate\Database\Eloquent\Relations\HasMany;
|
||||
use Illuminate\Database\Eloquent\SoftDeletes;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property int $id
|
||||
* @property string|null $char_nullable
|
||||
* @property string $char_not_nullable
|
||||
@@ -46,8 +44,8 @@ use Illuminate\Database\Eloquent\SoftDeletes;
|
||||
* @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 numeric|null $decimal_nullable
|
||||
* @property numeric $decimal_not_nullable
|
||||
* @property int|null $boolean_nullable
|
||||
* @property int $boolean_not_nullable
|
||||
* @property string|null $enum_nullable
|
||||
@@ -84,6 +82,7 @@ use Illuminate\Database\Eloquent\SoftDeletes;
|
||||
* @property \Illuminate\Support\Carbon|null $updated_at
|
||||
* @property-read \Illuminate\Database\Eloquent\Collection<int, \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post> $posts
|
||||
* @property-read int|null $posts_count
|
||||
* @property-read bool|null $posts_exists
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post newModelQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post newQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post null(string $unusedParam)
|
||||
@@ -160,7 +159,7 @@ use Illuminate\Database\Eloquent\SoftDeletes;
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post whereUuidNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post whereYearNotNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post whereYearNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post withTrashed()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post withTrashed(bool $withTrashed = true)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post withoutTrashed()
|
||||
* @mixin \Eloquent
|
||||
*/
|
||||
|
||||
@@ -15,8 +15,6 @@ use Illuminate\Database\Query\Builder as QueryBuilder;
|
||||
use Illuminate\Support\Carbon;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property int $id
|
||||
* @property string|null $char_nullable
|
||||
* @property CastType $char_not_nullable
|
||||
@@ -52,8 +50,8 @@ use Illuminate\Support\Carbon;
|
||||
* @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 numeric|null $decimal_nullable
|
||||
* @property numeric $decimal_not_nullable
|
||||
* @property int|null $boolean_nullable
|
||||
* @property int $boolean_not_nullable
|
||||
* @property string|null $enum_nullable
|
||||
@@ -90,6 +88,7 @@ use Illuminate\Support\Carbon;
|
||||
* @property Carbon|null $updated_at
|
||||
* @property-read Collection<int, Post> $posts
|
||||
* @property-read int|null $posts_count
|
||||
* @property-read bool|null $posts_exists
|
||||
* @method static EloquentBuilder<static>|Post newModelQuery()
|
||||
* @method static EloquentBuilder<static>|Post newQuery()
|
||||
* @method static EloquentBuilder<static>|Post null(string $unusedParam)
|
||||
@@ -166,7 +165,7 @@ use Illuminate\Support\Carbon;
|
||||
* @method static EloquentBuilder<static>|Post whereUuidNullable($value)
|
||||
* @method static EloquentBuilder<static>|Post whereYearNotNullable($value)
|
||||
* @method static EloquentBuilder<static>|Post whereYearNullable($value)
|
||||
* @method static EloquentBuilder<static>|Post withTrashed()
|
||||
* @method static EloquentBuilder<static>|Post withTrashed(bool $withTrashed = true)
|
||||
* @method static EloquentBuilder<static>|Post withoutTrashed()
|
||||
* @mixin Eloquent
|
||||
*/
|
||||
|
||||
+2
-4
@@ -13,8 +13,6 @@
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithFqnInExternalFile\Models{
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property int $id
|
||||
* @property string|null $char_nullable
|
||||
* @property string $char_not_nullable
|
||||
@@ -50,8 +48,8 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWi
|
||||
* @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 numeric|null $decimal_nullable
|
||||
* @property numeric $decimal_not_nullable
|
||||
* @property int|null $boolean_nullable
|
||||
* @property int $boolean_not_nullable
|
||||
* @property string|null $enum_nullable
|
||||
|
||||
@@ -45,8 +45,6 @@ class Post extends Model
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithMixin\Models{
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property $someProp
|
||||
* @method someMethod(string $method)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|FinalPost newModelQuery()
|
||||
@@ -60,8 +58,6 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWi
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithMixin\Models{
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property $someProp
|
||||
* @method someMethod(string $method)
|
||||
* @property int $id
|
||||
@@ -99,8 +95,8 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWi
|
||||
* @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 numeric|null $decimal_nullable
|
||||
* @property numeric $decimal_not_nullable
|
||||
* @property int|null $boolean_nullable
|
||||
* @property int $boolean_not_nullable
|
||||
* @property string|null $enum_nullable
|
||||
|
||||
@@ -9,13 +9,13 @@ use Illuminate\Database\Eloquent\Relations\BelongsToMany;
|
||||
use Illuminate\Database\Eloquent\Relations\HasMany;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property int $id
|
||||
* @property-read \Illuminate\Database\Eloquent\Collection|Simple[] $regularBelongsToMany
|
||||
* @property-read int|null $regular_belongs_to_many_count
|
||||
* @property-read bool|null $regular_belongs_to_many_exists
|
||||
* @property-read \Illuminate\Database\Eloquent\Collection|Simple[] $regularHasMany
|
||||
* @property-read int|null $regular_has_many_count
|
||||
* @property-read bool|null $regular_has_many_exists
|
||||
* @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()
|
||||
|
||||
@@ -8,8 +8,6 @@ use DateTime;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property int $id
|
||||
* @property-read int|null $attribute_return_type_int_or_null
|
||||
* @property-read array $attribute_returns_array
|
||||
|
||||
@@ -7,8 +7,6 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Ignored\Models;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|NotIgnored newModelQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|NotIgnored newQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|NotIgnored query()
|
||||
|
||||
@@ -13,8 +13,6 @@
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Interfaces\Models{
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|User newModelQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|User newQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|User query()
|
||||
|
||||
@@ -24,8 +24,6 @@ use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Cas
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts\CastedProperty $casted_property_with_return_type
|
||||
* @property \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts\CastedProperty $casted_property_with_return_docblock
|
||||
* @property \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts\CastedProperty $casted_property_with_return_docblock_fqn
|
||||
|
||||
@@ -7,8 +7,6 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\MagicWhere\Model
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property int $id
|
||||
* @property string|null $char_nullable
|
||||
* @property string $char_not_nullable
|
||||
@@ -44,8 +42,8 @@ use Illuminate\Database\Eloquent\Model;
|
||||
* @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 numeric|null $decimal_nullable
|
||||
* @property numeric $decimal_not_nullable
|
||||
* @property int|null $boolean_nullable
|
||||
* @property int $boolean_not_nullable
|
||||
* @property string|null $enum_nullable
|
||||
|
||||
@@ -9,8 +9,6 @@ use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AbstractModelsCommand;
|
||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\ModelHooks\Hooks\CustomMethod;
|
||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\ModelHooks\Hooks\CustomProperty;
|
||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\ModelHooks\Hooks\UnsetMethod;
|
||||
use Illuminate\Filesystem\Filesystem;
|
||||
use Mockery;
|
||||
|
||||
class Test extends AbstractModelsCommand
|
||||
{
|
||||
@@ -34,24 +32,6 @@ class Test extends AbstractModelsCommand
|
||||
|
||||
public function test(): void
|
||||
{
|
||||
$actualContent = null;
|
||||
|
||||
$mockFilesystem = Mockery::mock(Filesystem::class)->makePartial();
|
||||
$mockFilesystem
|
||||
->shouldReceive('get')
|
||||
->andReturn(file_get_contents(__DIR__ . '/Models/Simple.php'))
|
||||
->once();
|
||||
$mockFilesystem
|
||||
->shouldReceive('put')
|
||||
->with(
|
||||
Mockery::any(),
|
||||
Mockery::capture($actualContent)
|
||||
)
|
||||
->andReturn(1) // Simulate we wrote _something_ to the file
|
||||
->once();
|
||||
|
||||
$this->instance(Filesystem::class, $mockFilesystem);
|
||||
|
||||
$command = $this->app->make(ModelsCommand::class);
|
||||
|
||||
$tester = $this->runCommand($command, [
|
||||
@@ -60,33 +40,6 @@ class Test extends AbstractModelsCommand
|
||||
|
||||
$this->assertSame(0, $tester->getStatusCode());
|
||||
$this->assertStringContainsString('Written new phpDocBlock to', $tester->getDisplay());
|
||||
|
||||
$expectedContent = <<<'PHP'
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\ModelHooks\Models;
|
||||
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property int $id
|
||||
* @property-read string $custom
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple custom($custom)
|
||||
* @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
|
||||
{
|
||||
}
|
||||
|
||||
PHP;
|
||||
|
||||
$this->assertSame($expectedContent, $actualContent);
|
||||
$this->assertMatchesMockedSnapshot();
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,20 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\ModelHooks\Models;
|
||||
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
* @property int $id
|
||||
* @property-read string $custom
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple custom($custom)
|
||||
* @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
|
||||
{
|
||||
}
|
||||
@@ -0,0 +1,11 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\MorphToIntersection\Models;
|
||||
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
abstract class BaseModel extends Model
|
||||
{
|
||||
}
|
||||
@@ -0,0 +1,9 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\MorphToIntersection\Models;
|
||||
|
||||
interface CanBeAssigned
|
||||
{
|
||||
}
|
||||
@@ -0,0 +1,31 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\MorphToIntersection\Models;
|
||||
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
use Illuminate\Database\Eloquent\Relations\MorphTo;
|
||||
|
||||
class MorphToIntersection extends Model
|
||||
{
|
||||
protected $table = 'morphs';
|
||||
|
||||
/** @return MorphTo<(BaseModel&CanBeAssigned), $this> */
|
||||
public function assigneeWithParens(): MorphTo
|
||||
{
|
||||
return $this->morphTo(type: 'nullable_relation_morph_to_type', id: 'nullable_relation_morph_to_id');
|
||||
}
|
||||
|
||||
/** @return MorphTo<BaseModel&CanBeAssigned, $this> */
|
||||
public function assigneeWithoutParens(): MorphTo
|
||||
{
|
||||
return $this->morphTo(type: 'nullable_relation_morph_to_type', id: 'nullable_relation_morph_to_id');
|
||||
}
|
||||
|
||||
/** @return MorphTo<(BaseModel&CanBeAssigned), $this> */
|
||||
public function nonNullableAssignee(): MorphTo
|
||||
{
|
||||
return $this->morphTo(type: 'relation_morph_to_type', id: 'relation_morph_to_id');
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,24 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\MorphToIntersection;
|
||||
|
||||
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
|
||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AbstractModelsCommand;
|
||||
|
||||
class Test extends AbstractModelsCommand
|
||||
{
|
||||
public function test(): void
|
||||
{
|
||||
$command = $this->app->make(ModelsCommand::class);
|
||||
|
||||
$tester = $this->runCommand($command, [
|
||||
'--write' => true,
|
||||
]);
|
||||
|
||||
$this->assertSame(0, $tester->getStatusCode());
|
||||
$this->assertStringContainsString('Written new phpDocBlock to', $tester->getDisplay());
|
||||
$this->assertMatchesMockedSnapshot();
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,48 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\MorphToIntersection\Models;
|
||||
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
use Illuminate\Database\Eloquent\Relations\MorphTo;
|
||||
|
||||
/**
|
||||
* @property string $relation_morph_to_type
|
||||
* @property int $relation_morph_to_id
|
||||
* @property string|null $nullable_relation_morph_to_type
|
||||
* @property int|null $nullable_relation_morph_to_id
|
||||
* @property-read (BaseModel&CanBeAssigned)|null $assigneeWithParens
|
||||
* @property-read (BaseModel&CanBeAssigned)|null $assigneeWithoutParens
|
||||
* @property-read (BaseModel&CanBeAssigned) $nonNullableAssignee
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|MorphToIntersection newModelQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|MorphToIntersection newQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|MorphToIntersection query()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|MorphToIntersection whereNullableRelationMorphToId($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|MorphToIntersection whereNullableRelationMorphToType($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|MorphToIntersection whereRelationMorphToId($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|MorphToIntersection whereRelationMorphToType($value)
|
||||
* @mixin \Eloquent
|
||||
*/
|
||||
class MorphToIntersection extends Model
|
||||
{
|
||||
protected $table = 'morphs';
|
||||
|
||||
/** @return MorphTo<(BaseModel&CanBeAssigned), $this> */
|
||||
public function assigneeWithParens(): MorphTo
|
||||
{
|
||||
return $this->morphTo(type: 'nullable_relation_morph_to_type', id: 'nullable_relation_morph_to_id');
|
||||
}
|
||||
|
||||
/** @return MorphTo<BaseModel&CanBeAssigned, $this> */
|
||||
public function assigneeWithoutParens(): MorphTo
|
||||
{
|
||||
return $this->morphTo(type: 'nullable_relation_morph_to_type', id: 'nullable_relation_morph_to_id');
|
||||
}
|
||||
|
||||
/** @return MorphTo<(BaseModel&CanBeAssigned), $this> */
|
||||
public function nonNullableAssignee(): MorphTo
|
||||
{
|
||||
return $this->morphTo(type: 'relation_morph_to_type', id: 'relation_morph_to_id');
|
||||
}
|
||||
}
|
||||
@@ -8,8 +8,6 @@ use Illuminate\Database\Eloquent\Model;
|
||||
use Illuminate\Database\Eloquent\Relations\MorphTo;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property string $relation_morph_to_type
|
||||
* @property int $relation_morph_to_id
|
||||
* @property string|null $nullable_relation_morph_to_type
|
||||
|
||||
-2
@@ -7,8 +7,6 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\PHPStormNoInspec
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property int $id
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple newModelQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple newQuery()
|
||||
|
||||
-2
@@ -7,8 +7,6 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\PHPStormNoInspec
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property int $id
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple newModelQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple newQuery()
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\PhpAttributesBeforeClass\Models;
|
||||
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
// Tests: final class + attribute with nested array argument (e.g. ObservedBy([...]))
|
||||
#[ObservedByStub([StubObserver::class])]
|
||||
final class FinalWithNested extends Model
|
||||
{
|
||||
protected $table = 'simples';
|
||||
}
|
||||
@@ -0,0 +1,15 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\PhpAttributesBeforeClass\Models;
|
||||
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
// Tests: multiple consecutive PHP 8 attributes before the class declaration
|
||||
#[\AllowDynamicProperties]
|
||||
#[SecondAttribute]
|
||||
class MultipleAttributes extends Model
|
||||
{
|
||||
protected $table = 'simples';
|
||||
}
|
||||
@@ -0,0 +1,12 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\PhpAttributesBeforeClass\Models;
|
||||
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
#[\AllowDynamicProperties]
|
||||
class Simple extends Model
|
||||
{
|
||||
}
|
||||
@@ -0,0 +1,24 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\PhpAttributesBeforeClass;
|
||||
|
||||
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
|
||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AbstractModelsCommand;
|
||||
|
||||
class Test extends AbstractModelsCommand
|
||||
{
|
||||
public function test(): void
|
||||
{
|
||||
$command = $this->app->make(ModelsCommand::class);
|
||||
|
||||
$tester = $this->runCommand($command, [
|
||||
'--write' => true,
|
||||
]);
|
||||
|
||||
$this->assertSame(0, $tester->getStatusCode());
|
||||
$this->assertStringContainsString('Written new phpDocBlock to', $tester->getDisplay());
|
||||
$this->assertMatchesMockedSnapshot();
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,65 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\PhpAttributesBeforeClass\Models;
|
||||
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
// Tests: final class + attribute with nested array argument (e.g. ObservedBy([...]))
|
||||
/**
|
||||
* @property int $id
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|FinalWithNested newModelQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|FinalWithNested newQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|FinalWithNested query()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|FinalWithNested whereId($value)
|
||||
* @mixin \Eloquent
|
||||
*/
|
||||
#[ObservedByStub([StubObserver::class])]
|
||||
final class FinalWithNested extends Model
|
||||
{
|
||||
protected $table = 'simples';
|
||||
}
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\PhpAttributesBeforeClass\Models;
|
||||
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
// Tests: multiple consecutive PHP 8 attributes before the class declaration
|
||||
/**
|
||||
* @property int $id
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|MultipleAttributes newModelQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|MultipleAttributes newQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|MultipleAttributes query()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|MultipleAttributes whereId($value)
|
||||
* @mixin \Eloquent
|
||||
*/
|
||||
#[\AllowDynamicProperties]
|
||||
#[SecondAttribute]
|
||||
class MultipleAttributes extends Model
|
||||
{
|
||||
protected $table = 'simples';
|
||||
}
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\PhpAttributesBeforeClass\Models;
|
||||
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
* @property int $id
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple newModelQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple newQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple query()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple whereId($value)
|
||||
* @mixin \Eloquent
|
||||
*/
|
||||
#[\AllowDynamicProperties]
|
||||
class Simple extends Model
|
||||
{
|
||||
}
|
||||
@@ -9,21 +9,24 @@ use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Pivot\Models\Pivots\Di
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property-read DifferentCustomPivot|CustomPivot|null $pivot
|
||||
* @property-read \Illuminate\Database\Eloquent\Collection<int, ModelWithPivot> $relationCustomPivotUsingSameAccessor
|
||||
* @property-read int|null $relation_custom_pivot_using_same_accessor_count
|
||||
* @property-read bool|null $relation_custom_pivot_using_same_accessor_exists
|
||||
* @property-read \Illuminate\Database\Eloquent\Collection<int, ModelWithPivot> $relationCustomPivotUsingSameAccessorAndClass
|
||||
* @property-read int|null $relation_custom_pivot_using_same_accessor_and_class_count
|
||||
* @property-read bool|null $relation_custom_pivot_using_same_accessor_and_class_exists
|
||||
* @property-read CustomPivot|null $customAccessor
|
||||
* @property-read \Illuminate\Database\Eloquent\Collection<int, ModelWithPivot> $relationWithCustomPivot
|
||||
* @property-read int|null $relation_with_custom_pivot_count
|
||||
* @property-read bool|null $relation_with_custom_pivot_exists
|
||||
* @property-read DifferentCustomPivot|null $differentCustomAccessor
|
||||
* @property-read \Illuminate\Database\Eloquent\Collection<int, ModelWithPivot> $relationWithDifferentCustomPivot
|
||||
* @property-read int|null $relation_with_different_custom_pivot_count
|
||||
* @property-read bool|null $relation_with_different_custom_pivot_exists
|
||||
* @property-read \Illuminate\Database\Eloquent\Collection<int, ModelWithPivot> $relationWithDifferentCustomPivotUsingSameAccessor
|
||||
* @property-read int|null $relation_with_different_custom_pivot_using_same_accessor_count
|
||||
* @property-read bool|null $relation_with_different_custom_pivot_using_same_accessor_exists
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|ModelWithPivot newModelQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|ModelWithPivot newQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|ModelWithPivot query()
|
||||
@@ -75,8 +78,6 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Pivot\Models\Piv
|
||||
use Illuminate\Database\Eloquent\Relations\Pivot;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|CustomPivot newModelQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|CustomPivot newQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|CustomPivot query()
|
||||
@@ -94,8 +95,6 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Pivot\Models\Piv
|
||||
use Illuminate\Database\Eloquent\Relations\Pivot;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|DifferentCustomPivot newModelQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|DifferentCustomPivot newQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|DifferentCustomPivot query()
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\QueryMethods\Models;
|
||||
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
class Post extends Model
|
||||
{
|
||||
}
|
||||
@@ -0,0 +1,32 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\QueryMethods;
|
||||
|
||||
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
|
||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AbstractModelsCommand;
|
||||
|
||||
class Test extends AbstractModelsCommand
|
||||
{
|
||||
protected function getEnvironmentSetUp($app)
|
||||
{
|
||||
parent::getEnvironmentSetUp($app);
|
||||
|
||||
$app['config']->set('ide-helper.write_query_methods', false);
|
||||
}
|
||||
|
||||
public function test(): void
|
||||
{
|
||||
$command = $this->app->make(ModelsCommand::class);
|
||||
|
||||
$tester = $this->runCommand($command, [
|
||||
'--write' => true,
|
||||
]);
|
||||
|
||||
$this->assertSame(0, $tester->getStatusCode());
|
||||
$this->assertStringContainsString('Written new phpDocBlock to', $tester->getDisplay());
|
||||
$this->assertMatchesMockedSnapshot();
|
||||
$this->assertStringNotContainsString("@method static \Illuminate\Database\Eloquent\Builder<static>|Post query()", $this->mockFilesystemOutput);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,156 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\QueryMethods\Models;
|
||||
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
* @property int $id
|
||||
* @property string|null $char_nullable
|
||||
* @property string $char_not_nullable
|
||||
* @property string|null $string_nullable
|
||||
* @property string $string_not_nullable
|
||||
* @property string|null $text_nullable
|
||||
* @property string $text_not_nullable
|
||||
* @property string|null $medium_text_nullable
|
||||
* @property string $medium_text_not_nullable
|
||||
* @property string|null $long_text_nullable
|
||||
* @property string $long_text_not_nullable
|
||||
* @property int|null $integer_nullable
|
||||
* @property int $integer_not_nullable
|
||||
* @property int|null $tiny_integer_nullable
|
||||
* @property int $tiny_integer_not_nullable
|
||||
* @property int|null $small_integer_nullable
|
||||
* @property int $small_integer_not_nullable
|
||||
* @property int|null $medium_integer_nullable
|
||||
* @property int $medium_integer_not_nullable
|
||||
* @property int|null $big_integer_nullable
|
||||
* @property int $big_integer_not_nullable
|
||||
* @property int|null $unsigned_integer_nullable
|
||||
* @property int $unsigned_integer_not_nullable
|
||||
* @property int|null $unsigned_tiny_integer_nullable
|
||||
* @property int $unsigned_tiny_integer_not_nullable
|
||||
* @property int|null $unsigned_small_integer_nullable
|
||||
* @property int $unsigned_small_integer_not_nullable
|
||||
* @property int|null $unsigned_medium_integer_nullable
|
||||
* @property int $unsigned_medium_integer_not_nullable
|
||||
* @property int|null $unsigned_big_integer_nullable
|
||||
* @property int $unsigned_big_integer_not_nullable
|
||||
* @property float|null $float_nullable
|
||||
* @property float $float_not_nullable
|
||||
* @property float|null $double_nullable
|
||||
* @property float $double_not_nullable
|
||||
* @property numeric|null $decimal_nullable
|
||||
* @property numeric $decimal_not_nullable
|
||||
* @property int|null $boolean_nullable
|
||||
* @property int $boolean_not_nullable
|
||||
* @property string|null $enum_nullable
|
||||
* @property string $enum_not_nullable
|
||||
* @property string|null $json_nullable
|
||||
* @property string $json_not_nullable
|
||||
* @property string|null $jsonb_nullable
|
||||
* @property string $jsonb_not_nullable
|
||||
* @property string|null $date_nullable
|
||||
* @property string $date_not_nullable
|
||||
* @property string|null $datetime_nullable
|
||||
* @property string $datetime_not_nullable
|
||||
* @property string|null $datetimetz_nullable
|
||||
* @property string $datetimetz_not_nullable
|
||||
* @property string|null $time_nullable
|
||||
* @property string $time_not_nullable
|
||||
* @property string|null $timetz_nullable
|
||||
* @property string $timetz_not_nullable
|
||||
* @property string|null $timestamp_nullable
|
||||
* @property string $timestamp_not_nullable
|
||||
* @property string|null $timestamptz_nullable
|
||||
* @property string $timestamptz_not_nullable
|
||||
* @property int|null $year_nullable
|
||||
* @property int $year_not_nullable
|
||||
* @property string|null $binary_nullable
|
||||
* @property string $binary_not_nullable
|
||||
* @property string|null $uuid_nullable
|
||||
* @property string $uuid_not_nullable
|
||||
* @property string|null $ipaddress_nullable
|
||||
* @property string $ipaddress_not_nullable
|
||||
* @property string|null $macaddress_nullable
|
||||
* @property string $macaddress_not_nullable
|
||||
* @property \Illuminate\Support\Carbon|null $created_at
|
||||
* @property \Illuminate\Support\Carbon|null $updated_at
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereBigIntegerNotNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereBigIntegerNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereBinaryNotNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereBinaryNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereBooleanNotNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereBooleanNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereCharNotNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereCharNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereCreatedAt($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDateNotNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDateNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDatetimeNotNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDatetimeNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDatetimetzNotNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDatetimetzNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDecimalNotNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDecimalNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDoubleNotNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDoubleNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereEnumNotNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereEnumNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereFloatNotNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereFloatNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereId($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereIntegerNotNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereIntegerNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereIpaddressNotNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereIpaddressNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereJsonNotNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereJsonNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereJsonbNotNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereJsonbNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereLongTextNotNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereLongTextNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereMacaddressNotNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereMacaddressNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereMediumIntegerNotNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereMediumIntegerNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereMediumTextNotNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereMediumTextNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereSmallIntegerNotNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereSmallIntegerNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereStringNotNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereStringNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTextNotNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTextNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTimeNotNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTimeNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTimestampNotNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTimestampNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTimestamptzNotNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTimestamptzNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTimetzNotNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTimetzNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTinyIntegerNotNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTinyIntegerNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedBigIntegerNotNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedBigIntegerNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedIntegerNotNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedIntegerNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedMediumIntegerNotNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedMediumIntegerNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedSmallIntegerNotNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedSmallIntegerNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedTinyIntegerNotNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedTinyIntegerNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUpdatedAt($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUuidNotNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUuidNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereYearNotNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereYearNullable($value)
|
||||
* @mixin \Eloquent
|
||||
*/
|
||||
class Post extends Model
|
||||
{
|
||||
}
|
||||
@@ -0,0 +1,33 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\QueryScopes\Models;
|
||||
|
||||
use Illuminate\Database\Eloquent\Attributes\Scope;
|
||||
use Illuminate\Database\Eloquent\Builder;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
class Comment extends Model
|
||||
{
|
||||
/**
|
||||
* @comment Scope using the 'Scope' attribute
|
||||
* @param Builder $query
|
||||
* @return void
|
||||
*/
|
||||
#[Scope]
|
||||
protected function local(Builder $query): void
|
||||
{
|
||||
$query->where('ip_address', '127.0.0.1');
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope using the 'scope' prefix
|
||||
* @param Builder $query
|
||||
* @return void
|
||||
*/
|
||||
protected function scopeSystem(Builder $query): void
|
||||
{
|
||||
$query->where('system', true);
|
||||
}
|
||||
}
|
||||
@@ -4,9 +4,48 @@ declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\QueryScopes\Models;
|
||||
|
||||
use Illuminate\Database\Eloquent\Attributes\Scope;
|
||||
use Illuminate\Database\Eloquent\Builder;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
* @method static Builder<static>|Comment local() Scope using the 'Scope' attribute
|
||||
* @method static Builder<static>|Comment newModelQuery()
|
||||
* @method static Builder<static>|Comment newQuery()
|
||||
* @method static Builder<static>|Comment query()
|
||||
* @method static Builder<static>|Comment system() Scope using the 'scope' prefix
|
||||
* @mixin \Eloquent
|
||||
*/
|
||||
class Comment extends Model
|
||||
{
|
||||
/**
|
||||
* @comment Scope using the 'Scope' attribute
|
||||
* @param Builder $query
|
||||
* @return void
|
||||
*/
|
||||
#[Scope]
|
||||
protected function local(Builder $query): void
|
||||
{
|
||||
$query->where('ip_address', '127.0.0.1');
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope using the 'scope' prefix
|
||||
* @param Builder $query
|
||||
* @return void
|
||||
*/
|
||||
protected function scopeSystem(Builder $query): void
|
||||
{
|
||||
$query->where('system', true);
|
||||
}
|
||||
}
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\QueryScopes\Models;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property int $id
|
||||
* @property string|null $char_nullable
|
||||
* @property string $char_not_nullable
|
||||
@@ -42,8 +81,8 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\QueryScopes\Mode
|
||||
* @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 numeric|null $decimal_nullable
|
||||
* @property numeric $decimal_not_nullable
|
||||
* @property int|null $boolean_nullable
|
||||
* @property int $boolean_not_nullable
|
||||
* @property string|null $enum_nullable
|
||||
@@ -172,8 +211,6 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\QueryScopes\Mode
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|PostParent active()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|PostParent newModelQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|PostParent newQuery()
|
||||
|
||||
@@ -14,6 +14,7 @@ class Test extends AbstractModelsCommand
|
||||
parent::getEnvironmentSetUp($app);
|
||||
|
||||
$app['config']->set('ide-helper.write_model_relation_count_properties', false);
|
||||
$app['config']->set('ide-helper.write_model_relation_exists_properties', false);
|
||||
}
|
||||
|
||||
public function test(): void
|
||||
|
||||
@@ -8,8 +8,6 @@ use Illuminate\Database\Eloquent\Model;
|
||||
use Illuminate\Database\Eloquent\Relations\HasMany;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property int $id
|
||||
* @property string|null $char_nullable
|
||||
* @property string $char_not_nullable
|
||||
@@ -45,8 +43,8 @@ use Illuminate\Database\Eloquent\Relations\HasMany;
|
||||
* @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 numeric|null $decimal_nullable
|
||||
* @property numeric $decimal_not_nullable
|
||||
* @property int|null $boolean_nullable
|
||||
* @property int $boolean_not_nullable
|
||||
* @property string|null $enum_nullable
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user