mirror of
https://github.com/barryvdh/laravel-ide-helper.git
synced 2026-08-18 01:57:13 +00:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
dca3ebe81e | ||
|
|
c119e89cf0 | ||
|
|
bc158a1b86 | ||
|
|
341c0ab89f | ||
|
|
cee441c87c | ||
|
|
9343d3a1cc | ||
|
|
f12d933ab1 | ||
|
|
4751420c9e | ||
|
|
6115100a0f | ||
|
|
5c886fb653 | ||
|
|
7d69dc6ea0 | ||
|
|
62fc436c4c | ||
|
|
409bbf665b | ||
|
|
2535f8e6ab | ||
|
|
16548fc878 | ||
|
|
872b470d9b | ||
|
|
04c1a8d444 | ||
|
|
c290af858d | ||
|
|
f64ff9c0b1 | ||
|
|
f3ad134242 | ||
|
|
9d14b019f6 | ||
|
|
f4656256fc | ||
|
|
cc9ed4423b | ||
|
|
512612f22f | ||
|
|
115068e57b | ||
|
|
a8b34ad228 | ||
|
|
485c756f6c | ||
|
|
cf4687f98c | ||
|
|
e65d30b27a | ||
|
|
416e0ab243 | ||
|
|
9374952402 | ||
|
|
850fc5fe7f | ||
|
|
726e595578 | ||
|
|
6336db0548 | ||
|
|
21352a1e48 | ||
|
|
390874207f | ||
|
|
3cdd3af631 | ||
|
|
c751d3e176 | ||
|
|
1a3affd4f8 | ||
|
|
0801d002e4 | ||
|
|
edc422cd2e | ||
|
|
4dc20b028a | ||
|
|
39885645b9 | ||
|
|
aa1aa66ee6 | ||
|
|
b70a9f5048 | ||
|
|
9f97f7cd5f | ||
|
|
97fd0e0a2d | ||
|
|
9f5670b7e9 | ||
|
|
1d302435ef | ||
|
|
81d5b223ff | ||
|
|
ce24d4b013 | ||
|
|
edfb05621c | ||
|
|
f0e4cf5e78 | ||
|
|
5d9925bab8 | ||
|
|
9e50460017 | ||
|
|
b55769213c | ||
|
|
f055d42b39 | ||
|
|
dda200fd34 | ||
|
|
e8ecb3da88 | ||
|
|
e49c4556dd | ||
|
|
2c96c45d5e | ||
|
|
532ae5bec3 | ||
|
|
c8f0f914e3 | ||
|
|
07f5eaea73 | ||
|
|
c76fbb5b61 | ||
|
|
c40fee2a3f | ||
|
|
5eadd2c7de | ||
|
|
6e26f22c76 | ||
|
|
ee9188acf1 | ||
|
|
a567f73140 | ||
|
|
6a461a7c47 | ||
|
|
3ba1e2573b | ||
|
|
6b58c23e6f | ||
|
|
6041681495 | ||
|
|
ddb74fb5c8 | ||
|
|
7917cce7c9 | ||
|
|
6627cb9587 | ||
|
|
3b03e4055d | ||
|
|
a227fca325 | ||
|
|
999167d4c2 | ||
|
|
2673bf4889 | ||
|
|
771770e56c | ||
|
|
88353535f2 | ||
|
|
acb2df9dfb | ||
|
|
7052b4f708 | ||
|
|
ac1e27167d | ||
|
|
de64d665e0 | ||
|
|
93d987336b | ||
|
|
744a9cf380 | ||
|
|
f2a7f9d84f | ||
|
|
29dd57e1e2 | ||
|
|
6244a931a0 | ||
|
|
ebea96213d | ||
|
|
01be015f86 | ||
|
|
a091b9c94a | ||
|
|
dd12b7cdcb | ||
|
|
ae48e1e467 | ||
|
|
c733bde1ea | ||
|
|
52a4b64656 | ||
|
|
b268871c16 | ||
|
|
2fc239623b | ||
|
|
37f08320ea | ||
|
|
b6871d09a4 | ||
|
|
3b75048d12 | ||
|
|
b162347aff | ||
|
|
f4e0fc3695 | ||
|
|
af84c78dec | ||
|
|
e71f3d5fc0 | ||
|
|
df670747c3 | ||
|
|
3a4eee9487 | ||
|
|
eb8c5729ae | ||
|
|
dc5282e9a4 | ||
|
|
c82529babd | ||
|
|
7cf8a51a8b | ||
|
|
73b1012b92 | ||
|
|
ca94ffd99a | ||
|
|
c1ddd30532 | ||
|
|
dcbe6c953f | ||
|
|
867a6fd9b4 | ||
|
|
39a96c3b95 | ||
|
|
057efb0ee7 | ||
|
|
1010cdbd26 | ||
|
|
2f61602e7a | ||
|
|
9fe65e7ed3 | ||
|
|
16a4297992 | ||
|
|
c8ebf563a0 | ||
|
|
843067b907 | ||
|
|
f0f7051012 | ||
|
|
e1af93f43b | ||
|
|
b19b1d69ba | ||
|
|
92d7f2e706 | ||
|
|
f0c138c4fd | ||
|
|
b8d5fc3663 | ||
|
|
df994eb767 | ||
|
|
0cae143470 | ||
|
|
c2dec69d64 | ||
|
|
dedd69e8b4 | ||
|
|
40c02c524d | ||
|
|
04c1139223 | ||
|
|
172e430c12 | ||
|
|
244e936b74 | ||
|
|
f7f7e9e65a | ||
|
|
1a813703fe | ||
|
|
d58731cd9b | ||
|
|
b246d9ab23 | ||
|
|
8d8302ff6a | ||
|
|
202395b50f | ||
|
|
c5c9b2b951 | ||
|
|
c5e18beff1 | ||
|
|
6c4dcd9049 | ||
|
|
aaade4eab9 | ||
|
|
b21324b20e | ||
|
|
db83fb8b6b | ||
|
|
4f42af1fa1 | ||
|
|
f0959c1184 | ||
|
|
73c502d5c5 | ||
|
|
3376522d68 | ||
|
|
a83df51ad4 | ||
|
|
fd30d1190d | ||
|
|
4f13ba85bd | ||
|
|
0fee1c47d3 | ||
|
|
64a6b90258 | ||
|
|
25cc68c75f | ||
|
|
36c4406b3a | ||
|
|
9ba2f5c557 |
@@ -5,5 +5,11 @@
|
|||||||
/.gitattributes export-ignore
|
/.gitattributes export-ignore
|
||||||
/.github export-ignore
|
/.github export-ignore
|
||||||
/.gitignore export-ignore
|
/.gitignore export-ignore
|
||||||
|
/.editorconfig export-ignore
|
||||||
/phpunit.xml.dist export-ignore
|
/phpunit.xml.dist export-ignore
|
||||||
/tests export-ignore
|
/tests export-ignore
|
||||||
|
/.php_cs.common.php export-ignore
|
||||||
|
/.php_cs.dist export-ignore
|
||||||
|
/.php_cs.tests.php export-ignore
|
||||||
|
/psalm.xml export-ignore
|
||||||
|
/psalm-baseline.xml export-ignore
|
||||||
|
|||||||
+2
-9
@@ -1,12 +1,5 @@
|
|||||||
# These are supported funding model platforms
|
# These are supported funding model platforms
|
||||||
|
|
||||||
github: barryvdh
|
github: barryvdh
|
||||||
patreon: # Replace with a single Patreon username
|
custom: ['https://fruitcake.nl']
|
||||||
open_collective: # Replace with a single Open Collective username
|
|
||||||
ko_fi: # Replace with a single Ko-fi username
|
|
||||||
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
|
|
||||||
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
|
|
||||||
liberapay: # Replace with a single Liberapay username
|
|
||||||
issuehunt: # Replace with a single IssueHunt username
|
|
||||||
otechie: # Replace with a single Otechie username
|
|
||||||
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
|
|
||||||
|
|||||||
@@ -8,7 +8,6 @@ labels: bug
|
|||||||
### Versions:
|
### Versions:
|
||||||
- ide-helper Version: #.#.#
|
- ide-helper Version: #.#.#
|
||||||
- Laravel Version: #.#.# <!-- remove if not applicable -->
|
- Laravel Version: #.#.# <!-- remove if not applicable -->
|
||||||
- Lumen Version: #.#.# <!-- remove if not applicable -->
|
|
||||||
- PHP Version: #.#.#
|
- PHP Version: #.#.#
|
||||||
|
|
||||||
### Description:
|
### Description:
|
||||||
|
|||||||
@@ -8,7 +8,6 @@ labels: question
|
|||||||
### Versions:
|
### Versions:
|
||||||
- ide-helper Version: #.#.#
|
- ide-helper Version: #.#.#
|
||||||
- Laravel Version: #.#.# <!-- remove if not applicable -->
|
- Laravel Version: #.#.# <!-- remove if not applicable -->
|
||||||
- Lumen Version: #.#.# <!-- remove if not applicable -->
|
|
||||||
- PHP Version: #.#.#
|
- PHP Version: #.#.#
|
||||||
|
|
||||||
### Question:
|
### Question:
|
||||||
|
|||||||
@@ -0,0 +1,10 @@
|
|||||||
|
version: 2
|
||||||
|
updates:
|
||||||
|
- package-ecosystem: github-actions
|
||||||
|
directory: /
|
||||||
|
schedule:
|
||||||
|
interval: monthly
|
||||||
|
groups:
|
||||||
|
deps:
|
||||||
|
patterns:
|
||||||
|
- '*'
|
||||||
@@ -3,6 +3,7 @@ name: normalize composer.json
|
|||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
paths:
|
paths:
|
||||||
|
- .github/workflows/composer-normalize.yml
|
||||||
- composer.json
|
- composer.json
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
@@ -11,16 +12,17 @@ jobs:
|
|||||||
runs-on: ubuntu-20.04
|
runs-on: ubuntu-20.04
|
||||||
steps:
|
steps:
|
||||||
- name: Git checkout
|
- name: Git checkout
|
||||||
uses: actions/checkout@v2
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
- name: Validate Composer configuration
|
- name: Validate Composer configuration
|
||||||
run: composer validate --strict
|
run: composer validate --strict
|
||||||
|
|
||||||
- name: Normalize composer.json
|
- name: Normalize composer.json
|
||||||
run: |
|
run: |
|
||||||
|
composer global config --no-plugins allow-plugins.ergebnis/composer-normalize true
|
||||||
composer global require ergebnis/composer-normalize
|
composer global require ergebnis/composer-normalize
|
||||||
composer normalize
|
composer normalize
|
||||||
|
|
||||||
- uses: stefanzweifel/git-auto-commit-action@v4.0.0
|
- uses: stefanzweifel/git-auto-commit-action@v5
|
||||||
with:
|
with:
|
||||||
commit_message: normalize composer.json
|
commit_message: normalize composer.json
|
||||||
|
|||||||
@@ -13,12 +13,12 @@ jobs:
|
|||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout code
|
- name: Checkout code
|
||||||
uses: actions/checkout@v2
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
- name: Setup PHP
|
- name: Setup PHP
|
||||||
uses: shivammathur/setup-php@v2
|
uses: shivammathur/setup-php@v2
|
||||||
with:
|
with:
|
||||||
php-version: 7.4
|
php-version: 8.0
|
||||||
coverage: none
|
coverage: none
|
||||||
|
|
||||||
- name: Install dependencies
|
- name: Install dependencies
|
||||||
@@ -27,7 +27,7 @@ jobs:
|
|||||||
- run: composer fix-style
|
- run: composer fix-style
|
||||||
continue-on-error: true
|
continue-on-error: true
|
||||||
|
|
||||||
- uses: stefanzweifel/git-auto-commit-action@v4
|
- uses: stefanzweifel/git-auto-commit-action@v5
|
||||||
with:
|
with:
|
||||||
commit_message: composer fix-style
|
commit_message: composer fix-style
|
||||||
commit_author: laravel-ide-helper <[email protected]>
|
commit_author: laravel-ide-helper <[email protected]>
|
||||||
|
|||||||
@@ -11,86 +11,25 @@ on:
|
|||||||
- cron: '0 0 * * *'
|
- cron: '0 0 * * *'
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
php-lumen-integration-tests:
|
|
||||||
runs-on: ubuntu-20.04
|
|
||||||
timeout-minutes: 15
|
|
||||||
env:
|
|
||||||
COMPOSER_NO_INTERACTION: 1
|
|
||||||
strategy:
|
|
||||||
matrix:
|
|
||||||
php: [8.0, 7.4, 7.3, 7.2]
|
|
||||||
lumen: [8.*, 7.*, 6.*]
|
|
||||||
exclude:
|
|
||||||
- lumen: 6.*
|
|
||||||
php: 8.0
|
|
||||||
- lumen: 7.*
|
|
||||||
php: 8.0
|
|
||||||
- lumen: 8.*
|
|
||||||
php: 7.2
|
|
||||||
name: P${{ matrix.php }} - Lumen${{ matrix.lumen }}
|
|
||||||
steps:
|
|
||||||
- name: Checkout code
|
|
||||||
uses: actions/checkout@v2
|
|
||||||
with:
|
|
||||||
path: src
|
|
||||||
|
|
||||||
- name: Setup PHP
|
|
||||||
uses: shivammathur/setup-php@v2
|
|
||||||
with:
|
|
||||||
php-version: ${{ matrix.php }}
|
|
||||||
coverage: none
|
|
||||||
|
|
||||||
- name: Install dependencies
|
|
||||||
run: |
|
|
||||||
composer create-project --prefer-dist laravel/lumen:${{ matrix.lumen }} --no-progress sample
|
|
||||||
cd sample
|
|
||||||
composer require "league/flysystem:^1" --no-update --no-progress
|
|
||||||
composer update --prefer-stable --prefer-dist --no-progress
|
|
||||||
|
|
||||||
- name: Add package from source
|
|
||||||
run: |
|
|
||||||
cd sample
|
|
||||||
sed -e 's|"type": "project",|&\n"repositories": [ { "type": "path", "url": "../src" } ],|' -i composer.json
|
|
||||||
composer require --dev "barryvdh/laravel-ide-helper:*"
|
|
||||||
|
|
||||||
- name: Insert service provider
|
|
||||||
run: sed -e 's|// \$app->register(App\\\Providers\\\EventServiceProvider::class);|&\n$app->register(\\Barryvdh\\LaravelIdeHelper\\IdeHelperServiceProvider::class);|' -i sample/bootstrap/app.php
|
|
||||||
|
|
||||||
- name: Execute generate run
|
|
||||||
run: |
|
|
||||||
cd sample
|
|
||||||
php artisan ide-helper:generate
|
|
||||||
|
|
||||||
- name: Execute meta run
|
|
||||||
run: |
|
|
||||||
cd sample
|
|
||||||
php artisan ide-helper:meta
|
|
||||||
|
|
||||||
- name: Check file existence
|
|
||||||
run: |
|
|
||||||
ls sample/_ide_helper.php
|
|
||||||
ls sample/.phpstorm.meta.php
|
|
||||||
|
|
||||||
- name: Check file count in logs
|
|
||||||
run: |
|
|
||||||
if [ `ls -1q "sample/storage/logs/" | wc -l` -gt 0 ];then exit 1;fi
|
|
||||||
|
|
||||||
php-laravel-integration-tests:
|
php-laravel-integration-tests:
|
||||||
runs-on: ubuntu-20.04
|
runs-on: ubuntu-20.04
|
||||||
timeout-minutes: 15
|
timeout-minutes: 15
|
||||||
env:
|
env:
|
||||||
COMPOSER_NO_INTERACTION: 1
|
COMPOSER_NO_INTERACTION: 1
|
||||||
strategy:
|
strategy:
|
||||||
|
fail-fast: false
|
||||||
matrix:
|
matrix:
|
||||||
php: [7.4, 7.3, 7.2]
|
php: [8.3, 8.2, 8.1, 8.0]
|
||||||
laravel: [8.*, 7.*, 6.*]
|
laravel: [10.*, 9.*]
|
||||||
exclude:
|
exclude:
|
||||||
- laravel: 8.*
|
- php: 8.0
|
||||||
php: 7.2
|
laravel: 10.*
|
||||||
|
- php: 8.3
|
||||||
|
laravel: 9.*
|
||||||
name: P${{ matrix.php }} - Laravel${{ matrix.laravel }}
|
name: P${{ matrix.php }} - Laravel${{ matrix.laravel }}
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout code
|
- name: Checkout code
|
||||||
uses: actions/checkout@v2
|
uses: actions/checkout@v4
|
||||||
with:
|
with:
|
||||||
path: src
|
path: src
|
||||||
|
|
||||||
@@ -102,15 +41,16 @@ jobs:
|
|||||||
|
|
||||||
- name: Install dependencies
|
- name: Install dependencies
|
||||||
run: |
|
run: |
|
||||||
composer create-project --prefer-dist laravel/laravel:${{ matrix.laravel }} --no-progress sample
|
composer create-project --prefer-dist laravel/laravel:${{ matrix.laravel }} --stability=dev --no-progress sample
|
||||||
cd sample
|
cd sample
|
||||||
|
composer config minimum-stability dev
|
||||||
composer update --prefer-stable --prefer-dist --no-progress
|
composer update --prefer-stable --prefer-dist --no-progress
|
||||||
|
|
||||||
- name: Add package from source
|
- name: Add package from source
|
||||||
run: |
|
run: |
|
||||||
cd sample
|
cd sample
|
||||||
sed -e 's|"type": "project",|&\n"repositories": [ { "type": "path", "url": "../src" } ],|' -i composer.json
|
sed -e 's|"type": "project",|&\n"repositories": [ { "type": "path", "url": "../src" } ],|' -i composer.json
|
||||||
composer require --dev "barryvdh/laravel-ide-helper:*"
|
composer require --dev "barryvdh/laravel-ide-helper:*" --with-all-dependencies
|
||||||
|
|
||||||
- name: Execute generate run
|
- name: Execute generate run
|
||||||
run: |
|
run: |
|
||||||
@@ -120,13 +60,20 @@ jobs:
|
|||||||
- name: Execute meta run
|
- name: Execute meta run
|
||||||
run: |
|
run: |
|
||||||
cd sample
|
cd sample
|
||||||
php artisan ide-helper:meta
|
php artisan ide-helper:meta -v
|
||||||
|
|
||||||
- name: Check file existence
|
- name: Check file existence
|
||||||
run: |
|
run: |
|
||||||
ls sample/_ide_helper.php
|
ls sample/_ide_helper.php
|
||||||
ls sample/.phpstorm.meta.php
|
ls sample/.phpstorm.meta.php
|
||||||
|
|
||||||
- name: Check file count in logs
|
|
||||||
|
- name: Check logs
|
||||||
run: |
|
run: |
|
||||||
if [ `ls -1q "sample/storage/logs/" | wc -l` -gt 0 ];then exit 1;fi
|
if [ `ls -1q "sample/storage/logs/" | wc -l` -gt 0 ]; then
|
||||||
|
for logfile in sample/storage/logs/*; do
|
||||||
|
echo "-- $logfile --"
|
||||||
|
cat $logfile
|
||||||
|
done
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|||||||
@@ -12,7 +12,14 @@ jobs:
|
|||||||
runs-on: ubuntu-20.04
|
runs-on: ubuntu-20.04
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v2
|
- uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: Setup PHP
|
||||||
|
uses: shivammathur/setup-php@v2
|
||||||
|
with:
|
||||||
|
php-version: 8.1
|
||||||
|
coverage: none
|
||||||
|
extensions: pdo_sqlite
|
||||||
|
|
||||||
- name: Install dependencies
|
- name: Install dependencies
|
||||||
run: composer install --prefer-dist --no-progress --no-suggest
|
run: composer install --prefer-dist --no-progress --no-suggest
|
||||||
|
|||||||
@@ -12,41 +12,45 @@ on:
|
|||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
php-tests:
|
php-tests:
|
||||||
runs-on: ubuntu-20.04
|
runs-on: ${{ matrix.os }}
|
||||||
timeout-minutes: 15
|
timeout-minutes: 15
|
||||||
env:
|
env:
|
||||||
COMPOSER_NO_INTERACTION: 1
|
COMPOSER_NO_INTERACTION: 1
|
||||||
|
|
||||||
strategy:
|
strategy:
|
||||||
matrix:
|
matrix:
|
||||||
php: [8.0, 7.4, 7.3, 7.2]
|
os: [ubuntu-20.04, windows-2019]
|
||||||
laravel: [8.*, 7.*, 6.*]
|
php: [8.3, 8.2, 8.1, 8.0]
|
||||||
|
laravel: [9.*, 10.*]
|
||||||
dependency-version: [prefer-lowest, prefer-stable]
|
dependency-version: [prefer-lowest, prefer-stable]
|
||||||
exclude:
|
exclude:
|
||||||
- laravel: 8.*
|
- php: 8.0
|
||||||
php: 7.2
|
laravel: 10.*
|
||||||
- php: 8.0
|
- php: 8.0
|
||||||
dependency-version: prefer-lowest
|
dependency-version: prefer-lowest
|
||||||
|
|
||||||
name: P${{ matrix.php }} - L${{ matrix.laravel }} - ${{ matrix.dependency-version }}
|
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
|
- name: Set git to use LF
|
||||||
|
if: ${{ matrix.os == 'windows-2019' }}
|
||||||
|
run: |
|
||||||
|
git config --global core.autocrlf false
|
||||||
|
git config --global core.eol lf
|
||||||
|
|
||||||
- name: Checkout code
|
- name: Checkout code
|
||||||
uses: actions/checkout@v2
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
- name: Setup PHP
|
- name: Setup PHP
|
||||||
uses: shivammathur/setup-php@v2
|
uses: shivammathur/setup-php@v2
|
||||||
with:
|
with:
|
||||||
php-version: ${{ matrix.php }}
|
php-version: ${{ matrix.php }}
|
||||||
coverage: none
|
coverage: none
|
||||||
extensions: pdo_sqlite
|
extensions: pdo_sqlite, fileinfo
|
||||||
|
|
||||||
- name: Install dependencies
|
- name: Install dependencies
|
||||||
run: |
|
run: |
|
||||||
composer remove vimeo/psalm --no-update --dev
|
composer remove vimeo/psalm --no-update --dev
|
||||||
composer remove friendsofphp/php-cs-fixer --no-update --dev
|
composer remove friendsofphp/php-cs-fixer --no-update --dev
|
||||||
composer require "laravel/framework:${{ matrix.laravel }}" --no-update --no-progress
|
composer require "laravel/framework:${{ matrix.laravel }}" --no-update --no-progress
|
||||||
composer update --${{ matrix.dependency-version }} --prefer-dist --no-progress
|
composer update --prefer-dist --no-progress
|
||||||
|
|
||||||
- name: Execute Unit Tests
|
- name: Execute Unit Tests
|
||||||
run: composer test-ci
|
run: composer test-ci
|
||||||
|
|||||||
+3
-3
@@ -1,8 +1,8 @@
|
|||||||
.phpunit.result.cache
|
.phpunit.result.cache
|
||||||
|
|
||||||
/.idea
|
/.idea
|
||||||
/.php_cs
|
/.php-cs-fixer.cache
|
||||||
/.php_cs.cache
|
/.php-cs-fixer.php
|
||||||
/.php_cs.tests.cache
|
/.php-cs-fixer.tests.cache
|
||||||
/composer.lock
|
/composer.lock
|
||||||
/vendor
|
/vendor
|
||||||
|
|||||||
@@ -2,12 +2,10 @@
|
|||||||
|
|
||||||
// Share common rules between non-test and test files
|
// Share common rules between non-test and test files
|
||||||
return [
|
return [
|
||||||
// PSR12 from https://github.com/FriendsOfPHP/PHP-CS-Fixer/pull/4943
|
'@PSR12' => true,
|
||||||
'@PSR2' => true,
|
|
||||||
'blank_line_after_opening_tag' => true,
|
'blank_line_after_opening_tag' => true,
|
||||||
'braces' => [
|
'braces' => [
|
||||||
// Not-yet-implemented
|
'allow_single_line_anonymous_class_with_empty_body' => true,
|
||||||
// 'allow_single_line_anonymous_class_with_empty_body' => true,
|
|
||||||
],
|
],
|
||||||
'compact_nullable_typehint' => true,
|
'compact_nullable_typehint' => true,
|
||||||
'declare_equal_normalize' => true,
|
'declare_equal_normalize' => true,
|
||||||
@@ -32,7 +30,6 @@ return [
|
|||||||
],
|
],
|
||||||
'return_type_declaration' => true,
|
'return_type_declaration' => true,
|
||||||
'short_scalar_cast' => true,
|
'short_scalar_cast' => true,
|
||||||
'single_blank_line_before_namespace' => true,
|
|
||||||
'single_trait_insert_per_statement' => true,
|
'single_trait_insert_per_statement' => true,
|
||||||
'ternary_operator_spaces' => true,
|
'ternary_operator_spaces' => true,
|
||||||
'visibility_required' => [
|
'visibility_required' => [
|
||||||
@@ -58,7 +55,7 @@ return [
|
|||||||
'no_unused_imports' => true,
|
'no_unused_imports' => true,
|
||||||
'single_quote' => true,
|
'single_quote' => true,
|
||||||
'space_after_semicolon' => true,
|
'space_after_semicolon' => true,
|
||||||
'trailing_comma_in_multiline_array' => true,
|
'trailing_comma_in_multiline' => true,
|
||||||
'trim_array_spaces' => true,
|
'trim_array_spaces' => true,
|
||||||
'unary_operator_spaces' => true,
|
'unary_operator_spaces' => true,
|
||||||
'whitespace_after_comma_in_array' => true,
|
'whitespace_after_comma_in_array' => true,
|
||||||
@@ -5,10 +5,10 @@ $finder = PhpCsFixer\Finder::create()
|
|||||||
->in(__DIR__)
|
->in(__DIR__)
|
||||||
->exclude('tests');
|
->exclude('tests');
|
||||||
|
|
||||||
$config = require __DIR__ . '/.php_cs.common.php';
|
$config = require __DIR__ . '/.php-cs-fixer.common.php';
|
||||||
|
|
||||||
return PhpCsFixer\Config::create()
|
return (new PhpCsFixer\Config())
|
||||||
->setFinder($finder)
|
->setFinder($finder)
|
||||||
->setRules($config)
|
->setRules($config)
|
||||||
->setRiskyAllowed(true)
|
->setRiskyAllowed(true)
|
||||||
->setCacheFile(__DIR__ . '/.php_cs.cache');
|
->setCacheFile(__DIR__ . '/.php-cs-fixer.cache');
|
||||||
@@ -5,7 +5,7 @@ $finder = PhpCsFixer\Finder::create()
|
|||||||
->in(__DIR__ . '/tests')
|
->in(__DIR__ . '/tests')
|
||||||
->exclude('__snapshots__');
|
->exclude('__snapshots__');
|
||||||
|
|
||||||
$config = require __DIR__ . '/.php_cs.common.php';
|
$config = require __DIR__ . '/.php-cs-fixer.common.php';
|
||||||
|
|
||||||
// Additional rules for tests
|
// Additional rules for tests
|
||||||
$config = array_merge(
|
$config = array_merge(
|
||||||
@@ -15,8 +15,8 @@ $config = array_merge(
|
|||||||
]
|
]
|
||||||
);
|
);
|
||||||
|
|
||||||
return PhpCsFixer\Config::create()
|
return (new PhpCsFixer\Config())
|
||||||
->setFinder($finder)
|
->setFinder($finder)
|
||||||
->setRules($config)
|
->setRules($config)
|
||||||
->setRiskyAllowed(true)
|
->setRiskyAllowed(true)
|
||||||
->setCacheFile(__DIR__ . '/.php_cs.tests.cache');
|
->setCacheFile(__DIR__ . '/.php-cs-fixer.tests.cache');
|
||||||
+159
-1
@@ -2,9 +2,167 @@
|
|||||||
|
|
||||||
All notable changes to this project will be documented in this file.
|
All notable changes to this project will be documented in this file.
|
||||||
|
|
||||||
[Next release](https://github.com/barryvdh/laravel-ide-helper/compare/v2.8.1...master)
|
[Next release](https://github.com/barryvdh/laravel-ide-helper/compare/v2.15.0...master)
|
||||||
--------------
|
--------------
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
2024-02-14, 2.15.0
|
||||||
|
------------------
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
- Fix case issue in `ModelsCommand::unsetMethod()` [#1453 / leo108](https://github.com/barryvdh/laravel-ide-helper/pull/1453)
|
||||||
|
- Fix non-facade classes will result in no autocomplete [#841 / netpok](https://github.com/barryvdh/laravel-ide-helper/pull/841)
|
||||||
|
- Skip swoole, otherwise fatal error [#1477 / TimoFrenzel](https://github.com/barryvdh/laravel-ide-helper/pull/1477)
|
||||||
|
- Fix vulnerability CVE-2021-43608 [#1392 / allanlaal](https://github.com/barryvdh/laravel-ide-helper/pull/1392)
|
||||||
|
- Reset foreignKeyConstraintsColumns on model loop start [#1461 / snmatsui](https://github.com/barryvdh/laravel-ide-helper/pull/1461)
|
||||||
|
- Accept scope & scopes as relation [#1452 / Muetze42](https://github.com/barryvdh/laravel-ide-helper/pull/1452)
|
||||||
|
- Fix #1300 relation_return_type must take precedence if it is defined [#1394 / menthol](https://github.com/barryvdh/laravel-ide-helper/pull/1394)
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
- Disable inspections of helper files [#1486 / eidng8](https://github.com/barryvdh/laravel-ide-helper/pull/1486)
|
||||||
|
- Removed support for Laravel 8 and therefore for PHP < 8.0 [#1504 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/1504)
|
||||||
|
|
||||||
|
### Added
|
||||||
|
- Add support for enum default arguments using enum cases. [#1464 / d8vjork](https://github.com/barryvdh/laravel-ide-helper/pull/1464)
|
||||||
|
- Add support for real-time facades in the helper file. [#1455 / filipac](https://github.com/barryvdh/laravel-ide-helper/pull/1455)
|
||||||
|
- Add support for relations with composite keys. [#1479 / calebdw](https://github.com/barryvdh/laravel-ide-helper/pull/1479)
|
||||||
|
- Add support for attribute accessors with no backing field or type hinting [#1411 / pindab0ter](https://github.com/barryvdh/laravel-ide-helper/pull/1411).
|
||||||
|
- Add support for AsCollection and AsArrayObject casts [#1393 / pataar](https://github.com/barryvdh/laravel-ide-helper/pull/1393)
|
||||||
|
- Reintroduce support for multi-db setups [#1426 / benpoulson](https://github.com/barryvdh/laravel-ide-helper/pull/1426)
|
||||||
|
- Support the BINARY(...) database field type [#1434 / Sfonxs](https://github.com/barryvdh/laravel-ide-helper/pull/1434)
|
||||||
|
- Add AllowDynamicProperties Attribute to cooperate with php8.2 deprecation [#1428 / GeoSot](https://github.com/barryvdh/laravel-ide-helper/pull/1428)
|
||||||
|
|
||||||
|
2024-02-05, 2.14.0
|
||||||
|
------------------
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
- Official support for Lumen has been dropped [#1425 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/1425)
|
||||||
|
- Refactor resolving of null information for custom casted attribute types [#1330 / wimski](https://github.com/barryvdh/laravel-ide-helper/pull/1330)
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
- Catch exceptions when loading aliases [#1465 / dongm2ez](https://github.com/barryvdh/laravel-ide-helper/pull/1465)
|
||||||
|
|
||||||
|
### Added
|
||||||
|
- Add support for nikic/php-parser 5 (next to 4) [#1502 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/1502)
|
||||||
|
- Add support for `immutable_date:*` and `immutable_datetime:*` casts. [#1380 / thekonz](https://github.com/barryvdh/laravel-ide-helper/pull/1380)
|
||||||
|
- Add support for attribute accessors marked as protected. [#1339 / pindab0ter](https://github.com/barryvdh/laravel-ide-helper/pull/1339)
|
||||||
|
|
||||||
|
2023-02-04, 2.13.0
|
||||||
|
------------------
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
- Fix return type of methods provided by `SoftDeletes` [#1345 / KentarouTakeda](https://github.com/barryvdh/laravel-ide-helper/pull/1345)
|
||||||
|
- Handle PHP 8.1 deprecation warnings when passing `null` to `new \ReflectionClass` [#1351 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/1351)
|
||||||
|
- Fix issue where \Eloquent is not included when using write_mixin [#1352 / Jefemy](https://github.com/barryvdh/laravel-ide-helper/pull/1352)
|
||||||
|
- Fix model factory method arguments for Laravel >= 9 [#1361 / wimski](https://github.com/barryvdh/laravel-ide-helper/pull/1361)
|
||||||
|
- Improve return type of mock helper methods in tests [#1405 / bentleyo](https://github.com/barryvdh/laravel-ide-helper/pull/1405)
|
||||||
|
- Fix Castable class if failed to detect it from return types [#1388 / kwarcu](https://github.com/barryvdh/laravel-ide-helper/pull/1388)
|
||||||
|
|
||||||
|
### Added
|
||||||
|
- Added Laravel 10 support [#1407 / lptn](https://github.com/barryvdh/laravel-ide-helper/pull/1407)
|
||||||
|
- Add support for custom casts that implement `CastsInboundAttributes` [#1329 / sforward](https://github.com/barryvdh/laravel-ide-helper/pull/1329)
|
||||||
|
- Add option `use_generics_annotations` for collection type hints [#1298 / tanerkay](https://github.com/barryvdh/laravel-ide-helper/pull/1298)
|
||||||
|
|
||||||
|
2022-03-06, 2.12.3
|
||||||
|
------------------
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
- Fix date and datetime handling for attributes that set a serialization format option for the Carbon instance [#1324 / FLeudts](https://github.com/barryvdh/laravel-ide-helper/pull/1324)
|
||||||
|
- Fix composer conflict with composer/pcre version 2/3. [#1327 / barryvdh](https://github.com/barryvdh/laravel-ide-helper/pull/1327)
|
||||||
|
|
||||||
|
2022-02-08, 2.12.2
|
||||||
|
------------------
|
||||||
|
### Fixed
|
||||||
|
- Remove composer dependecy, use copy of ClassMapGenerator [#1313 / barryvdh](https://github.com/barryvdh/laravel-ide-helper/pull/1313)
|
||||||
|
|
||||||
|
2022-01-24, 2.12.1
|
||||||
|
------------------
|
||||||
|
### Fixed
|
||||||
|
- Properly handle `Castable`s without return type. [#1306 / binotaliu](https://github.com/barryvdh/laravel-ide-helper/pull/1306)
|
||||||
|
|
||||||
|
2022-01-23, 2.12.0
|
||||||
|
------------------
|
||||||
|
### Added
|
||||||
|
- Add support for custom casts that using `Castable` [#1287 / binotaliu](https://github.com/barryvdh/laravel-ide-helper/pull/1287)
|
||||||
|
- Added Laravel 9 support [#1297 / rcerljenko](https://github.com/barryvdh/laravel-ide-helper/pull/1297)
|
||||||
|
- Added option `additional_relation_return_types` for custom relations that don't fit the typical naming scheme
|
||||||
|
|
||||||
|
2022-01-03, 2.11.0
|
||||||
|
------------------
|
||||||
|
### Added
|
||||||
|
- Add support for Laravel 8.77 Attributes [\#1289 / SimonJnsson](https://github.com/barryvdh/laravel-ide-helper/pull/1289)
|
||||||
|
- Add support for cast types `decimal:*`, `encrypted:*`, `immutable_date`, `immutable_datetime`, `custom_datetime`, and `immutable_custom_datetime` [#1262 / miken32](https://github.com/barryvdh/laravel-ide-helper/pull/1262)
|
||||||
|
- Add support of variadic parameters in `ide-helper:models` [\#1234 / shaffe-fr](https://github.com/barryvdh/laravel-ide-helper/pull/1234)
|
||||||
|
- Add support of custom casts without properties [\#1267 / sparclex](https://github.com/barryvdh/laravel-ide-helper/pull/1267)
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
- Fix recursively searching for `HasFactory` and `Macroable` traits [\#1216 / daniel-de-wit](https://github.com/barryvdh/laravel-ide-helper/pull/1216)
|
||||||
|
- Use platformName to determine db type when casting boolean types [\#1212 / stockalexander](https://github.com/barryvdh/laravel-ide-helper/pull/1212)
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
- Move default models helper filename to config [\#1241 / wimski](https://github.com/barryvdh/laravel-ide-helper/pull/1241)
|
||||||
|
|
||||||
|
2021-06-18, 2.10.1
|
||||||
|
------------------
|
||||||
|
### Added
|
||||||
|
- Added Type registration according to [Custom Mapping Types documentation](https://www.doctrine-project.org/projects/doctrine-dbal/en/latest/reference/types.html#custom-mapping-types) [\#1228 / wimski](https://github.com/barryvdh/laravel-ide-helper/pull/1241)
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
- Fixing issue where configured custom_db_types could cause a DBAL exception to be thrown while running `ide-helper:models` [\#1228 / wimski](https://github.com/barryvdh/laravel-ide-helper/pull/1241)
|
||||||
|
|
||||||
|
2021-04-09, 2.10.0
|
||||||
|
------------------
|
||||||
|
### Added
|
||||||
|
- Allowing Methods to be set or unset in ModelHooks [\#1198 / jenga201](https://github.com/barryvdh/laravel-ide-helper/pull/1198)\
|
||||||
|
Note: the visibility of `\Barryvdh\LaravelIdeHelper\Console\ModelsCommand::setMethod` has been changed to **public**!
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
- Fixing issue where incorrect autoloader unregistered [\#1210 / tezhm](https://github.com/barryvdh/laravel-ide-helper/pull/1210)
|
||||||
|
|
||||||
|
2021-04-02, 2.9.3
|
||||||
|
-----------------
|
||||||
|
### Fixed
|
||||||
|
- Support both customized namespace factories as well as default resolvable ones [\#1201 / wimski](https://github.com/barryvdh/laravel-ide-helper/pull/1201)
|
||||||
|
|
||||||
|
2021-04-01, 2.9.2
|
||||||
|
-----------------
|
||||||
|
### Added
|
||||||
|
- Model hooks for adding custom information from external sources to model classes through the ModelsCommand [\#945 / wimski](https://github.com/barryvdh/laravel-ide-helper/pull/945)
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
- Fix ide-helper:models exception if model doesn't have factory [\#1196 / ahmed-aliraqi](https://github.com/barryvdh/laravel-ide-helper/pull/1196)
|
||||||
|
- Running tests triggering post_migrate hooks [\#1193 / netpok](https://github.com/barryvdh/laravel-ide-helper/pull/1193)
|
||||||
|
- Array_merge error when config is cached prior to package install [\#1184 / netpok](https://github.com/barryvdh/laravel-ide-helper/pull/1184)
|
||||||
|
|
||||||
|
2021-03-15, 2.9.1
|
||||||
|
-----------------
|
||||||
|
### Added
|
||||||
|
- Generate PHPDoc for Laravel 8.x factories [\#1074 / ahmed-aliraqi](https://github.com/barryvdh/laravel-ide-helper/pull/1074)
|
||||||
|
- Add a comment to a property like table columns [\#1168 / biiiiiigmonster](https://github.com/barryvdh/laravel-ide-helper/pull/1168)
|
||||||
|
- Added `post_migrate` hook to run commands after a migration [\#1163 / netpok](https://github.com/barryvdh/laravel-ide-helper/pull/1163)
|
||||||
|
- Allow for PhpDoc for macros with union types [\#1148 / riesjart](https://github.com/barryvdh/laravel-ide-helper/pull/1148)
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
- Error when generating helper for invokable classes [\#1124 / standaniels](https://github.com/barryvdh/laravel-ide-helper/pull/1124)
|
||||||
|
- Fix broken ReflectionUnionTypes [\#1132 / def-studio](https://github.com/barryvdh/laravel-ide-helper/pull/1132)
|
||||||
|
- Relative class names are not converted to fully-qualified class names [\#1005 / SavKS](https://github.com/barryvdh/laravel-ide-helper/pull/1005)
|
||||||
|
|
||||||
|
2020-12-30, 2.9.0
|
||||||
|
-----------------
|
||||||
|
### Changed
|
||||||
|
- Dropped support for Laravel 6 and Laravel 7, as well as support for PHP 7.2 and added support for doctrine/dbal:^3 [\#1114 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/1114)
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
- `Macro::initPhpDoc()` will save original docblock if present [\#1116 / LastDragon-ru](https://github.com/barryvdh/laravel-ide-helper/pull/1116)
|
||||||
|
- `Alias` will grab macros from `\Illuminate\Database\Eloquent\Builder` too [\#1118 / LastDragon-ru](https://github.com/barryvdh/laravel-ide-helper/pull/1118)
|
||||||
|
|
||||||
|
2020-12-08, 2.8.2
|
||||||
|
-----------------
|
||||||
### Added
|
### Added
|
||||||
- Fix phpdoc generate for custom cast with parameter [\#986 / artelkr](https://github.com/barryvdh/laravel-ide-helper/pull/986)
|
- Fix phpdoc generate for custom cast with parameter [\#986 / artelkr](https://github.com/barryvdh/laravel-ide-helper/pull/986)
|
||||||
- Created a possibility to add custom relation type [\#987 / efinder2](https://github.com/barryvdh/laravel-ide-helper/pull/987)
|
- Created a possibility to add custom relation type [\#987 / efinder2](https://github.com/barryvdh/laravel-ide-helper/pull/987)
|
||||||
|
|||||||
@@ -1,26 +1,28 @@
|
|||||||
# Laravel IDE Helper Generator
|
# IDE Helper Generator for Laravel
|
||||||
|
|
||||||
[![Latest Version on Packagist][ico-version]][link-packagist]
|
[](https://github.com/barryvdh/laravel-ide-helper/actions)
|
||||||
[![Software License][ico-license]](LICENSE.md)
|
[](http://choosealicense.com/licenses/mit/)
|
||||||
[![Build Status][ico-gha]][link-gha]
|
[](https://packagist.org/packages/barryvdh/laravel-ide-helper)
|
||||||
[![Total Downloads][ico-downloads]][link-downloads]
|
[](https://packagist.org/packages/barryvdh/laravel-ide-helper)
|
||||||
|
[](https://fruitcake.nl/)
|
||||||
|
|
||||||
**Complete PHPDocs, directly from the source**
|
**Complete PHPDocs, directly from the source**
|
||||||
|
|
||||||
This package generates helper files that enable your IDE to provide accurate autocompletion.
|
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.
|
Generation is done based on the files in your project, so they are always up-to-date.
|
||||||
|
|
||||||
|
It supports Laravel 9+ and PHP 8.0+
|
||||||
|
|
||||||
- [Installation](#installation)
|
- [Installation](#installation)
|
||||||
- [Usage](#usage)
|
- [Usage](#usage)
|
||||||
- [Automatic PHPDoc generation for Laravel Facades](#automatic-phpdoc-generation-for-laravel-facades)
|
- [Automatic PHPDoc generation for Laravel Facades](#automatic-phpdoc-generation-for-laravel-facades)
|
||||||
- [Automatic PHPDocs for models](#automatic-phpdocs-for-models)
|
- [Automatic PHPDocs for models](#automatic-phpdocs-for-models)
|
||||||
|
- [Model Directories](#model-directories)
|
||||||
|
- [Ignore Models](#ignore-models)
|
||||||
|
- [Model Hooks](#model-hooks)
|
||||||
- [Automatic PHPDocs generation for Laravel Fluent methods](#automatic-phpdocs-generation-for-laravel-fluent-methods)
|
- [Automatic PHPDocs generation for Laravel Fluent methods](#automatic-phpdocs-generation-for-laravel-fluent-methods)
|
||||||
- [Auto-completion for factory builders](#auto-completion-for-factory-builders)
|
- [Auto-completion for factory builders](#auto-completion-for-factory-builders)
|
||||||
- [PhpStorm Meta for Container instances](#phpstorm-meta-for-container-instances)
|
- [PhpStorm Meta for Container instances](#phpstorm-meta-for-container-instances)
|
||||||
- [Usage with Lumen](#usage-with-lumen)
|
|
||||||
- [Enabling Facades](#enabling-facades)
|
|
||||||
- [Adding the Service Provider](#adding-the-service-provider)
|
|
||||||
- [Adding Additional Facades](#adding-additional-facades)
|
|
||||||
- [License](#license)
|
- [License](#license)
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
@@ -31,6 +33,10 @@ Require this package with composer using the following command:
|
|||||||
composer require --dev barryvdh/laravel-ide-helper
|
composer require --dev barryvdh/laravel-ide-helper
|
||||||
```
|
```
|
||||||
|
|
||||||
|
> [!NOTE]
|
||||||
|
> If you encounter version conflicts with doctrine/dbal, please try:
|
||||||
|
> `composer require --dev barryvdh/laravel-ide-helper --with-all-dependencies`
|
||||||
|
|
||||||
This package makes use of [Laravels package auto-discovery mechanism](https://medium.com/@taylorotwell/package-auto-discovery-in-laravel-5-5-ea9e3ab20518), which means if you don't install dev dependencies in production, it also won't be loaded.
|
This package makes use of [Laravels package auto-discovery mechanism](https://medium.com/@taylorotwell/package-auto-discovery-in-laravel-5-5-ea9e3ab20518), which means if you don't install dev dependencies in production, it also won't be loaded.
|
||||||
|
|
||||||
If for some reason you want manually control this:
|
If for some reason you want manually control this:
|
||||||
@@ -65,9 +71,9 @@ If for some reason you want manually control this:
|
|||||||
|
|
||||||
_Check out [this Laracasts video](https://laracasts.com/series/how-to-be-awesome-in-phpstorm/episodes/15) for a quick introduction/explanation!_
|
_Check out [this Laracasts video](https://laracasts.com/series/how-to-be-awesome-in-phpstorm/episodes/15) for a quick introduction/explanation!_
|
||||||
|
|
||||||
- [`php artisan ide-helper:generate` - PHPDoc generation for Laravel Facades ](#automatic-phpdoc-generation-for-laravel-facades)
|
- `php artisan ide-helper:generate` - [PHPDoc generation for Laravel Facades ](#automatic-phpdoc-generation-for-laravel-facades)
|
||||||
- [`php artisan ide-helper:models` - PHPDocs for models](#automatic-PHPDocs-for-models)
|
- `php artisan ide-helper:models` - [PHPDocs for models](#automatic-phpdocs-for-models)
|
||||||
- [`php artisan ide-helper:meta` - PhpStorm Meta file](#phpstorm-meta-for-container-instances)
|
- `php artisan ide-helper:meta` - [PhpStorm Meta file](#phpstorm-meta-for-container-instances)
|
||||||
|
|
||||||
|
|
||||||
Note: You do need CodeComplice for Sublime Text: https://github.com/spectacles/CodeComplice
|
Note: You do need CodeComplice for Sublime Text: https://github.com/spectacles/CodeComplice
|
||||||
@@ -107,6 +113,10 @@ The generator tries to identify the real class, but if it cannot be found, you c
|
|||||||
Some classes need a working database connection. If you do not have a default working connection, some facades will not be included.
|
Some classes need a working database connection. If you do not have a default working connection, some facades will not be included.
|
||||||
You can use an in-memory SQLite driver by adding the `-M` option.
|
You can use an in-memory SQLite driver by adding the `-M` option.
|
||||||
|
|
||||||
|
If you use [real-time facades](https://laravel.com/docs/master/facades#real-time-facades) in your app, those will also be included in the generated file using a `@mixin` annotation and extending the original class underneath the facade.
|
||||||
|
|
||||||
|
**Note**: this feature uses the generated real-time facades files in the `storage/framework/cache` folder. Those files are generated on-demand as you use the real-time facade, so if the framework has not generated that first, it will not be included in the helper file. Run the route/command/code first and then regenerate the helper file and this time the real-time facade will be included in it.
|
||||||
|
|
||||||
You can choose to include helper files. This is not enabled by default, but you can override it with the `--helpers (-H)` option.
|
You can choose to include helper files. This is not enabled by default, but you can override it with the `--helpers (-H)` option.
|
||||||
The `Illuminate/Support/helpers.php` is already set up, but you can add/remove your own files in the config file.
|
The `Illuminate/Support/helpers.php` is already set up, but you can add/remove your own files in the config file.
|
||||||
|
|
||||||
@@ -139,9 +149,9 @@ The class name will be different from the model, avoiding the IDE duplicate anno
|
|||||||
|
|
||||||
> Please make sure to back up your models, before writing the info.
|
> Please make sure to back up your models, before writing the info.
|
||||||
|
|
||||||
Writing to the models should keep the existing comments and only append new properties/methods.
|
Writing to the models should keep the existing comments and only append new properties/methods. It will not update changed properties/methods.
|
||||||
The existing PHPDoc is replaced, or added if not found.
|
|
||||||
With the `--reset (-R)` option, the existing PHPDocs are ignored, and only the newly found columns/relations are saved as PHPDocs.
|
With the `--reset (-R)` option, the whole existing PHPDoc is replaced, including any comments that have been made. The `--smart-reset` option will instead keep the 'text' part of the phpdoc comment, and just replace all the property/method defininitions.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
php artisan ide-helper:models "App\Models\Post"
|
php artisan ide-helper:models "App\Models\Post"
|
||||||
@@ -163,6 +173,7 @@ php artisan ide-helper:models "App\Models\Post"
|
|||||||
* @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Post newQuery()
|
* @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Post newQuery()
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Post query()
|
* @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Post query()
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Post whereTitle($value)
|
* @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Post whereTitle($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Post forAuthors(\User ...$authors)
|
||||||
* …
|
* …
|
||||||
*/
|
*/
|
||||||
```
|
```
|
||||||
@@ -175,6 +186,8 @@ With the `--write-mixin (-M)` option
|
|||||||
*/
|
*/
|
||||||
```
|
```
|
||||||
|
|
||||||
|
#### Model Directories
|
||||||
|
|
||||||
By default, models in `app/models` are scanned. The optional argument tells what models to use (also outside app/models).
|
By default, models in `app/models` are scanned. The optional argument tells what models to use (also outside app/models).
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
@@ -189,6 +202,8 @@ php artisan ide-helper:models --dir="path/to/models" --dir="app/src/Model"
|
|||||||
|
|
||||||
You can publish the config file (`php artisan vendor:publish`) and set the default directories.
|
You can publish the config file (`php artisan vendor:publish`) and set the default directories.
|
||||||
|
|
||||||
|
#### Ignore Models
|
||||||
|
|
||||||
Models can be ignored using the `--ignore (-I)` option
|
Models can be ignored using the `--ignore (-I)` option
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
@@ -206,7 +221,7 @@ Or can be ignored by setting the `ignored_models` config
|
|||||||
|
|
||||||
#### Magic `where*` methods
|
#### Magic `where*` methods
|
||||||
|
|
||||||
Eloquent allows calling `where<Attribute>` on your modes, e.g. `Post::whereTitle(…)` and automatically translates this to e.g. `Post::where('title', '=', '…')`.
|
Eloquent allows calling `where<Attribute>` on your models, e.g. `Post::whereTitle(…)` and automatically translates this to e.g. `Post::where('title', '=', '…')`.
|
||||||
|
|
||||||
If for some reason it's undesired to have them generated (one for each column), you can disable this via config `write_model_magic_where` and setting it to `false`.
|
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`.
|
||||||
|
|
||||||
@@ -216,6 +231,39 @@ You may use the [`::withCount`](https://laravel.com/docs/master/eloquent-relatio
|
|||||||
|
|
||||||
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` to `false`.
|
||||||
|
|
||||||
|
#### Generics annotations
|
||||||
|
|
||||||
|
Laravel 9 introduced generics annotations in DocBlocks for collections. PhpStorm 2022.3 and above support the use of generics annotations within `@property` and `@property-read` declarations in DocBlocks, e.g. `Collection<User>` instead of `Collection|User[]`.
|
||||||
|
|
||||||
|
These can be disabled by setting the config `use_generics_annotations` to `false`.
|
||||||
|
|
||||||
|
#### Support `@comment` based on DocBlock
|
||||||
|
|
||||||
|
In order to better support IDEs, relations and getters/setters can also add a comment to a property like table columns. Therefore a custom docblock `@comment` is used:
|
||||||
|
```php
|
||||||
|
class Users extends Model
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* @comment Get User's full name
|
||||||
|
*
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public function getFullNameAttribute(): string
|
||||||
|
{
|
||||||
|
return $this->first_name . ' ' .$this->last_name ;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// => after generate models
|
||||||
|
|
||||||
|
/**
|
||||||
|
* App\Models\Users
|
||||||
|
*
|
||||||
|
* @property-read string $full_name Get User's full name
|
||||||
|
* …
|
||||||
|
*/
|
||||||
|
```
|
||||||
|
|
||||||
#### Dedicated Eloquent Builder methods
|
#### Dedicated Eloquent Builder methods
|
||||||
|
|
||||||
A new method to the eloquent models was added called `newEloquentBuilder` [Reference](https://timacdonald.me/dedicated-eloquent-model-query-builders/) where we can
|
A new method to the eloquent models was added called `newEloquentBuilder` [Reference](https://timacdonald.me/dedicated-eloquent-model-query-builders/) where we can
|
||||||
@@ -243,6 +291,64 @@ For those special cases, you can map them via the config `custom_db_types`. Exam
|
|||||||
],
|
],
|
||||||
```
|
```
|
||||||
|
|
||||||
|
#### Custom Relationship Types
|
||||||
|
|
||||||
|
If you are using relationships not built into Laravel you will need to specify the name and returning class in the config to get proper generation.
|
||||||
|
|
||||||
|
```php
|
||||||
|
'additional_relation_types' => [
|
||||||
|
'externalHasMany' => \My\Package\externalHasMany::class
|
||||||
|
],
|
||||||
|
```
|
||||||
|
|
||||||
|
Found relationships will typically generate a return value based on the name of the relationship.
|
||||||
|
|
||||||
|
If your custom relationships don't follow this traditional naming scheme you can define its return type manually. The available options are `many` and `morphTo`.
|
||||||
|
|
||||||
|
```php
|
||||||
|
'additional_relation_return_types' => [
|
||||||
|
'externalHasMultiple' => 'many'
|
||||||
|
],
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Model Hooks
|
||||||
|
|
||||||
|
If you need additional information on your model from sources that are not handled by default, you can hook in to the
|
||||||
|
generation process with model hooks to add extra information on the fly.
|
||||||
|
Simply create a class that implements `ModelHookInterface` and add it to the `model_hooks` array in the config:
|
||||||
|
|
||||||
|
```php
|
||||||
|
'model_hooks' => [
|
||||||
|
MyCustomHook::class,
|
||||||
|
],
|
||||||
|
```
|
||||||
|
|
||||||
|
The `run` method will be called during generation for every model and receives the current running `ModelsCommand` and the current `Model`, e.g.:
|
||||||
|
|
||||||
|
```php
|
||||||
|
class MyCustomHook implements ModelHookInterface
|
||||||
|
{
|
||||||
|
public function run(ModelsCommand $command, Model $model): void
|
||||||
|
{
|
||||||
|
if (! $model instanceof MyModel) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
$command->setProperty('custom', 'string', true, false, 'My custom property');
|
||||||
|
$command->unsetMethod('method');
|
||||||
|
$command->setMethod('method', $command->getMethodType($model, '\Some\Class'), ['$param']);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
```php
|
||||||
|
/**
|
||||||
|
* MyModel
|
||||||
|
*
|
||||||
|
* @property integer $id
|
||||||
|
* @property-read string $custom
|
||||||
|
```
|
||||||
|
|
||||||
### Automatic PHPDocs generation for Laravel Fluent methods
|
### Automatic PHPDocs generation for Laravel Fluent methods
|
||||||
|
|
||||||
If you need PHPDocs support for Fluent methods in migration, for example
|
If you need PHPDocs support for Fluent methods in migration, for example
|
||||||
@@ -251,7 +357,7 @@ If you need PHPDocs support for Fluent methods in migration, for example
|
|||||||
$table->string("somestring")->nullable()->index();
|
$table->string("somestring")->nullable()->index();
|
||||||
```
|
```
|
||||||
|
|
||||||
After publishing vendor, simply change the `include_fluent` line your `config/ide-helper.php` file into:
|
After publishing vendor, simply change the `include_fluent` line in your `config/ide-helper.php` file into:
|
||||||
|
|
||||||
```php
|
```php
|
||||||
'include_fluent' => true,
|
'include_fluent' => true,
|
||||||
@@ -262,7 +368,7 @@ Then run `php artisan ide-helper:generate`, you will now see all Fluent methods
|
|||||||
### Auto-completion for factory builders
|
### Auto-completion for factory builders
|
||||||
|
|
||||||
If you would like the `factory()->create()` and `factory()->make()` methods to return the correct model class,
|
If you would like the `factory()->create()` and `factory()->make()` methods to return the correct model class,
|
||||||
you can enable custom factory builders with the `include_factory_builders` line your `config/ide-helper.php` file.
|
you can enable custom factory builders with the `include_factory_builders` line in your `config/ide-helper.php` file.
|
||||||
Deprecated for Laravel 8 or latest.
|
Deprecated for Laravel 8 or latest.
|
||||||
|
|
||||||
```php
|
```php
|
||||||
@@ -300,76 +406,9 @@ app(App\SomeClass::class);
|
|||||||
> Note: When you receive a FatalException: class not found, check your config
|
> Note: When you receive a FatalException: class not found, check your config
|
||||||
> (for example, remove S3 as cloud driver when you don't have S3 configured. Remove Redis ServiceProvider when you don't use it).
|
> (for example, remove S3 as cloud driver when you don't have S3 configured. Remove Redis ServiceProvider when you don't use it).
|
||||||
|
|
||||||
You can change the generated filename via the config `meta_filename`. This can be useful for cases you want to take advantage the PhpStorm also supports the _directory_ `.phpstorm.meta.php/` which would parse any file places there, should your want provide additional files to PhpStorm.
|
You can change the generated filename via the config `meta_filename`. This can be useful for cases where you want to take advantage of PhpStorm's support of the _directory_ `.phpstorm.meta.php/`: all files placed there are parsed, should you want to provide additional files to PhpStorm.
|
||||||
|
|
||||||
## Usage with Lumen
|
|
||||||
|
|
||||||
This package is focused on Laravel development, but it can also be used in Lumen with some workarounds.
|
|
||||||
Because Lumen works a little different, as it is like a bare bone version of Laravel and the main configuration
|
|
||||||
parameters are instead located in `bootstrap/app.php`, some alterations must be made.
|
|
||||||
|
|
||||||
### Enabling Facades
|
|
||||||
|
|
||||||
While Laravel IDE Helper can generate automatically default Facades for code hinting,
|
|
||||||
Lumen doesn't come with Facades activated. If you plan in using them, you must enable
|
|
||||||
them under the `Create The Application` section, uncommenting this line:
|
|
||||||
|
|
||||||
```php
|
|
||||||
// $app->withFacades();
|
|
||||||
```
|
|
||||||
|
|
||||||
From there, you should be able to use the `create_alias()` function to add additional Facades into your application.
|
|
||||||
|
|
||||||
### Adding the Service Provider
|
|
||||||
|
|
||||||
You can install Laravel IDE Helper in `app/Providers/AppServiceProvider.php`,
|
|
||||||
and uncommenting this line that registers the App Service Providers, so it can properly load.
|
|
||||||
|
|
||||||
```php
|
|
||||||
// $app->register(App\Providers\AppServiceProvider::class);
|
|
||||||
```
|
|
||||||
|
|
||||||
If you are not using that line, that is usually handy to manage gracefully multiple Laravel/Lumen installations,
|
|
||||||
you will have to add this line of code under the `Register Service Providers` section of your `bootstrap/app.php`.
|
|
||||||
|
|
||||||
```php
|
|
||||||
if ($app->environment() !== 'production') {
|
|
||||||
$app->register(\Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider::class);
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
After that, Laravel IDE Helper should work correctly. During the generation process,
|
|
||||||
the script may throw exceptions saying that some Class(s) doesn't exist or there are some undefined indexes.
|
|
||||||
This is normal, as Lumen has some default packages stripped away, like Cookies, Storage and Session.
|
|
||||||
If you plan to add these packages, you will have to add them manually and create additional Facades if needed.
|
|
||||||
|
|
||||||
### Adding Additional Facades
|
|
||||||
|
|
||||||
Currently, Lumen IDE Helper doesn't take into account additional Facades created under `bootstrap/app.php` using `create_alias()`,
|
|
||||||
so you need to create a `config/app.php` file and add your custom aliases under an `aliases` array again, like so:
|
|
||||||
|
|
||||||
```php
|
|
||||||
return [
|
|
||||||
'aliases' => [
|
|
||||||
'CustomAliasOne' => Example\Support\Facades\CustomAliasOne::class,
|
|
||||||
'CustomAliasTwo' => Example\Support\Facades\CustomAliasTwo::class,
|
|
||||||
//...
|
|
||||||
]
|
|
||||||
];
|
|
||||||
```
|
|
||||||
|
|
||||||
After you run `php artisan ide-helper:generate`, it's recommended (but not mandatory) to rename `config/app.php` to something else,
|
|
||||||
until you have to re-generate the docs or after passing to production environment.
|
|
||||||
Lumen 5.1+ will read this file for configuration parameters if it is present, and may overlap some configurations if it is completely populated.
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
The Laravel IDE Helper Generator is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT)
|
The Laravel IDE Helper Generator is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT)
|
||||||
|
|
||||||
[ico-version]: https://img.shields.io/packagist/v/barryvdh/laravel-ide-helper.svg?style=flat-square
|
|
||||||
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
|
|
||||||
[ico-gha]: https://github.com/barryvdh/laravel-ide-helper/workflows/Tests/badge.svg
|
|
||||||
[ico-downloads]: https://img.shields.io/packagist/dt/barryvdh/laravel-ide-helper.svg?style=flat-square
|
|
||||||
[link-packagist]: https://packagist.org/packages/barryvdh/laravel-ide-helper
|
|
||||||
[link-gha]: https://github.com/barryvdh/laravel-ide-helper/actions
|
|
||||||
[link-downloads]: https://packagist.org/packages/barryvdh/laravel-ide-helper
|
|
||||||
|
|||||||
+37
-30
@@ -1,6 +1,7 @@
|
|||||||
{
|
{
|
||||||
"name": "barryvdh/laravel-ide-helper",
|
"name": "barryvdh/laravel-ide-helper",
|
||||||
"description": "Laravel IDE Helper, generates correct PHPDocs for all Facade classes, to improve auto-completion.",
|
"description": "Laravel IDE Helper, generates correct PHPDocs for all Facade classes, to improve auto-completion.",
|
||||||
|
"license": "MIT",
|
||||||
"keywords": [
|
"keywords": [
|
||||||
"laravel",
|
"laravel",
|
||||||
"autocomplete",
|
"autocomplete",
|
||||||
@@ -12,7 +13,6 @@
|
|||||||
"codeintel",
|
"codeintel",
|
||||||
"phpdoc"
|
"phpdoc"
|
||||||
],
|
],
|
||||||
"license": "MIT",
|
|
||||||
"authors": [
|
"authors": [
|
||||||
{
|
{
|
||||||
"name": "Barry vd. Heuvel",
|
"name": "Barry vd. Heuvel",
|
||||||
@@ -20,40 +20,33 @@
|
|||||||
}
|
}
|
||||||
],
|
],
|
||||||
"require": {
|
"require": {
|
||||||
"php": ">=7.2",
|
"php": "^8.0",
|
||||||
"ext-json": "*",
|
"ext-json": "*",
|
||||||
"barryvdh/reflection-docblock": "^2.0.6",
|
"barryvdh/reflection-docblock": "^2.0.6",
|
||||||
"composer/composer": "^1.6 || ^2",
|
"composer/class-map-generator": "^1.0",
|
||||||
"doctrine/dbal": "~2.3",
|
"doctrine/dbal": "^2.6 || ^3.1.4",
|
||||||
"illuminate/console": "^6 || ^7 || ^8",
|
"illuminate/console": "^9 || ^10",
|
||||||
"illuminate/filesystem": "^6 || ^7 || ^8",
|
"illuminate/filesystem": "^9 || ^10",
|
||||||
"illuminate/support": "^6 || ^7 || ^8",
|
"illuminate/support": "^9 || ^10",
|
||||||
|
"nikic/php-parser": "^4.18 || ^5",
|
||||||
"phpdocumentor/type-resolver": "^1.1.0"
|
"phpdocumentor/type-resolver": "^1.1.0"
|
||||||
},
|
},
|
||||||
"require-dev": {
|
"require-dev": {
|
||||||
"ext-pdo_sqlite": "*",
|
"ext-pdo_sqlite": "*",
|
||||||
"friendsofphp/php-cs-fixer": "^2",
|
"friendsofphp/php-cs-fixer": "^3",
|
||||||
"illuminate/config": "^6 || ^7 || ^8",
|
"illuminate/config": "^9 || ^10",
|
||||||
"illuminate/view": "^6 || ^7 || ^8",
|
"illuminate/view": "^9 || ^10",
|
||||||
"mockery/mockery": "^1.3.3",
|
"mockery/mockery": "^1.4",
|
||||||
"orchestra/testbench": "^4 || ^5 || ^6",
|
"orchestra/testbench": "^7 || ^8",
|
||||||
"phpunit/phpunit": "^8.5 || ^9",
|
"phpunit/phpunit": "^9",
|
||||||
"spatie/phpunit-snapshot-assertions": "^1.4 || ^2.2 || ^3 || ^4",
|
"spatie/phpunit-snapshot-assertions": "^4",
|
||||||
"vimeo/psalm": "^3.12"
|
"vimeo/psalm": "^5.4"
|
||||||
},
|
},
|
||||||
"config": {
|
"suggest": {
|
||||||
"sort-packages": true
|
"illuminate/events": "Required for automatic helper generation (^6|^7|^8|^9|^10)."
|
||||||
},
|
|
||||||
"extra": {
|
|
||||||
"branch-alias": {
|
|
||||||
"dev-master": "2.8-dev"
|
|
||||||
},
|
|
||||||
"laravel": {
|
|
||||||
"providers": [
|
|
||||||
"Barryvdh\\LaravelIdeHelper\\IdeHelperServiceProvider"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
},
|
},
|
||||||
|
"minimum-stability": "dev",
|
||||||
|
"prefer-stable": true,
|
||||||
"autoload": {
|
"autoload": {
|
||||||
"psr-4": {
|
"psr-4": {
|
||||||
"Barryvdh\\LaravelIdeHelper\\": "src"
|
"Barryvdh\\LaravelIdeHelper\\": "src"
|
||||||
@@ -64,8 +57,22 @@
|
|||||||
"Barryvdh\\LaravelIdeHelper\\Tests\\": "tests"
|
"Barryvdh\\LaravelIdeHelper\\Tests\\": "tests"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"minimum-stability": "dev",
|
"config": {
|
||||||
"prefer-stable": true,
|
"allow-plugins": {
|
||||||
|
"composer/package-versions-deprecated": true
|
||||||
|
},
|
||||||
|
"sort-packages": true
|
||||||
|
},
|
||||||
|
"extra": {
|
||||||
|
"branch-alias": {
|
||||||
|
"dev-master": "2.15-dev"
|
||||||
|
},
|
||||||
|
"laravel": {
|
||||||
|
"providers": [
|
||||||
|
"Barryvdh\\LaravelIdeHelper\\IdeHelperServiceProvider"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
},
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"analyze": "psalm",
|
"analyze": "psalm",
|
||||||
"check-style": [
|
"check-style": [
|
||||||
@@ -74,7 +81,7 @@
|
|||||||
],
|
],
|
||||||
"fix-style": [
|
"fix-style": [
|
||||||
"php-cs-fixer fix",
|
"php-cs-fixer fix",
|
||||||
"php-cs-fixer fix --config=.php_cs.tests.php"
|
"php-cs-fixer fix --config=.php-cs-fixer.tests.php"
|
||||||
],
|
],
|
||||||
"psalm-set-baseline": "psalm --set-baseline=psalm-baseline.xml",
|
"psalm-set-baseline": "psalm --set-baseline=psalm-baseline.xml",
|
||||||
"test": "phpunit",
|
"test": "phpunit",
|
||||||
|
|||||||
+64
-1
@@ -13,6 +13,17 @@ return [
|
|||||||
|
|
||||||
'filename' => '_ide_helper.php',
|
'filename' => '_ide_helper.php',
|
||||||
|
|
||||||
|
/*
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
| Models filename
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
|
|
||||||
|
| The default filename for the models helper file
|
||||||
|
|
|
||||||
|
*/
|
||||||
|
|
||||||
|
'models_filename' => '_ide_helper_models.php',
|
||||||
|
|
||||||
/*
|
/*
|
||||||
|--------------------------------------------------------------------------
|
|--------------------------------------------------------------------------
|
||||||
| Where to write the PhpStorm specific meta file
|
| Where to write the PhpStorm specific meta file
|
||||||
@@ -144,6 +155,21 @@ return [
|
|||||||
|
|
||||||
],
|
],
|
||||||
|
|
||||||
|
/*
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
| Models hooks
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
|
|
||||||
|
| Define which hook classes you want to run for models to add custom information
|
||||||
|
|
|
||||||
|
| Hooks should implement Barryvdh\LaravelIdeHelper\Contracts\ModelHookInterface.
|
||||||
|
|
|
||||||
|
*/
|
||||||
|
|
||||||
|
'model_hooks' => [
|
||||||
|
// App\Support\IdeHelper\MyModelHook::class
|
||||||
|
],
|
||||||
|
|
||||||
/*
|
/*
|
||||||
|--------------------------------------------------------------------------
|
|--------------------------------------------------------------------------
|
||||||
| Extra classes
|
| Extra classes
|
||||||
@@ -191,7 +217,7 @@ return [
|
|||||||
| The value of the array is an array of type mappings. Key is the name of the custom type,
|
| The value of the array is an array of type mappings. Key is the name of the custom type,
|
||||||
| (for example, "jsonb" from Postgres 9.4) and the value is the name of the corresponding Doctrine2 type (in
|
| (for example, "jsonb" from Postgres 9.4) and the value is the name of the corresponding Doctrine2 type (in
|
||||||
| our case it is 'json_array'. Doctrine types are listed here:
|
| our case it is 'json_array'. Doctrine types are listed here:
|
||||||
| http://doctrine-dbal.readthedocs.org/en/latest/reference/types.html
|
| https://www.doctrine-project.org/projects/doctrine-dbal/en/latest/reference/types.html#types
|
||||||
|
|
|
|
||||||
| So to support jsonb in your models when working with Postgres, just add the following entry to the array below:
|
| So to support jsonb in your models when working with Postgres, just add the following entry to the array below:
|
||||||
|
|
|
|
||||||
@@ -266,6 +292,17 @@ return [
|
|||||||
*/
|
*/
|
||||||
'force_fqn' => false,
|
'force_fqn' => false,
|
||||||
|
|
||||||
|
/*
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
| Use generics syntax
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
|
|
||||||
|
| Use generics syntax within DocBlocks,
|
||||||
|
| e.g. `Collection<User>` instead of `Collection|User[]`.
|
||||||
|
|
|
||||||
|
*/
|
||||||
|
'use_generics_annotations' => true,
|
||||||
|
|
||||||
/*
|
/*
|
||||||
|--------------------------------------------------------------------------
|
|--------------------------------------------------------------------------
|
||||||
| Additional relation types
|
| Additional relation types
|
||||||
@@ -278,4 +315,30 @@ return [
|
|||||||
*/
|
*/
|
||||||
'additional_relation_types' => [],
|
'additional_relation_types' => [],
|
||||||
|
|
||||||
|
/*
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
| Additional relation return types
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
|
|
||||||
|
| When using custom relation types its possible for the class name to not contain
|
||||||
|
| the proper return type of the relation. The key of the array is the relationship
|
||||||
|
| method name. The value of the array is the return type of the relation ('many'
|
||||||
|
| or 'morphTo').
|
||||||
|
| e.g. `'relationName' => 'many'`.
|
||||||
|
|
|
||||||
|
*/
|
||||||
|
'additional_relation_return_types' => [],
|
||||||
|
|
||||||
|
/*
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
| Run artisan commands after migrations to generate model helpers
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
|
|
||||||
|
| The specified commands should run after migrations are finished running.
|
||||||
|
|
|
||||||
|
*/
|
||||||
|
'post_migrate' => [
|
||||||
|
// 'ide-helper:models --nowrite',
|
||||||
|
],
|
||||||
|
|
||||||
];
|
];
|
||||||
|
|||||||
+8
-9
@@ -1,5 +1,5 @@
|
|||||||
<?xml version="1.0" encoding="UTF-8"?>
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
<files psalm-version="3.15@de6e7f324f44dde540ebe7ebd4eb481b97c86f30">
|
<files psalm-version="5.4.0@62db5d4f6a7ae0a20f7cc5a4952d730272fc0863">
|
||||||
<file src="src/Factories.php">
|
<file src="src/Factories.php">
|
||||||
<UndefinedClass occurrences="2">
|
<UndefinedClass occurrences="2">
|
||||||
<code>Factory</code>
|
<code>Factory</code>
|
||||||
@@ -7,19 +7,18 @@
|
|||||||
</UndefinedClass>
|
</UndefinedClass>
|
||||||
</file>
|
</file>
|
||||||
<file src="src/Generator.php">
|
<file src="src/Generator.php">
|
||||||
<UndefinedClass occurrences="7">
|
<UndefinedClass occurrences="6">
|
||||||
<code>\Auth</code>
|
<code>\Auth</code>
|
||||||
|
<code>\Cache</code>
|
||||||
|
<code>\Cache</code>
|
||||||
<code>\DB</code>
|
<code>\DB</code>
|
||||||
<code>\Cache</code>
|
|
||||||
<code>\Cache</code>
|
|
||||||
<code>\Queue</code>
|
<code>\Queue</code>
|
||||||
<code>\SSH</code>
|
|
||||||
<code>\Storage</code>
|
<code>\Storage</code>
|
||||||
</UndefinedClass>
|
</UndefinedClass>
|
||||||
</file>
|
</file>
|
||||||
<file src="src/IdeHelperServiceProvider.php">
|
<file src="src/Console/ModelsCommand.php">
|
||||||
<TooFewArguments occurrences="1">
|
<UndefinedClass occurrences="1">
|
||||||
<code>new PhpEngine()</code>
|
<code>\UnitEnum</code>
|
||||||
</TooFewArguments>
|
</UndefinedClass>
|
||||||
</file>
|
</file>
|
||||||
</files>
|
</files>
|
||||||
|
|||||||
+22
-13
@@ -8,7 +8,9 @@
|
|||||||
*/
|
*/
|
||||||
?>
|
?>
|
||||||
|
|
||||||
|
/* @noinspection ALL */
|
||||||
// @formatter:off
|
// @formatter:off
|
||||||
|
// phpcs:ignoreFile
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A helper file for Laravel, to provide autocomplete information to your IDE
|
* A helper file for Laravel, to provide autocomplete information to your IDE
|
||||||
@@ -21,15 +23,12 @@
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
<?php foreach ($namespaces_by_extends_ns as $namespace => $aliases) : ?>
|
<?php foreach ($namespaces_by_extends_ns as $namespace => $aliases) : ?>
|
||||||
<?php if ($namespace == '\Illuminate\Database\Eloquent') :
|
namespace <?= $namespace == '__root' ? '' : trim($namespace, '\\') ?> {
|
||||||
continue;
|
|
||||||
endif; ?>
|
|
||||||
namespace <?= $namespace == '__root' ? '' : trim($namespace, '\\') ?> {
|
|
||||||
<?php foreach ($aliases as $alias) : ?>
|
<?php foreach ($aliases as $alias) : ?>
|
||||||
<?= trim($alias->getDocComment(' ')) ?>
|
<?= trim($alias->getDocComment(' ')) ?>
|
||||||
<?= $alias->getClassType() ?> <?= $alias->getExtendsClass() ?> {
|
<?= $alias->getClassType() ?> <?= $alias->getExtendsClass() ?> {
|
||||||
<?php foreach ($alias->getMethods() as $method) : ?>
|
<?php foreach ($alias->getMethods() as $method) : ?>
|
||||||
<?= trim($method->getDocComment(' ')) ?>
|
<?= trim($method->getDocComment(' ')) ?>
|
||||||
public static function <?= $method->getName() ?>(<?= $method->getParamsWithDefault() ?>)
|
public static function <?= $method->getName() ?>(<?= $method->getParamsWithDefault() ?>)
|
||||||
{<?php if ($method->getDeclaringClass() !== $method->getRoot()) : ?>
|
{<?php if ($method->getDeclaringClass() !== $method->getRoot()) : ?>
|
||||||
//Method inherited from <?= $method->getDeclaringClass() ?>
|
//Method inherited from <?= $method->getDeclaringClass() ?>
|
||||||
@@ -40,19 +39,19 @@ namespace <?= $namespace == '__root' ? '' : trim($namespace, '\\') ?> {
|
|||||||
<?php endif?>
|
<?php endif?>
|
||||||
<?= $method->shouldReturn() ? 'return ' : '' ?><?= $method->getRootMethodCall() ?>;
|
<?= $method->shouldReturn() ? 'return ' : '' ?><?= $method->getRootMethodCall() ?>;
|
||||||
}
|
}
|
||||||
<?php endforeach; ?>
|
<?php endforeach; ?>
|
||||||
}
|
}
|
||||||
<?php endforeach; ?>
|
<?php endforeach; ?>
|
||||||
}
|
}
|
||||||
|
|
||||||
<?php endforeach; ?>
|
<?php endforeach; ?>
|
||||||
|
|
||||||
<?php foreach ($namespaces_by_alias_ns as $namespace => $aliases) : ?>
|
<?php foreach ($namespaces_by_alias_ns as $namespace => $aliases) : ?>
|
||||||
namespace <?= $namespace == '__root' ? '' : trim($namespace, '\\') ?> {
|
namespace <?= $namespace == '__root' ? '' : trim($namespace, '\\') ?> {
|
||||||
<?php foreach ($aliases as $alias) : ?>
|
<?php foreach ($aliases as $alias) : ?>
|
||||||
<?= $alias->getClassType() ?> <?= $alias->getShortName() ?> extends <?= $alias->getExtends() ?> {<?php if ($alias->getExtendsNamespace() == '\Illuminate\Database\Eloquent') : ?>
|
<?= $alias->getClassType() ?> <?= $alias->getShortName() ?> extends <?= $alias->getExtends() ?> {<?php if ($alias->getExtendsNamespace() == '\Illuminate\Database\Eloquent') : ?>
|
||||||
<?php foreach ($alias->getMethods() as $method) : ?>
|
<?php foreach ($alias->getMethods() as $method) : ?>
|
||||||
<?= trim($method->getDocComment(' ')) ?>
|
<?= trim($method->getDocComment(' ')) ?>
|
||||||
public static function <?= $method->getName() ?>(<?= $method->getParamsWithDefault() ?>)
|
public static function <?= $method->getName() ?>(<?= $method->getParamsWithDefault() ?>)
|
||||||
{<?php if ($method->getDeclaringClass() !== $method->getRoot()) : ?>
|
{<?php if ($method->getDeclaringClass() !== $method->getRoot()) : ?>
|
||||||
//Method inherited from <?= $method->getDeclaringClass() ?>
|
//Method inherited from <?= $method->getDeclaringClass() ?>
|
||||||
@@ -65,14 +64,24 @@ namespace <?= $namespace == '__root' ? '' : trim($namespace, '\\') ?> {
|
|||||||
}
|
}
|
||||||
<?php endforeach; ?>
|
<?php endforeach; ?>
|
||||||
<?php endif; ?>}
|
<?php endif; ?>}
|
||||||
<?php endforeach; ?>
|
<?php endforeach; ?>
|
||||||
}
|
}
|
||||||
|
|
||||||
<?php endforeach; ?>
|
<?php endforeach; ?>
|
||||||
|
|
||||||
|
<?php foreach($real_time_facades as $name): ?>
|
||||||
|
<?php $nested = explode('\\', str_replace('\\' . class_basename($name), '', $name)); ?>
|
||||||
|
namespace <?php echo implode('\\', $nested); ?> {
|
||||||
|
/**
|
||||||
|
* @mixin <?= str_replace('Facades', '', $name) ?>
|
||||||
|
*/
|
||||||
|
class <?= class_basename($name) ?> extends <?= str_replace('Facades', '', $name) ?> {}
|
||||||
|
}
|
||||||
|
<?php endforeach; ?>
|
||||||
|
|
||||||
<?php if ($helpers) : ?>
|
<?php if ($helpers) : ?>
|
||||||
namespace {
|
namespace {
|
||||||
<?= $helpers ?>
|
<?= $helpers ?>
|
||||||
}
|
}
|
||||||
<?php endif; ?>
|
<?php endif; ?>
|
||||||
|
|
||||||
|
|||||||
@@ -1,6 +1,8 @@
|
|||||||
<?= '<?php' ?>
|
<?= '<?php' ?>
|
||||||
|
|
||||||
|
/* @noinspection ALL */
|
||||||
// @formatter:off
|
// @formatter:off
|
||||||
|
// phpcs:ignoreFile
|
||||||
|
|
||||||
namespace PHPSTORM_META {
|
namespace PHPSTORM_META {
|
||||||
|
|
||||||
@@ -28,6 +30,10 @@ namespace PHPSTORM_META {
|
|||||||
]));
|
]));
|
||||||
<?php endif; ?>
|
<?php endif; ?>
|
||||||
|
|
||||||
|
override(\Illuminate\Foundation\Testing\Concerns\InteractsWithContainer::mock(0), map(["" => "@&\Mockery\MockInterface"]));
|
||||||
|
override(\Illuminate\Foundation\Testing\Concerns\InteractsWithContainer::partialMock(0), map(["" => "@&\Mockery\MockInterface"]));
|
||||||
|
override(\Illuminate\Foundation\Testing\Concerns\InteractsWithContainer::instance(0), type(1));
|
||||||
|
override(\Illuminate\Foundation\Testing\Concerns\InteractsWithContainer::spy(0), map(["" => "@&\Mockery\MockInterface"]));
|
||||||
override(\Illuminate\Support\Arr::add(0), type(0));
|
override(\Illuminate\Support\Arr::add(0), type(0));
|
||||||
override(\Illuminate\Support\Arr::except(0), type(0));
|
override(\Illuminate\Support\Arr::except(0), type(0));
|
||||||
override(\Illuminate\Support\Arr::first(0), elementType(0));
|
override(\Illuminate\Support\Arr::first(0), elementType(0));
|
||||||
|
|||||||
+18
-12
@@ -17,8 +17,10 @@ use Barryvdh\Reflection\DocBlock\Serializer as DocBlockSerializer;
|
|||||||
use Barryvdh\Reflection\DocBlock\Tag\MethodTag;
|
use Barryvdh\Reflection\DocBlock\Tag\MethodTag;
|
||||||
use Closure;
|
use Closure;
|
||||||
use Illuminate\Config\Repository as ConfigRepository;
|
use Illuminate\Config\Repository as ConfigRepository;
|
||||||
|
use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
|
||||||
use Illuminate\Support\Facades\Facade;
|
use Illuminate\Support\Facades\Facade;
|
||||||
use ReflectionClass;
|
use ReflectionClass;
|
||||||
|
use Throwable;
|
||||||
|
|
||||||
class Alias
|
class Alias
|
||||||
{
|
{
|
||||||
@@ -39,6 +41,7 @@ class Alias
|
|||||||
protected $magicMethods = [];
|
protected $magicMethods = [];
|
||||||
protected $interfaces = [];
|
protected $interfaces = [];
|
||||||
protected $phpdoc = null;
|
protected $phpdoc = null;
|
||||||
|
protected $classAliases = [];
|
||||||
|
|
||||||
/** @var ConfigRepository */
|
/** @var ConfigRepository */
|
||||||
protected $config;
|
protected $config;
|
||||||
@@ -77,10 +80,11 @@ class Alias
|
|||||||
$this->detectExtendsNamespace();
|
$this->detectExtendsNamespace();
|
||||||
|
|
||||||
if (!empty($this->namespace)) {
|
if (!empty($this->namespace)) {
|
||||||
//Create a DocBlock and serializer instance
|
$this->classAliases = (new UsesResolver())->loadFromClass($this->root);
|
||||||
$this->phpdoc = new DocBlock(new ReflectionClass($alias), new Context($this->namespace));
|
|
||||||
}
|
|
||||||
|
|
||||||
|
//Create a DocBlock and serializer instance
|
||||||
|
$this->phpdoc = new DocBlock(new ReflectionClass($alias), new Context($this->namespace, $this->classAliases));
|
||||||
|
}
|
||||||
|
|
||||||
if ($facade === '\Illuminate\Database\Eloquent\Model') {
|
if ($facade === '\Illuminate\Database\Eloquent\Model') {
|
||||||
$this->usedMethods = ['decrement', 'increment'];
|
$this->usedMethods = ['decrement', 'increment'];
|
||||||
@@ -298,7 +302,7 @@ class Alias
|
|||||||
"\nPlease configure your database connection correctly, or use the sqlite memory driver (-M)." .
|
"\nPlease configure your database connection correctly, or use the sqlite memory driver (-M)." .
|
||||||
" Skipping $facade."
|
" Skipping $facade."
|
||||||
);
|
);
|
||||||
} catch (\Exception $e) {
|
} catch (Throwable $e) {
|
||||||
$this->error('Exception: ' . $e->getMessage() . "\nSkipping $facade.");
|
$this->error('Exception: ' . $e->getMessage() . "\nSkipping $facade.");
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -320,16 +324,16 @@ class Alias
|
|||||||
protected function addMagicMethods()
|
protected function addMagicMethods()
|
||||||
{
|
{
|
||||||
foreach ($this->magicMethods as $magic => $real) {
|
foreach ($this->magicMethods as $magic => $real) {
|
||||||
list($className, $name) = explode('::', $real);
|
[$className, $name] = explode('::', $real);
|
||||||
if ((!class_exists($className) && !interface_exists($className)) || !method_exists($className, $name)) {
|
if ((!class_exists($className) && !interface_exists($className)) || !method_exists($className, $name)) {
|
||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
$method = new \ReflectionMethod($className, $name);
|
$method = new \ReflectionMethod($className, $name);
|
||||||
$class = new \ReflectionClass($className);
|
$class = new ReflectionClass($className);
|
||||||
|
|
||||||
if (!in_array($magic, $this->usedMethods)) {
|
if (!in_array($magic, $this->usedMethods)) {
|
||||||
if ($class !== $this->root) {
|
if ($class !== $this->root) {
|
||||||
$this->methods[] = new Method($method, $this->alias, $class, $magic, $this->interfaces);
|
$this->methods[] = new Method($method, $this->alias, $class, $magic, $this->interfaces, $this->classAliases);
|
||||||
}
|
}
|
||||||
$this->usedMethods[] = $magic;
|
$this->usedMethods[] = $magic;
|
||||||
}
|
}
|
||||||
@@ -343,9 +347,8 @@ class Alias
|
|||||||
*/
|
*/
|
||||||
protected function detectMethods()
|
protected function detectMethods()
|
||||||
{
|
{
|
||||||
|
|
||||||
foreach ($this->classes as $class) {
|
foreach ($this->classes as $class) {
|
||||||
$reflection = new \ReflectionClass($class);
|
$reflection = new ReflectionClass($class);
|
||||||
|
|
||||||
$methods = $reflection->getMethods(\ReflectionMethod::IS_PUBLIC);
|
$methods = $reflection->getMethods(\ReflectionMethod::IS_PUBLIC);
|
||||||
if ($methods) {
|
if ($methods) {
|
||||||
@@ -359,7 +362,8 @@ class Alias
|
|||||||
$this->alias,
|
$this->alias,
|
||||||
$reflection,
|
$reflection,
|
||||||
$method->name,
|
$method->name,
|
||||||
$this->interfaces
|
$this->interfaces,
|
||||||
|
$this->classAliases
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
$this->usedMethods[] = $method->name;
|
$this->usedMethods[] = $method->name;
|
||||||
@@ -368,8 +372,9 @@ class Alias
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Check if the class is macroable
|
// Check if the class is macroable
|
||||||
|
// (Eloquent\Builder is also macroable but doesn't use Macroable trait)
|
||||||
$traits = collect($reflection->getTraitNames());
|
$traits = collect($reflection->getTraitNames());
|
||||||
if ($traits->contains('Illuminate\Support\Traits\Macroable')) {
|
if ($traits->contains('Illuminate\Support\Traits\Macroable') || $class === EloquentBuilder::class) {
|
||||||
$properties = $reflection->getStaticProperties();
|
$properties = $reflection->getStaticProperties();
|
||||||
$macros = isset($properties['macros']) ? $properties['macros'] : [];
|
$macros = isset($properties['macros']) ? $properties['macros'] : [];
|
||||||
foreach ($macros as $macro_name => $macro_func) {
|
foreach ($macros as $macro_name => $macro_func) {
|
||||||
@@ -380,7 +385,8 @@ class Alias
|
|||||||
$this->alias,
|
$this->alias,
|
||||||
$reflection,
|
$reflection,
|
||||||
$macro_name,
|
$macro_name,
|
||||||
$this->interfaces
|
$this->interfaces,
|
||||||
|
$this->classAliases
|
||||||
);
|
);
|
||||||
$this->usedMethods[] = $macro_name;
|
$this->usedMethods[] = $macro_name;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -42,7 +42,7 @@ class GeneratorCommand extends Command
|
|||||||
/** @var \Illuminate\Config\Repository */
|
/** @var \Illuminate\Config\Repository */
|
||||||
protected $config;
|
protected $config;
|
||||||
|
|
||||||
/** @var \Illuminate\Filesystem\Filesystem */
|
/** @var Filesystem */
|
||||||
protected $files;
|
protected $files;
|
||||||
|
|
||||||
/** @var \Illuminate\View\Factory */
|
/** @var \Illuminate\View\Factory */
|
||||||
@@ -54,7 +54,7 @@ class GeneratorCommand extends Command
|
|||||||
/**
|
/**
|
||||||
*
|
*
|
||||||
* @param \Illuminate\Config\Repository $config
|
* @param \Illuminate\Config\Repository $config
|
||||||
* @param \Illuminate\Filesystem\Filesystem $files
|
* @param Filesystem $files
|
||||||
* @param \Illuminate\View\Factory $view
|
* @param \Illuminate\View\Factory $view
|
||||||
*/
|
*/
|
||||||
public function __construct(
|
public function __construct(
|
||||||
|
|||||||
@@ -13,6 +13,7 @@ namespace Barryvdh\LaravelIdeHelper\Console;
|
|||||||
|
|
||||||
use Barryvdh\LaravelIdeHelper\Factories;
|
use Barryvdh\LaravelIdeHelper\Factories;
|
||||||
use Illuminate\Console\Command;
|
use Illuminate\Console\Command;
|
||||||
|
use RuntimeException;
|
||||||
use Symfony\Component\Console\Input\InputOption;
|
use Symfony\Component\Console\Input\InputOption;
|
||||||
use Symfony\Component\Console\Output\OutputInterface;
|
use Symfony\Component\Console\Output\OutputInterface;
|
||||||
|
|
||||||
@@ -84,7 +85,7 @@ class MetaCommand extends Command
|
|||||||
// Needs to run before exception handler is registered
|
// Needs to run before exception handler is registered
|
||||||
$factories = $this->config->get('ide-helper.include_factory_builders') ? Factories::all() : [];
|
$factories = $this->config->get('ide-helper.include_factory_builders') ? Factories::all() : [];
|
||||||
|
|
||||||
$this->registerClassAutoloadExceptions();
|
$ourAutoloader = $this->registerClassAutoloadExceptions();
|
||||||
|
|
||||||
$bindings = [];
|
$bindings = [];
|
||||||
foreach ($this->getAbstracts() as $abstract) {
|
foreach ($this->getAbstracts() as $abstract) {
|
||||||
@@ -95,6 +96,11 @@ class MetaCommand extends Command
|
|||||||
|
|
||||||
try {
|
try {
|
||||||
$concrete = $this->laravel->make($abstract);
|
$concrete = $this->laravel->make($abstract);
|
||||||
|
|
||||||
|
if ($concrete === null) {
|
||||||
|
throw new RuntimeException("Cannot create instance for '$abstract', received 'null'");
|
||||||
|
}
|
||||||
|
|
||||||
$reflectionClass = new \ReflectionClass($concrete);
|
$reflectionClass = new \ReflectionClass($concrete);
|
||||||
if (is_object($concrete) && !$reflectionClass->isAnonymous()) {
|
if (is_object($concrete) && !$reflectionClass->isAnonymous()) {
|
||||||
$bindings[$abstract] = get_class($concrete);
|
$bindings[$abstract] = get_class($concrete);
|
||||||
@@ -106,7 +112,7 @@ class MetaCommand extends Command
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
$this->unregisterClassAutoloadExceptions();
|
$this->unregisterClassAutoloadExceptions($ourAutoloader);
|
||||||
|
|
||||||
$content = $this->view->make('meta', [
|
$content = $this->view->make('meta', [
|
||||||
'bindings' => $bindings,
|
'bindings' => $bindings,
|
||||||
@@ -143,12 +149,16 @@ class MetaCommand extends Command
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Register an autoloader the throws exceptions when a class is not found.
|
* Register an autoloader the throws exceptions when a class is not found.
|
||||||
|
*
|
||||||
|
* @return callable
|
||||||
*/
|
*/
|
||||||
protected function registerClassAutoloadExceptions()
|
protected function registerClassAutoloadExceptions(): callable
|
||||||
{
|
{
|
||||||
spl_autoload_register(function ($class) {
|
$autoloader = function ($class) {
|
||||||
throw new \ReflectionException("Class '$class' not found.");
|
throw new \ReflectionException("Class '$class' not found.");
|
||||||
});
|
};
|
||||||
|
spl_autoload_register($autoloader);
|
||||||
|
return $autoloader;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -167,11 +177,11 @@ class MetaCommand extends Command
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Remove our custom autoloader that we pushed onto the autoload stack
|
* Remove our custom autoloader that we pushed onto the autoload stack
|
||||||
|
*
|
||||||
|
* @param callable $ourAutoloader
|
||||||
*/
|
*/
|
||||||
private function unregisterClassAutoloadExceptions()
|
private function unregisterClassAutoloadExceptions(callable $ourAutoloader): void
|
||||||
{
|
{
|
||||||
$autoloadFunctions = spl_autoload_functions();
|
|
||||||
$ourAutoloader = array_pop($autoloadFunctions);
|
|
||||||
spl_autoload_unregister($ourAutoloader);
|
spl_autoload_unregister($ourAutoloader);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
+518
-86
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,11 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Contracts;
|
||||||
|
|
||||||
|
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
|
||||||
|
use Illuminate\Database\Eloquent\Model;
|
||||||
|
|
||||||
|
interface ModelHookInterface
|
||||||
|
{
|
||||||
|
public function run(ModelsCommand $command, Model $model): void;
|
||||||
|
}
|
||||||
+65
-16
@@ -13,8 +13,13 @@ namespace Barryvdh\LaravelIdeHelper;
|
|||||||
|
|
||||||
use Illuminate\Foundation\AliasLoader;
|
use Illuminate\Foundation\AliasLoader;
|
||||||
use Illuminate\Support\Collection;
|
use Illuminate\Support\Collection;
|
||||||
|
use Illuminate\Support\Facades\Facade;
|
||||||
use Illuminate\Support\Str;
|
use Illuminate\Support\Str;
|
||||||
use Illuminate\Support\Traits\Macroable;
|
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 ReflectionClass;
|
||||||
use Symfony\Component\Console\Output\OutputInterface;
|
use Symfony\Component\Console\Output\OutputInterface;
|
||||||
|
|
||||||
@@ -26,7 +31,7 @@ class Generator
|
|||||||
/** @var \Illuminate\View\Factory */
|
/** @var \Illuminate\View\Factory */
|
||||||
protected $view;
|
protected $view;
|
||||||
|
|
||||||
/** @var \Symfony\Component\Console\Output\OutputInterface */
|
/** @var OutputInterface */
|
||||||
protected $output;
|
protected $output;
|
||||||
|
|
||||||
protected $extra = [];
|
protected $extra = [];
|
||||||
@@ -37,7 +42,7 @@ class Generator
|
|||||||
/**
|
/**
|
||||||
* @param \Illuminate\Config\Repository $config
|
* @param \Illuminate\Config\Repository $config
|
||||||
* @param \Illuminate\View\Factory $view
|
* @param \Illuminate\View\Factory $view
|
||||||
* @param \Symfony\Component\Console\Output\OutputInterface $output
|
* @param OutputInterface $output
|
||||||
* @param string $helpers
|
* @param string $helpers
|
||||||
*/
|
*/
|
||||||
public function __construct(
|
public function __construct(
|
||||||
@@ -54,9 +59,9 @@ class Generator
|
|||||||
// Find the drivers to add to the extra/interfaces
|
// Find the drivers to add to the extra/interfaces
|
||||||
$this->detectDrivers();
|
$this->detectDrivers();
|
||||||
|
|
||||||
$this->extra = array_merge($this->extra, $this->config->get('ide-helper.extra'));
|
$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->magic = array_merge($this->magic, $this->config->get('ide-helper.magic'), []);
|
||||||
$this->interfaces = array_merge($this->interfaces, $this->config->get('ide-helper.interfaces'));
|
$this->interfaces = array_merge($this->interfaces, $this->config->get('ide-helper.interfaces'), []);
|
||||||
// Make all interface classes absolute
|
// Make all interface classes absolute
|
||||||
foreach ($this->interfaces as &$interface) {
|
foreach ($this->interfaces as &$interface) {
|
||||||
$interface = '\\' . ltrim($interface, '\\');
|
$interface = '\\' . ltrim($interface, '\\');
|
||||||
@@ -75,6 +80,7 @@ class Generator
|
|||||||
return $this->view->make('helper')
|
return $this->view->make('helper')
|
||||||
->with('namespaces_by_extends_ns', $this->getAliasesByExtendsNamespace())
|
->with('namespaces_by_extends_ns', $this->getAliasesByExtendsNamespace())
|
||||||
->with('namespaces_by_alias_ns', $this->getAliasesByAliasNamespace())
|
->with('namespaces_by_alias_ns', $this->getAliasesByAliasNamespace())
|
||||||
|
->with('real_time_facades', $this->getRealTimeFacades())
|
||||||
->with('helpers', $this->helpers)
|
->with('helpers', $this->helpers)
|
||||||
->with('version', $app->version())
|
->with('version', $app->version())
|
||||||
->with('include_fluent', $this->config->get('ide-helper.include_fluent', true))
|
->with('include_fluent', $this->config->get('ide-helper.include_fluent', true))
|
||||||
@@ -127,15 +133,6 @@ class Generator
|
|||||||
} catch (\Exception $e) {
|
} catch (\Exception $e) {
|
||||||
}
|
}
|
||||||
|
|
||||||
try {
|
|
||||||
if (class_exists('SSH') && is_a('SSH', '\Illuminate\Support\Facades\SSH', true)) {
|
|
||||||
$class = get_class(\SSH::connection());
|
|
||||||
$this->extra['SSH'] = [$class];
|
|
||||||
$this->interfaces['\Illuminate\Remote\ConnectionInterface'] = $class;
|
|
||||||
}
|
|
||||||
} catch (\Exception $e) {
|
|
||||||
}
|
|
||||||
|
|
||||||
try {
|
try {
|
||||||
if (class_exists('Storage') && is_a('Storage', '\Illuminate\Support\Facades\Storage', true)) {
|
if (class_exists('Storage') && is_a('Storage', '\Illuminate\Support\Facades\Storage', true)) {
|
||||||
$class = get_class(\Storage::disk());
|
$class = get_class(\Storage::disk());
|
||||||
@@ -162,6 +159,11 @@ class Generator
|
|||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Skip the swoole
|
||||||
|
if ($facade == 'SwooleTW\Http\Server\Facades\Server' && $name == 'Server' && !class_exists('Swoole\Http\Server')) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
$magicMethods = array_key_exists($name, $this->magic) ? $this->magic[$name] : [];
|
$magicMethods = array_key_exists($name, $this->magic) ? $this->magic[$name] : [];
|
||||||
$alias = new Alias($this->config, $name, $facade, $magicMethods, $this->interfaces);
|
$alias = new Alias($this->config, $name, $facade, $magicMethods, $this->interfaces);
|
||||||
if ($alias->isValid()) {
|
if ($alias->isValid()) {
|
||||||
@@ -177,6 +179,51 @@ class Generator
|
|||||||
return $aliases;
|
return $aliases;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
protected function getRealTimeFacades()
|
||||||
|
{
|
||||||
|
$facades = [];
|
||||||
|
$realTimeFacadeFiles = glob(storage_path('framework/cache/facade-*.php'));
|
||||||
|
foreach ($realTimeFacadeFiles as $file) {
|
||||||
|
try {
|
||||||
|
$name = $this->getFullyQualifiedClassNameInFile($file);
|
||||||
|
$facades[$name] = $name;
|
||||||
|
} catch (\Exception $e) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return $facades;
|
||||||
|
}
|
||||||
|
|
||||||
|
protected function getFullyQualifiedClassNameInFile(string $path)
|
||||||
|
{
|
||||||
|
$contents = file_get_contents($path);
|
||||||
|
|
||||||
|
$parsers = new Php7(new Emulative());
|
||||||
|
|
||||||
|
$parsed = collect($parsers->parse($contents) ?: []);
|
||||||
|
|
||||||
|
$namespace = $parsed->first(function ($node) {
|
||||||
|
return $node instanceof Namespace_;
|
||||||
|
});
|
||||||
|
|
||||||
|
if ($namespace) {
|
||||||
|
$name = $namespace->name->toString();
|
||||||
|
|
||||||
|
$class = collect($namespace->stmts)->first(function ($node) {
|
||||||
|
return $node instanceof Class_;
|
||||||
|
});
|
||||||
|
|
||||||
|
if ($class) {
|
||||||
|
$name .= '\\' . $class->name->toString();
|
||||||
|
}
|
||||||
|
|
||||||
|
return $name;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Regroup aliases by namespace of extended classes
|
* Regroup aliases by namespace of extended classes
|
||||||
*
|
*
|
||||||
@@ -184,7 +231,9 @@ class Generator
|
|||||||
*/
|
*/
|
||||||
protected function getAliasesByExtendsNamespace()
|
protected function getAliasesByExtendsNamespace()
|
||||||
{
|
{
|
||||||
$aliases = $this->getValidAliases();
|
$aliases = $this->getValidAliases()->filter(static function (Alias $alias) {
|
||||||
|
return is_subclass_of($alias->getExtends(), Facade::class);
|
||||||
|
});
|
||||||
|
|
||||||
$this->addMacroableClasses($aliases);
|
$this->addMacroableClasses($aliases);
|
||||||
|
|
||||||
@@ -296,7 +345,7 @@ class Generator
|
|||||||
return !$reflection->isInternal() && $reflection->getName() === $class;
|
return !$reflection->isInternal() && $reflection->getName() === $class;
|
||||||
})
|
})
|
||||||
->filter(function ($class) {
|
->filter(function ($class) {
|
||||||
$traits = class_uses($class);
|
$traits = class_uses_recursive($class);
|
||||||
|
|
||||||
// Filter only classes with the macroable trait
|
// Filter only classes with the macroable trait
|
||||||
return isset($traits[Macroable::class]);
|
return isset($traits[Macroable::class]);
|
||||||
|
|||||||
@@ -1,13 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
declare(strict_types=1);
|
|
||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper;
|
|
||||||
|
|
||||||
class Helpers
|
|
||||||
{
|
|
||||||
public static function isLaravel(): bool
|
|
||||||
{
|
|
||||||
return class_exists('Illuminate\Foundation\Application');
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -15,8 +15,10 @@ use Barryvdh\LaravelIdeHelper\Console\EloquentCommand;
|
|||||||
use Barryvdh\LaravelIdeHelper\Console\GeneratorCommand;
|
use Barryvdh\LaravelIdeHelper\Console\GeneratorCommand;
|
||||||
use Barryvdh\LaravelIdeHelper\Console\MetaCommand;
|
use Barryvdh\LaravelIdeHelper\Console\MetaCommand;
|
||||||
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
|
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
|
||||||
|
use Barryvdh\LaravelIdeHelper\Listeners\GenerateModelHelper;
|
||||||
|
use Illuminate\Console\Events\CommandFinished;
|
||||||
use Illuminate\Contracts\Support\DeferrableProvider;
|
use Illuminate\Contracts\Support\DeferrableProvider;
|
||||||
use Illuminate\Foundation\Application;
|
use Illuminate\Database\Events\MigrationsEnded;
|
||||||
use Illuminate\Support\ServiceProvider;
|
use Illuminate\Support\ServiceProvider;
|
||||||
use Illuminate\View\Engines\EngineResolver;
|
use Illuminate\View\Engines\EngineResolver;
|
||||||
use Illuminate\View\Engines\PhpEngine;
|
use Illuminate\View\Engines\PhpEngine;
|
||||||
@@ -32,6 +34,13 @@ class IdeHelperServiceProvider extends ServiceProvider implements DeferrableProv
|
|||||||
*/
|
*/
|
||||||
public function boot()
|
public function boot()
|
||||||
{
|
{
|
||||||
|
if (!$this->app->runningUnitTests() && $this->app['config']->get('ide-helper.post_migrate', [])) {
|
||||||
|
$this->app['events']->listen(CommandFinished::class, GenerateModelHelper::class);
|
||||||
|
$this->app['events']->listen(MigrationsEnded::class, function () {
|
||||||
|
GenerateModelHelper::$shouldRun = true;
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
if ($this->app->has('view')) {
|
if ($this->app->has('view')) {
|
||||||
$viewPath = __DIR__ . '/../resources/views';
|
$viewPath = __DIR__ . '/../resources/views';
|
||||||
$this->loadViewsFrom($viewPath, 'ide-helper');
|
$this->loadViewsFrom($viewPath, 'ide-helper');
|
||||||
@@ -110,10 +119,6 @@ class IdeHelperServiceProvider extends ServiceProvider implements DeferrableProv
|
|||||||
{
|
{
|
||||||
$resolver = new EngineResolver();
|
$resolver = new EngineResolver();
|
||||||
$resolver->register('php', function () {
|
$resolver->register('php', function () {
|
||||||
if (Helpers::isLaravel() && (int) Application::VERSION < 8) {
|
|
||||||
return new PhpEngine();
|
|
||||||
}
|
|
||||||
|
|
||||||
return new PhpEngine($this->app['files']);
|
return new PhpEngine($this->app['files']);
|
||||||
});
|
});
|
||||||
$finder = new FileViewFinder($this->app['files'], [__DIR__ . '/../resources/views']);
|
$finder = new FileViewFinder($this->app['files'], [__DIR__ . '/../resources/views']);
|
||||||
|
|||||||
@@ -0,0 +1,52 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Listeners;
|
||||||
|
|
||||||
|
use Illuminate\Console\Events\CommandFinished;
|
||||||
|
use Illuminate\Contracts\Config\Repository as Config;
|
||||||
|
use Illuminate\Contracts\Console\Kernel as Artisan;
|
||||||
|
|
||||||
|
class GenerateModelHelper
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Tracks whether we should run the models command on the CommandFinished event or not.
|
||||||
|
* Set to true by the MigrationsEnded event, needs to be cleared before artisan call to prevent infinite loop.
|
||||||
|
*
|
||||||
|
* @var bool
|
||||||
|
*/
|
||||||
|
public static $shouldRun = false;
|
||||||
|
|
||||||
|
/** @var Artisan */
|
||||||
|
protected $artisan;
|
||||||
|
|
||||||
|
/** @var Config */
|
||||||
|
protected $config;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param Artisan $artisan
|
||||||
|
* @param Config $config
|
||||||
|
*/
|
||||||
|
public function __construct(Artisan $artisan, Config $config)
|
||||||
|
{
|
||||||
|
$this->artisan = $artisan;
|
||||||
|
$this->config = $config;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Handle the event.
|
||||||
|
*
|
||||||
|
* @param CommandFinished $event
|
||||||
|
*/
|
||||||
|
public function handle(CommandFinished $event)
|
||||||
|
{
|
||||||
|
if (!self::$shouldRun) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
self::$shouldRun = false;
|
||||||
|
|
||||||
|
foreach ($this->config->get('ide-helper.post_migrate', []) as $command) {
|
||||||
|
$this->artisan->call($command, [], $event->output);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
+56
-15
@@ -4,6 +4,7 @@ namespace Barryvdh\LaravelIdeHelper;
|
|||||||
|
|
||||||
use Barryvdh\Reflection\DocBlock;
|
use Barryvdh\Reflection\DocBlock;
|
||||||
use Barryvdh\Reflection\DocBlock\Tag;
|
use Barryvdh\Reflection\DocBlock\Tag;
|
||||||
|
use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
|
||||||
use Illuminate\Support\Collection;
|
use Illuminate\Support\Collection;
|
||||||
|
|
||||||
class Macro extends Method
|
class Macro extends Method
|
||||||
@@ -16,15 +17,17 @@ class Macro extends Method
|
|||||||
* @param \ReflectionClass $class
|
* @param \ReflectionClass $class
|
||||||
* @param null $methodName
|
* @param null $methodName
|
||||||
* @param array $interfaces
|
* @param array $interfaces
|
||||||
|
* @param array $classAliases
|
||||||
*/
|
*/
|
||||||
public function __construct(
|
public function __construct(
|
||||||
$method,
|
$method,
|
||||||
$alias,
|
$alias,
|
||||||
$class,
|
$class,
|
||||||
$methodName = null,
|
$methodName = null,
|
||||||
$interfaces = []
|
$interfaces = [],
|
||||||
|
$classAliases = []
|
||||||
) {
|
) {
|
||||||
parent::__construct($method, $alias, $class, $methodName, $interfaces);
|
parent::__construct($method, $alias, $class, $methodName, $interfaces, $classAliases);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -32,34 +35,72 @@ class Macro extends Method
|
|||||||
*/
|
*/
|
||||||
protected function initPhpDoc($method)
|
protected function initPhpDoc($method)
|
||||||
{
|
{
|
||||||
$this->phpdoc = new DocBlock('/** */');
|
$this->phpdoc = new DocBlock($method);
|
||||||
|
|
||||||
$this->addLocationToPhpDoc();
|
$this->addLocationToPhpDoc();
|
||||||
|
|
||||||
// Add macro parameters
|
// Add macro parameters if they are missed in original docblock
|
||||||
foreach ($method->getParameters() as $parameter) {
|
if (!$this->phpdoc->hasTag('param')) {
|
||||||
$type = $parameter->hasType() ? $parameter->getType()->getName() : 'mixed';
|
foreach ($method->getParameters() as $parameter) {
|
||||||
$type .= $parameter->hasType() && $parameter->getType()->allowsNull() ? '|null' : '';
|
$reflectionType = $parameter->getType();
|
||||||
|
|
||||||
$name = $parameter->isVariadic() ? '...' : '';
|
$type = $this->concatReflectionTypes($reflectionType);
|
||||||
$name .= '$' . $parameter->getName();
|
|
||||||
|
|
||||||
$this->phpdoc->appendTag(Tag::createInstance("@param {$type} {$name}"));
|
/** @psalm-suppress UndefinedClass */
|
||||||
|
if ($reflectionType && !$reflectionType instanceof \ReflectionUnionType && $reflectionType->allowsNull()) {
|
||||||
|
$type .= '|null';
|
||||||
|
}
|
||||||
|
|
||||||
|
$type = $type ?: 'mixed';
|
||||||
|
|
||||||
|
$name = $parameter->isVariadic() ? '...' : '';
|
||||||
|
$name .= '$' . $parameter->getName();
|
||||||
|
|
||||||
|
$this->phpdoc->appendTag(Tag::createInstance("@param {$type} {$name}"));
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Add macro return type
|
// Add macro return type if it missed in original docblock
|
||||||
if ($method->hasReturnType()) {
|
if ($method->hasReturnType() && !$this->phpdoc->hasTag('return')) {
|
||||||
$type = $method->getReturnType()->getName();
|
$builder = EloquentBuilder::class;
|
||||||
$type .= $method->getReturnType()->allowsNull() ? '|null' : '';
|
$return = $method->getReturnType();
|
||||||
|
|
||||||
|
$type = $this->concatReflectionTypes($return);
|
||||||
|
|
||||||
|
/** @psalm-suppress UndefinedClass */
|
||||||
|
if (!$return instanceof \ReflectionUnionType) {
|
||||||
|
$type .= $this->root === "\\{$builder}" && $return->getName() === $builder ? '|static' : '';
|
||||||
|
$type .= $return->allowsNull() ? '|null' : '';
|
||||||
|
}
|
||||||
|
|
||||||
$this->phpdoc->appendTag(Tag::createInstance("@return {$type}"));
|
$this->phpdoc->appendTag(Tag::createInstance("@return {$type}"));
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
protected function concatReflectionTypes(?\ReflectionType $type): string
|
||||||
|
{
|
||||||
|
/** @psalm-suppress UndefinedClass */
|
||||||
|
$returnTypes = $type instanceof \ReflectionUnionType
|
||||||
|
? $type->getTypes()
|
||||||
|
: [$type];
|
||||||
|
|
||||||
|
return Collection::make($returnTypes)
|
||||||
|
->filter()
|
||||||
|
->map->getName()
|
||||||
|
->implode('|');
|
||||||
|
}
|
||||||
|
|
||||||
protected function addLocationToPhpDoc()
|
protected function addLocationToPhpDoc()
|
||||||
{
|
{
|
||||||
$enclosingClass = $this->method->getClosureScopeClass();
|
if ($this->method->name === '__invoke') {
|
||||||
|
$enclosingClass = $this->method->getDeclaringClass();
|
||||||
|
} else {
|
||||||
|
$enclosingClass = $this->method->getClosureScopeClass();
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!$enclosingClass) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
/** @var \ReflectionMethod $enclosingMethod */
|
/** @var \ReflectionMethod $enclosingMethod */
|
||||||
$enclosingMethod = Collection::make($enclosingClass->getMethods())
|
$enclosingMethod = Collection::make($enclosingClass->getMethods())
|
||||||
->first(function (\ReflectionMethod $method) {
|
->first(function (\ReflectionMethod $method) {
|
||||||
|
|||||||
+8
-5
@@ -22,7 +22,7 @@ use Illuminate\Support\Str;
|
|||||||
|
|
||||||
class Method
|
class Method
|
||||||
{
|
{
|
||||||
/** @var \Barryvdh\Reflection\DocBlock */
|
/** @var DocBlock */
|
||||||
protected $phpdoc;
|
protected $phpdoc;
|
||||||
|
|
||||||
/** @var \ReflectionMethod */
|
/** @var \ReflectionMethod */
|
||||||
@@ -38,6 +38,7 @@ class Method
|
|||||||
protected $real_name;
|
protected $real_name;
|
||||||
protected $return = null;
|
protected $return = null;
|
||||||
protected $root;
|
protected $root;
|
||||||
|
protected $classAliases;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param \ReflectionMethod|\ReflectionFunctionAbstract $method
|
* @param \ReflectionMethod|\ReflectionFunctionAbstract $method
|
||||||
@@ -45,17 +46,19 @@ class Method
|
|||||||
* @param \ReflectionClass $class
|
* @param \ReflectionClass $class
|
||||||
* @param string|null $methodName
|
* @param string|null $methodName
|
||||||
* @param array $interfaces
|
* @param array $interfaces
|
||||||
|
* @param array $classAliases
|
||||||
*/
|
*/
|
||||||
public function __construct($method, $alias, $class, $methodName = null, $interfaces = [])
|
public function __construct($method, $alias, $class, $methodName = null, $interfaces = [], array $classAliases = [])
|
||||||
{
|
{
|
||||||
$this->method = $method;
|
$this->method = $method;
|
||||||
$this->interfaces = $interfaces;
|
$this->interfaces = $interfaces;
|
||||||
|
$this->classAliases = $classAliases;
|
||||||
$this->name = $methodName ?: $method->name;
|
$this->name = $methodName ?: $method->name;
|
||||||
$this->real_name = $method->isClosure() ? $this->name : $method->name;
|
$this->real_name = $method->isClosure() ? $this->name : $method->name;
|
||||||
$this->initClassDefinedProperties($method, $class);
|
$this->initClassDefinedProperties($method, $class);
|
||||||
|
|
||||||
//Reference the 'real' function in the declaring class
|
//Reference the 'real' function in the declaring class
|
||||||
$this->root = '\\' . ltrim($class->getName(), '\\');
|
$this->root = '\\' . ltrim($method->name === '__invoke' ? $method->getDeclaringClass()->getName() : $class->getName(), '\\');
|
||||||
|
|
||||||
//Create a DocBlock and serializer instance
|
//Create a DocBlock and serializer instance
|
||||||
$this->initPhpDoc($method);
|
$this->initPhpDoc($method);
|
||||||
@@ -80,7 +83,7 @@ class Method
|
|||||||
*/
|
*/
|
||||||
protected function initPhpDoc($method)
|
protected function initPhpDoc($method)
|
||||||
{
|
{
|
||||||
$this->phpdoc = new DocBlock($method, new Context($this->namespace));
|
$this->phpdoc = new DocBlock($method, new Context($this->namespace, $this->classAliases));
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -363,7 +366,7 @@ class Method
|
|||||||
}
|
}
|
||||||
if ($method) {
|
if ($method) {
|
||||||
$namespace = $method->getDeclaringClass()->getNamespaceName();
|
$namespace = $method->getDeclaringClass()->getNamespaceName();
|
||||||
$phpdoc = new DocBlock($method, new Context($namespace));
|
$phpdoc = new DocBlock($method, new Context($namespace, $this->classAliases));
|
||||||
|
|
||||||
if (strpos($phpdoc->getText(), '{@inheritdoc}') !== false) {
|
if (strpos($phpdoc->getText(), '{@inheritdoc}') !== false) {
|
||||||
//Not at the end yet, try another parent/interface..
|
//Not at the end yet, try another parent/interface..
|
||||||
|
|||||||
@@ -0,0 +1,124 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Laravel IDE Helper Generator
|
||||||
|
*
|
||||||
|
* @author Barry vd. Heuvel <[email protected]>
|
||||||
|
* @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);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,105 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests;
|
||||||
|
|
||||||
|
use Barryvdh\LaravelIdeHelper\Alias;
|
||||||
|
use Barryvdh\LaravelIdeHelper\Macro;
|
||||||
|
use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
|
||||||
|
use Illuminate\Database\Query\Builder;
|
||||||
|
use Illuminate\Support\Arr;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @internal
|
||||||
|
* @coversDefaultClass \Barryvdh\LaravelIdeHelper\Alias
|
||||||
|
*/
|
||||||
|
class AliasTest extends TestCase
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* @covers ::detectMethods
|
||||||
|
*/
|
||||||
|
public function testDetectMethodsMacroableMacros(): void
|
||||||
|
{
|
||||||
|
// Mock
|
||||||
|
$macro = __FUNCTION__;
|
||||||
|
$alias = new AliasMock();
|
||||||
|
|
||||||
|
// Macros
|
||||||
|
Builder::macro(
|
||||||
|
$macro,
|
||||||
|
function () {
|
||||||
|
// empty
|
||||||
|
}
|
||||||
|
);
|
||||||
|
|
||||||
|
// Prepare
|
||||||
|
$alias->setClasses([Builder::class]);
|
||||||
|
$alias->detectMethods();
|
||||||
|
|
||||||
|
// Test
|
||||||
|
$this->assertNotNull($this->getAliasMacro($alias, Builder::class, $macro));
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @covers ::detectMethods
|
||||||
|
*/
|
||||||
|
public function testDetectMethodsEloquentBuilderMacros(): void
|
||||||
|
{
|
||||||
|
// Mock
|
||||||
|
$macro = __FUNCTION__;
|
||||||
|
$alias = new AliasMock();
|
||||||
|
|
||||||
|
// Macros
|
||||||
|
EloquentBuilder::macro(
|
||||||
|
$macro,
|
||||||
|
function () {
|
||||||
|
// empty
|
||||||
|
}
|
||||||
|
);
|
||||||
|
|
||||||
|
// Prepare
|
||||||
|
$alias->setClasses([EloquentBuilder::class]);
|
||||||
|
$alias->detectMethods();
|
||||||
|
|
||||||
|
// Test
|
||||||
|
$this->assertNotNull($this->getAliasMacro($alias, EloquentBuilder::class, $macro));
|
||||||
|
}
|
||||||
|
|
||||||
|
protected function getAliasMacro(Alias $alias, string $class, string $method): ?Macro
|
||||||
|
{
|
||||||
|
return Arr::first(
|
||||||
|
$alias->getMethods(),
|
||||||
|
function ($macro) use ($class, $method) {
|
||||||
|
return $macro instanceof Macro
|
||||||
|
&& $macro->getDeclaringClass() === "\\{$class}"
|
||||||
|
&& $macro->getName() === $method;
|
||||||
|
}
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @internal
|
||||||
|
* @noinspection PhpMultipleClassesDeclarationsInOneFile
|
||||||
|
*/
|
||||||
|
class AliasMock extends Alias
|
||||||
|
{
|
||||||
|
public function __construct()
|
||||||
|
{
|
||||||
|
// no need to call parent
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param string[] $classes
|
||||||
|
*/
|
||||||
|
public function setClasses(array $classes)
|
||||||
|
{
|
||||||
|
$this->classes = $classes;
|
||||||
|
}
|
||||||
|
|
||||||
|
public function detectMethods()
|
||||||
|
{
|
||||||
|
parent::detectMethods();
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -45,12 +45,15 @@ class EloquentCommandTest extends TestCase
|
|||||||
$this->assertMatchesTxtSnapshot($actualContent);
|
$this->assertMatchesTxtSnapshot($actualContent);
|
||||||
|
|
||||||
$display = $tester->getDisplay();
|
$display = $tester->getDisplay();
|
||||||
$this->assertRegExp(
|
$this->assertMatchesRegularExpression(
|
||||||
';Unexpected no document on Illuminate\\\Database\\\Eloquent\\\Model;',
|
';Unexpected no document on Illuminate\\\Database\\\Eloquent\\\Model;',
|
||||||
$display
|
$display
|
||||||
);
|
);
|
||||||
$this->assertRegExp(
|
$modelClassFilePath = preg_quote(
|
||||||
';Wrote expected docblock to .*/vendor/laravel/framework/src/Illuminate/Database/Eloquent/Model.php;',
|
str_replace('/', DIRECTORY_SEPARATOR, '/vendor/laravel/framework/src/Illuminate/Database/Eloquent/Model.php')
|
||||||
|
);
|
||||||
|
$this->assertMatchesRegularExpression(
|
||||||
|
';Wrote expected docblock to .*' . $modelClassFilePath . ';',
|
||||||
$display
|
$display
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -8,6 +8,7 @@ use Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider;
|
|||||||
use Barryvdh\LaravelIdeHelper\Tests\TestCase;
|
use Barryvdh\LaravelIdeHelper\Tests\TestCase;
|
||||||
use Illuminate\Filesystem\Filesystem;
|
use Illuminate\Filesystem\Filesystem;
|
||||||
use Mockery\MockInterface;
|
use Mockery\MockInterface;
|
||||||
|
use stdClass;
|
||||||
|
|
||||||
class MetaCommandTest extends TestCase
|
class MetaCommandTest extends TestCase
|
||||||
{
|
{
|
||||||
@@ -37,6 +38,38 @@ class MetaCommandTest extends TestCase
|
|||||||
self::assertStringContainsString('override(', $this->mockFilesystemOutput);
|
self::assertStringContainsString('override(', $this->mockFilesystemOutput);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public function testUnregisterAutoloader(): void
|
||||||
|
{
|
||||||
|
$current = spl_autoload_functions();
|
||||||
|
$appended = function () {
|
||||||
|
};
|
||||||
|
|
||||||
|
$this->app->bind('registers-autoloader', function () use ($appended) {
|
||||||
|
spl_autoload_register($appended);
|
||||||
|
return new stdClass();
|
||||||
|
});
|
||||||
|
|
||||||
|
$this->mockFilesystem();
|
||||||
|
|
||||||
|
/** @var Filesystem|MockInterface $mockFileSystem */
|
||||||
|
$mockFileSystem = $this->app->make(Filesystem::class);
|
||||||
|
$this->instance('files', $mockFileSystem);
|
||||||
|
|
||||||
|
$mockFileSystem
|
||||||
|
->shouldReceive('getRequire')
|
||||||
|
->andReturnUsing(function ($__path, $__data) {
|
||||||
|
return (static function () use ($__path, $__data) {
|
||||||
|
extract($__data, EXTR_SKIP);
|
||||||
|
|
||||||
|
return require $__path;
|
||||||
|
})();
|
||||||
|
});
|
||||||
|
|
||||||
|
$this->artisan('ide-helper:meta');
|
||||||
|
|
||||||
|
self::assertSame(array_merge($current, [$appended]), spl_autoload_functions());
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get package providers.
|
* Get package providers.
|
||||||
*
|
*
|
||||||
|
|||||||
@@ -0,0 +1,29 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts\Models;
|
||||||
|
|
||||||
|
use Illuminate\Database\Eloquent\Casts\AsArrayObject;
|
||||||
|
use Illuminate\Database\Eloquent\Casts\AsCollection;
|
||||||
|
use Illuminate\Database\Eloquent\Model;
|
||||||
|
|
||||||
|
class AdvancedCast extends Model
|
||||||
|
{
|
||||||
|
protected $casts = [
|
||||||
|
'cast_to_date_serialization' => 'date:Y-m-d',
|
||||||
|
'cast_to_datetime_serialization' => 'datetime:Y-m-d H:i:s',
|
||||||
|
'cast_to_custom_datetime' => 'custom_datetime:Y-m-d H:i:s',
|
||||||
|
'cast_to_immutable_date' => 'immutable_date',
|
||||||
|
'cast_to_immutable_custom_datetime' => 'immutable_custom_datetime:Y-m-d H:i:s',
|
||||||
|
'cast_to_immutable_datetime' => 'immutable_datetime',
|
||||||
|
'cast_to_timestamp' => 'timestamp',
|
||||||
|
'cast_to_encrypted' => 'encrypted',
|
||||||
|
'cast_to_encrypted_array' => 'encrypted:array',
|
||||||
|
'cast_to_encrypted_collection' => 'encrypted:collection',
|
||||||
|
'cast_to_encrypted_json' => 'encrypted:json',
|
||||||
|
'cast_to_encrypted_object' => 'encrypted:object',
|
||||||
|
'cast_to_as_collection' => AsCollection::class,
|
||||||
|
'cast_to_as_array_object' => AsArrayObject::class,
|
||||||
|
];
|
||||||
|
}
|
||||||
@@ -0,0 +1,31 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts;
|
||||||
|
|
||||||
|
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
|
||||||
|
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AbstractModelsCommand;
|
||||||
|
use Illuminate\Foundation\Application;
|
||||||
|
|
||||||
|
class Test extends AbstractModelsCommand
|
||||||
|
{
|
||||||
|
public function test(): void
|
||||||
|
{
|
||||||
|
if (!version_compare(Application::VERSION, '8.28', '>=')) {
|
||||||
|
$this->markTestSkipped(
|
||||||
|
'This test only works in Laravel >= 8.28'
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
$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\AdvancedCasts\Models;
|
||||||
|
|
||||||
|
use Illuminate\Database\Eloquent\Casts\AsArrayObject;
|
||||||
|
use Illuminate\Database\Eloquent\Casts\AsCollection;
|
||||||
|
use Illuminate\Database\Eloquent\Model;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts\Models\AdvancedCast
|
||||||
|
*
|
||||||
|
* @property \Illuminate\Support\Carbon $cast_to_date_serialization
|
||||||
|
* @property \Illuminate\Support\Carbon $cast_to_datetime_serialization
|
||||||
|
* @property \Illuminate\Support\Carbon $cast_to_custom_datetime
|
||||||
|
* @property \Carbon\CarbonImmutable $cast_to_immutable_date
|
||||||
|
* @property \Carbon\CarbonImmutable $cast_to_immutable_custom_datetime
|
||||||
|
* @property \Carbon\CarbonImmutable $cast_to_immutable_datetime
|
||||||
|
* @property integer $cast_to_timestamp
|
||||||
|
* @property mixed $cast_to_encrypted
|
||||||
|
* @property array $cast_to_encrypted_array
|
||||||
|
* @property \Illuminate\Support\Collection $cast_to_encrypted_collection
|
||||||
|
* @property array $cast_to_encrypted_json
|
||||||
|
* @property object $cast_to_encrypted_object
|
||||||
|
* @property \Illuminate\Support\Collection $cast_to_as_collection
|
||||||
|
* @property \ArrayObject $cast_to_as_array_object
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|AdvancedCast newModelQuery()
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|AdvancedCast newQuery()
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|AdvancedCast query()
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|AdvancedCast whereCastToAsArrayObject($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|AdvancedCast whereCastToAsCollection($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|AdvancedCast whereCastToCustomDatetime($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|AdvancedCast whereCastToDateSerialization($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|AdvancedCast whereCastToDatetimeSerialization($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|AdvancedCast whereCastToEncrypted($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|AdvancedCast whereCastToEncryptedArray($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|AdvancedCast whereCastToEncryptedCollection($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|AdvancedCast whereCastToEncryptedJson($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|AdvancedCast whereCastToEncryptedObject($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|AdvancedCast whereCastToImmutableCustomDatetime($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|AdvancedCast whereCastToImmutableDate($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|AdvancedCast whereCastToImmutableDatetime($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|AdvancedCast whereCastToTimestamp($value)
|
||||||
|
* @mixin \Eloquent
|
||||||
|
*/
|
||||||
|
class AdvancedCast extends Model
|
||||||
|
{
|
||||||
|
protected $casts = [
|
||||||
|
'cast_to_date_serialization' => 'date:Y-m-d',
|
||||||
|
'cast_to_datetime_serialization' => 'datetime:Y-m-d H:i:s',
|
||||||
|
'cast_to_custom_datetime' => 'custom_datetime:Y-m-d H:i:s',
|
||||||
|
'cast_to_immutable_date' => 'immutable_date',
|
||||||
|
'cast_to_immutable_custom_datetime' => 'immutable_custom_datetime:Y-m-d H:i:s',
|
||||||
|
'cast_to_immutable_datetime' => 'immutable_datetime',
|
||||||
|
'cast_to_timestamp' => 'timestamp',
|
||||||
|
'cast_to_encrypted' => 'encrypted',
|
||||||
|
'cast_to_encrypted_array' => 'encrypted:array',
|
||||||
|
'cast_to_encrypted_collection' => 'encrypted:collection',
|
||||||
|
'cast_to_encrypted_json' => 'encrypted:json',
|
||||||
|
'cast_to_encrypted_object' => 'encrypted:object',
|
||||||
|
'cast_to_as_collection' => AsCollection::class,
|
||||||
|
'cast_to_as_array_object' => AsArrayObject::class,
|
||||||
|
];
|
||||||
|
}
|
||||||
@@ -0,0 +1,43 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\ArrayCastsWithComment\Models;
|
||||||
|
|
||||||
|
use Illuminate\Database\Eloquent\Model;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @property array<int, string>|null $cast_to_array -- These three should not be duplicated
|
||||||
|
* @property array<int, string> $cast_to_json some-description
|
||||||
|
* @property \Illuminate\Support\Collection<int, string> $cast_to_collection some-description
|
||||||
|
*
|
||||||
|
* @property array|null $cast_to_encrypted_array -- These three are OK (no types)
|
||||||
|
* @property array $cast_to_encrypted_json some-description
|
||||||
|
* @property \Illuminate\Support\Collection $cast_to_encrypted_collection some-description
|
||||||
|
*
|
||||||
|
* @property string $cast_to_string -- The next three are OK (no description), this not included
|
||||||
|
*
|
||||||
|
* @property array<int, string>|null $cast_to_immutable_date
|
||||||
|
* @property array<int, string> $cast_to_immutable_date_serialization
|
||||||
|
* @property \Illuminate\Support\Collection<int, string> $cast_to_immutable_custom_datetime
|
||||||
|
*/
|
||||||
|
class ArrayCastsWithComment extends Model
|
||||||
|
{
|
||||||
|
protected $table = 'simple_casts';
|
||||||
|
|
||||||
|
protected $casts = [
|
||||||
|
'cast_to_array' => 'array',
|
||||||
|
'cast_to_json' => 'json',
|
||||||
|
'cast_to_collection' => 'collection',
|
||||||
|
|
||||||
|
'cast_to_encrypted_array' => 'array',
|
||||||
|
'cast_to_encrypted_json' => 'json',
|
||||||
|
'cast_to_encrypted_collection' => 'collection',
|
||||||
|
|
||||||
|
'cast_to_string' => 'string',
|
||||||
|
|
||||||
|
'cast_to_immutable_date' => 'array',
|
||||||
|
'cast_to_immutable_date_serialization' => 'json',
|
||||||
|
'cast_to_immutable_custom_datetime' => 'collection',
|
||||||
|
];
|
||||||
|
}
|
||||||
@@ -0,0 +1,28 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\ArrayCastsWithComment;
|
||||||
|
|
||||||
|
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
|
||||||
|
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AbstractModelsCommand;
|
||||||
|
|
||||||
|
class Test extends AbstractModelsCommand
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* The generated snapshot is wrong until
|
||||||
|
* https://github.com/barryvdh/laravel-ide-helper/issues/1505 is fixed
|
||||||
|
*/
|
||||||
|
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,97 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\ArrayCastsWithComment\Models;
|
||||||
|
|
||||||
|
use Illuminate\Database\Eloquent\Model;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\ArrayCastsWithComment\Models\ArrayCastsWithComment
|
||||||
|
*
|
||||||
|
* @property array<int, string>|null $cast_to_array -- These three should not be duplicated
|
||||||
|
* @property array<int, string> $cast_to_json some-description
|
||||||
|
* @property \Illuminate\Support\Collection<int, string> $cast_to_collection some-description
|
||||||
|
* @property array|null $cast_to_encrypted_array -- These three are OK (no types)
|
||||||
|
* @property array $cast_to_encrypted_json some-description
|
||||||
|
* @property \Illuminate\Support\Collection $cast_to_encrypted_collection some-description
|
||||||
|
* @property string $cast_to_string -- The next three are OK (no description), this not included
|
||||||
|
* @property array<int, string>|null $cast_to_immutable_date
|
||||||
|
* @property array<int, string> $cast_to_immutable_date_serialization
|
||||||
|
* @property \Illuminate\Support\Collection<int, string> $cast_to_immutable_custom_datetime
|
||||||
|
* @property string $cast_to_int
|
||||||
|
* @property string $cast_to_integer
|
||||||
|
* @property string $cast_to_real
|
||||||
|
* @property string $cast_to_float
|
||||||
|
* @property string $cast_to_double
|
||||||
|
* @property string $cast_to_decimal
|
||||||
|
* @property string $cast_to_bool
|
||||||
|
* @property string $cast_to_boolean
|
||||||
|
* @property string $cast_to_object
|
||||||
|
* @property array $cast_to_array
|
||||||
|
* @property array $cast_to_json
|
||||||
|
* @property \Illuminate\Support\Collection $cast_to_collection
|
||||||
|
* @property string $cast_to_date
|
||||||
|
* @property string $cast_to_datetime
|
||||||
|
* @property string $cast_to_date_serialization
|
||||||
|
* @property string $cast_to_datetime_serialization
|
||||||
|
* @property string $cast_to_custom_datetime
|
||||||
|
* @property string $cast_to_immutable_datetime
|
||||||
|
* @property string $cast_to_immutable_datetime_serialization
|
||||||
|
* @property string $cast_to_timestamp
|
||||||
|
* @property string $cast_to_encrypted
|
||||||
|
* @property string $cast_to_encrypted_object
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|ArrayCastsWithComment newModelQuery()
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|ArrayCastsWithComment newQuery()
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|ArrayCastsWithComment query()
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|ArrayCastsWithComment whereCastToArray($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|ArrayCastsWithComment whereCastToBool($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|ArrayCastsWithComment whereCastToBoolean($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|ArrayCastsWithComment whereCastToCollection($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|ArrayCastsWithComment whereCastToCustomDatetime($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|ArrayCastsWithComment whereCastToDate($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|ArrayCastsWithComment whereCastToDateSerialization($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|ArrayCastsWithComment whereCastToDatetime($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|ArrayCastsWithComment whereCastToDatetimeSerialization($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|ArrayCastsWithComment whereCastToDecimal($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|ArrayCastsWithComment whereCastToDouble($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|ArrayCastsWithComment whereCastToEncrypted($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|ArrayCastsWithComment whereCastToEncryptedArray($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|ArrayCastsWithComment whereCastToEncryptedCollection($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|ArrayCastsWithComment whereCastToEncryptedJson($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|ArrayCastsWithComment whereCastToEncryptedObject($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|ArrayCastsWithComment whereCastToFloat($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|ArrayCastsWithComment whereCastToImmutableCustomDatetime($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|ArrayCastsWithComment whereCastToImmutableDate($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|ArrayCastsWithComment whereCastToImmutableDateSerialization($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|ArrayCastsWithComment whereCastToImmutableDatetime($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|ArrayCastsWithComment whereCastToImmutableDatetimeSerialization($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|ArrayCastsWithComment whereCastToInt($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|ArrayCastsWithComment whereCastToInteger($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|ArrayCastsWithComment whereCastToJson($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|ArrayCastsWithComment whereCastToObject($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|ArrayCastsWithComment whereCastToReal($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|ArrayCastsWithComment whereCastToString($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|ArrayCastsWithComment whereCastToTimestamp($value)
|
||||||
|
* @mixin \Eloquent
|
||||||
|
*/
|
||||||
|
class ArrayCastsWithComment extends Model
|
||||||
|
{
|
||||||
|
protected $table = 'simple_casts';
|
||||||
|
|
||||||
|
protected $casts = [
|
||||||
|
'cast_to_array' => 'array',
|
||||||
|
'cast_to_json' => 'json',
|
||||||
|
'cast_to_collection' => 'collection',
|
||||||
|
|
||||||
|
'cast_to_encrypted_array' => 'array',
|
||||||
|
'cast_to_encrypted_json' => 'json',
|
||||||
|
'cast_to_encrypted_collection' => 'collection',
|
||||||
|
|
||||||
|
'cast_to_string' => 'string',
|
||||||
|
|
||||||
|
'cast_to_immutable_date' => 'array',
|
||||||
|
'cast_to_immutable_date_serialization' => 'json',
|
||||||
|
'cast_to_immutable_custom_datetime' => 'collection',
|
||||||
|
];
|
||||||
|
}
|
||||||
@@ -0,0 +1,117 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Attributes\Models;
|
||||||
|
|
||||||
|
use Illuminate\Database\Eloquent\Casts\Attribute;
|
||||||
|
use Illuminate\Database\Eloquent\Model;
|
||||||
|
|
||||||
|
class Simple extends Model
|
||||||
|
{
|
||||||
|
// With a backed property
|
||||||
|
protected function name(): Attribute
|
||||||
|
{
|
||||||
|
return new Attribute(
|
||||||
|
function (?string $name): ?string {
|
||||||
|
return $name;
|
||||||
|
},
|
||||||
|
function (?string $name): ?string {
|
||||||
|
return $name;
|
||||||
|
}
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Without backed properties
|
||||||
|
|
||||||
|
protected function typeHintedGetAndSet(): Attribute
|
||||||
|
{
|
||||||
|
return new Attribute(
|
||||||
|
function (): ?string {
|
||||||
|
return $this->name;
|
||||||
|
},
|
||||||
|
function (?string $name) {
|
||||||
|
$this->name = $name;
|
||||||
|
}
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
protected function divergingTypeHintedGetAndSet(): Attribute
|
||||||
|
{
|
||||||
|
return new Attribute(
|
||||||
|
function (): int {
|
||||||
|
return strlen($this->name);
|
||||||
|
},
|
||||||
|
function (?string $name) {
|
||||||
|
$this->name = $name;
|
||||||
|
}
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
protected function typeHintedGet(): Attribute
|
||||||
|
{
|
||||||
|
return Attribute::get(function (): ?string {
|
||||||
|
return $this->name;
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
protected function typeHintedSet(): Attribute
|
||||||
|
{
|
||||||
|
return Attribute::set(function (?string $name) {
|
||||||
|
$this->name = $name;
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
protected function nonTypeHintedGetAndSet(): Attribute
|
||||||
|
{
|
||||||
|
return new Attribute(
|
||||||
|
function () {
|
||||||
|
return $this->name;
|
||||||
|
},
|
||||||
|
function ($name) {
|
||||||
|
$this->name = $name;
|
||||||
|
}
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
protected function nonTypeHintedGet(): Attribute
|
||||||
|
{
|
||||||
|
return Attribute::get(function () {
|
||||||
|
return $this->name;
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
protected function nonTypeHintedSet(): Attribute
|
||||||
|
{
|
||||||
|
return Attribute::set(function ($name) {
|
||||||
|
$this->name = $name;
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
protected function parameterlessSet(): Attribute
|
||||||
|
{
|
||||||
|
return Attribute::set(function () {
|
||||||
|
$this->name = null;
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* ide-helper does not recognize this method being an Attribute
|
||||||
|
* because the method has no actual return type;
|
||||||
|
* phpdoc is ignored here deliberately due to performance reasons and also
|
||||||
|
* isn't supported by Laravel itself.
|
||||||
|
*
|
||||||
|
* @return Attribute
|
||||||
|
*/
|
||||||
|
protected function notAnAttribute()
|
||||||
|
{
|
||||||
|
return new Attribute(
|
||||||
|
function (?string $value): ?string {
|
||||||
|
return $value;
|
||||||
|
},
|
||||||
|
function (?string $value): ?string {
|
||||||
|
return $value;
|
||||||
|
}
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,24 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Attributes;
|
||||||
|
|
||||||
|
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
|
||||||
|
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AbstractModelsCommand;
|
||||||
|
|
||||||
|
class Test extends AbstractModelsCommand
|
||||||
|
{
|
||||||
|
public function test(): void
|
||||||
|
{
|
||||||
|
$command = $this->app->make(ModelsCommand::class);
|
||||||
|
|
||||||
|
$tester = $this->runCommand($command, [
|
||||||
|
'--write' => true,
|
||||||
|
]);
|
||||||
|
|
||||||
|
$this->assertSame(0, $tester->getStatusCode());
|
||||||
|
$this->assertStringContainsString('Written new phpDocBlock to', $tester->getDisplay());
|
||||||
|
$this->assertMatchesMockedSnapshot();
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,136 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Attributes\Models;
|
||||||
|
|
||||||
|
use Illuminate\Database\Eloquent\Casts\Attribute;
|
||||||
|
use Illuminate\Database\Eloquent\Model;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Attributes\Models\Simple
|
||||||
|
*
|
||||||
|
* @property integer $id
|
||||||
|
* @property int $diverging_type_hinted_get_and_set
|
||||||
|
* @property string|null $name
|
||||||
|
* @property-read mixed $non_type_hinted_get
|
||||||
|
* @property mixed $non_type_hinted_get_and_set
|
||||||
|
* @property-write mixed $non_type_hinted_set
|
||||||
|
* @property-write mixed $parameterless_set
|
||||||
|
* @property-read string|null $type_hinted_get
|
||||||
|
* @property string|null $type_hinted_get_and_set
|
||||||
|
* @property-write string|null $type_hinted_set
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|Simple newModelQuery()
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|Simple newQuery()
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|Simple query()
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|Simple whereId($value)
|
||||||
|
* @mixin \Eloquent
|
||||||
|
*/
|
||||||
|
class Simple extends Model
|
||||||
|
{
|
||||||
|
// With a backed property
|
||||||
|
protected function name(): Attribute
|
||||||
|
{
|
||||||
|
return new Attribute(
|
||||||
|
function (?string $name): ?string {
|
||||||
|
return $name;
|
||||||
|
},
|
||||||
|
function (?string $name): ?string {
|
||||||
|
return $name;
|
||||||
|
}
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Without backed properties
|
||||||
|
|
||||||
|
protected function typeHintedGetAndSet(): Attribute
|
||||||
|
{
|
||||||
|
return new Attribute(
|
||||||
|
function (): ?string {
|
||||||
|
return $this->name;
|
||||||
|
},
|
||||||
|
function (?string $name) {
|
||||||
|
$this->name = $name;
|
||||||
|
}
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
protected function divergingTypeHintedGetAndSet(): Attribute
|
||||||
|
{
|
||||||
|
return new Attribute(
|
||||||
|
function (): int {
|
||||||
|
return strlen($this->name);
|
||||||
|
},
|
||||||
|
function (?string $name) {
|
||||||
|
$this->name = $name;
|
||||||
|
}
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
protected function typeHintedGet(): Attribute
|
||||||
|
{
|
||||||
|
return Attribute::get(function (): ?string {
|
||||||
|
return $this->name;
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
protected function typeHintedSet(): Attribute
|
||||||
|
{
|
||||||
|
return Attribute::set(function (?string $name) {
|
||||||
|
$this->name = $name;
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
protected function nonTypeHintedGetAndSet(): Attribute
|
||||||
|
{
|
||||||
|
return new Attribute(
|
||||||
|
function () {
|
||||||
|
return $this->name;
|
||||||
|
},
|
||||||
|
function ($name) {
|
||||||
|
$this->name = $name;
|
||||||
|
}
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
protected function nonTypeHintedGet(): Attribute
|
||||||
|
{
|
||||||
|
return Attribute::get(function () {
|
||||||
|
return $this->name;
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
protected function nonTypeHintedSet(): Attribute
|
||||||
|
{
|
||||||
|
return Attribute::set(function ($name) {
|
||||||
|
$this->name = $name;
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
protected function parameterlessSet(): Attribute
|
||||||
|
{
|
||||||
|
return Attribute::set(function () {
|
||||||
|
$this->name = null;
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* ide-helper does not recognize this method being an Attribute
|
||||||
|
* because the method has no actual return type;
|
||||||
|
* phpdoc is ignored here deliberately due to performance reasons and also
|
||||||
|
* isn't supported by Laravel itself.
|
||||||
|
*
|
||||||
|
* @return Attribute
|
||||||
|
*/
|
||||||
|
protected function notAnAttribute()
|
||||||
|
{
|
||||||
|
return new Attribute(
|
||||||
|
function (?string $value): ?string {
|
||||||
|
return $value;
|
||||||
|
},
|
||||||
|
function (?string $value): ?string {
|
||||||
|
return $value;
|
||||||
|
}
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,136 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Comment\Models;
|
||||||
|
|
||||||
|
use Illuminate\Database\Eloquent\Model;
|
||||||
|
use Illuminate\Database\Eloquent\Relations\HasMany;
|
||||||
|
use Illuminate\Database\Eloquent\Relations\HasOne;
|
||||||
|
use Illuminate\Database\Eloquent\Relations\MorphTo;
|
||||||
|
|
||||||
|
class Simple extends Model
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* There is not comment.
|
||||||
|
*
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public function getNotCommentAttribute(): string
|
||||||
|
{
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* comment There is not format comment, invalid.
|
||||||
|
*
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public function getFakerCommentAttribute(): string
|
||||||
|
{
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment There is format comment, success.
|
||||||
|
*
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public function getFormatCommentAttribute(): string
|
||||||
|
{
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment There is format comment, success.
|
||||||
|
* This is second line, success too.
|
||||||
|
*
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public function getFormatCommentLineTwoAttribute(): string
|
||||||
|
{
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment There is format comment, success.
|
||||||
|
* @comment This is others format comment, invalid.
|
||||||
|
*
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public function getManyFormatCommentAttribute(): string
|
||||||
|
{
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Set the user's first name.
|
||||||
|
* @param $value
|
||||||
|
*/
|
||||||
|
public function setFirstNameAttribute($value)
|
||||||
|
{
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope a query to only include active users.
|
||||||
|
*
|
||||||
|
* @param $query
|
||||||
|
* @return mixed
|
||||||
|
*/
|
||||||
|
public function scopeActive($query)
|
||||||
|
{
|
||||||
|
return $query;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment HasMany relations.
|
||||||
|
*
|
||||||
|
* @return HasMany
|
||||||
|
*/
|
||||||
|
public function relationHasMany(): HasMany
|
||||||
|
{
|
||||||
|
return $this->hasMany(Simple::class);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment MorphTo relations.
|
||||||
|
* @return MorphTo
|
||||||
|
*/
|
||||||
|
public function relationMorphTo(): MorphTo
|
||||||
|
{
|
||||||
|
return $this->morphTo();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Others relations.
|
||||||
|
* @return HasOne
|
||||||
|
*/
|
||||||
|
public function relationHasOne(): HasOne
|
||||||
|
{
|
||||||
|
return $this->hasOne(Simple::class);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment I'm a setter
|
||||||
|
*/
|
||||||
|
public function setBothSameNameAttribute(): void
|
||||||
|
{
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment I'm a getter
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public function getBothSameNameAttribute(): string
|
||||||
|
{
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment I'm a setter
|
||||||
|
*/
|
||||||
|
public function setBothWithoutGetterCommentAttribute(): void
|
||||||
|
{
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public function getBothWithoutGetterCommentAttribute(): string
|
||||||
|
{
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,24 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Comment;
|
||||||
|
|
||||||
|
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
|
||||||
|
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AbstractModelsCommand;
|
||||||
|
|
||||||
|
class Test extends AbstractModelsCommand
|
||||||
|
{
|
||||||
|
public function test(): void
|
||||||
|
{
|
||||||
|
$command = $this->app->make(ModelsCommand::class);
|
||||||
|
|
||||||
|
$tester = $this->runCommand($command, [
|
||||||
|
'--write' => true,
|
||||||
|
]);
|
||||||
|
|
||||||
|
$this->assertSame(0, $tester->getStatusCode());
|
||||||
|
$this->assertStringContainsString('Written new phpDocBlock to', $tester->getDisplay());
|
||||||
|
$this->assertMatchesMockedSnapshot();
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,160 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Comment\Models;
|
||||||
|
|
||||||
|
use Illuminate\Database\Eloquent\Model;
|
||||||
|
use Illuminate\Database\Eloquent\Relations\HasMany;
|
||||||
|
use Illuminate\Database\Eloquent\Relations\HasOne;
|
||||||
|
use Illuminate\Database\Eloquent\Relations\MorphTo;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Comment\Models\Simple
|
||||||
|
*
|
||||||
|
* @property integer $id
|
||||||
|
* @property string $both_same_name I'm a getter
|
||||||
|
* @property string $both_without_getter_comment
|
||||||
|
* @property-read string $faker_comment
|
||||||
|
* @property-read string $format_comment There is format comment, success.
|
||||||
|
* @property-read string $format_comment_line_two There is format comment, success.
|
||||||
|
* This is second line, success too.
|
||||||
|
* @property-read string $many_format_comment There is format comment, success.
|
||||||
|
* @property-read string $not_comment
|
||||||
|
* @property-read \Illuminate\Database\Eloquent\Collection<int, Simple> $relationHasMany HasMany relations.
|
||||||
|
* @property-read int|null $relation_has_many_count
|
||||||
|
* @property-read Simple|null $relationHasOne Others relations.
|
||||||
|
* @property-read Model|\Eloquent $relationMorphTo MorphTo relations.
|
||||||
|
* @property-write mixed $first_name Set the user's first name.
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|Simple active() Scope a query to only include active users.
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|Simple newModelQuery()
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|Simple newQuery()
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|Simple query()
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|Simple whereId($value)
|
||||||
|
* @mixin \Eloquent
|
||||||
|
*/
|
||||||
|
class Simple extends Model
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* There is not comment.
|
||||||
|
*
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public function getNotCommentAttribute(): string
|
||||||
|
{
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* comment There is not format comment, invalid.
|
||||||
|
*
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public function getFakerCommentAttribute(): string
|
||||||
|
{
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment There is format comment, success.
|
||||||
|
*
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public function getFormatCommentAttribute(): string
|
||||||
|
{
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment There is format comment, success.
|
||||||
|
* This is second line, success too.
|
||||||
|
*
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public function getFormatCommentLineTwoAttribute(): string
|
||||||
|
{
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment There is format comment, success.
|
||||||
|
* @comment This is others format comment, invalid.
|
||||||
|
*
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public function getManyFormatCommentAttribute(): string
|
||||||
|
{
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Set the user's first name.
|
||||||
|
* @param $value
|
||||||
|
*/
|
||||||
|
public function setFirstNameAttribute($value)
|
||||||
|
{
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope a query to only include active users.
|
||||||
|
*
|
||||||
|
* @param $query
|
||||||
|
* @return mixed
|
||||||
|
*/
|
||||||
|
public function scopeActive($query)
|
||||||
|
{
|
||||||
|
return $query;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment HasMany relations.
|
||||||
|
*
|
||||||
|
* @return HasMany
|
||||||
|
*/
|
||||||
|
public function relationHasMany(): HasMany
|
||||||
|
{
|
||||||
|
return $this->hasMany(Simple::class);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment MorphTo relations.
|
||||||
|
* @return MorphTo
|
||||||
|
*/
|
||||||
|
public function relationMorphTo(): MorphTo
|
||||||
|
{
|
||||||
|
return $this->morphTo();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Others relations.
|
||||||
|
* @return HasOne
|
||||||
|
*/
|
||||||
|
public function relationHasOne(): HasOne
|
||||||
|
{
|
||||||
|
return $this->hasOne(Simple::class);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment I'm a setter
|
||||||
|
*/
|
||||||
|
public function setBothSameNameAttribute(): void
|
||||||
|
{
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment I'm a getter
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public function getBothSameNameAttribute(): string
|
||||||
|
{
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment I'm a setter
|
||||||
|
*/
|
||||||
|
public function setBothWithoutGetterCommentAttribute(): void
|
||||||
|
{
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public function getBothWithoutGetterCommentAttribute(): string
|
||||||
|
{
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -12,10 +12,10 @@ use Illuminate\Database\Eloquent\Relations\HasMany;
|
|||||||
* Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\CustomCollection\Models\Simple
|
* Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\CustomCollection\Models\Simple
|
||||||
*
|
*
|
||||||
* @property integer $id
|
* @property integer $id
|
||||||
* @property-read SimpleCollection|Simple[] $relationHasMany
|
* @property-read SimpleCollection<int, Simple> $relationHasMany
|
||||||
* @property-read int|null $relation_has_many_count
|
* @property-read int|null $relation_has_many_count
|
||||||
* @method static SimpleCollection|static[] all($columns = ['*'])
|
* @method static SimpleCollection<int, static> all($columns = ['*'])
|
||||||
* @method static SimpleCollection|static[] get($columns = ['*'])
|
* @method static SimpleCollection<int, static> get($columns = ['*'])
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder|Simple newModelQuery()
|
* @method static \Illuminate\Database\Eloquent\Builder|Simple newModelQuery()
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder|Simple newQuery()
|
* @method static \Illuminate\Database\Eloquent\Builder|Simple newQuery()
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder|Simple query()
|
* @method static \Illuminate\Database\Eloquent\Builder|Simple query()
|
||||||
|
|||||||
+1
@@ -1,6 +1,7 @@
|
|||||||
<?php
|
<?php
|
||||||
|
|
||||||
// @formatter:off
|
// @formatter:off
|
||||||
|
// phpcs:ignoreFile
|
||||||
/**
|
/**
|
||||||
* A helper file for your Eloquent Models
|
* A helper file for your Eloquent Models
|
||||||
* Copy the phpDocs from this file to the correct Model,
|
* Copy the phpDocs from this file to the correct Model,
|
||||||
|
|||||||
@@ -17,23 +17,17 @@ class Test extends AbstractModelsCommand
|
|||||||
'--write' => true,
|
'--write' => true,
|
||||||
]);
|
]);
|
||||||
|
|
||||||
if (PHP_VERSION_ID >= 80000) {
|
$errors = [
|
||||||
$errors = <<<TXT
|
'Error resolving relation model of Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\DynamicRelations\Models\Dynamic:dynamicBelongsTo() : Attempt to read property "created_at" on null',
|
||||||
Error resolving relation model of Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\DynamicRelations\Models\Dynamic:dynamicBelongsTo() : Attempt to read property "created_at" on null
|
'Error resolving relation model of Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\DynamicRelations\Models\Dynamic:dynamicHasMany() : Attempt to read property "created_at" on null',
|
||||||
Error resolving relation model of Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\DynamicRelations\Models\Dynamic:dynamicHasMany() : Attempt to read property "created_at" on null
|
'Error resolving relation model of Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\DynamicRelations\Models\Dynamic:dynamicHasOne() : Attempt to read property "created_at" on null',
|
||||||
Error resolving relation model of Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\DynamicRelations\Models\Dynamic:dynamicHasOne() : Attempt to read property "created_at" on null
|
];
|
||||||
TXT;
|
|
||||||
} else {
|
|
||||||
$errors = <<<TXT
|
|
||||||
Error resolving relation model of Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\DynamicRelations\Models\Dynamic:dynamicBelongsTo() : Trying to get property 'created_at' of non-object
|
|
||||||
Error resolving relation model of Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\DynamicRelations\Models\Dynamic:dynamicHasMany() : Trying to get property 'created_at' of non-object
|
|
||||||
Error resolving relation model of Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\DynamicRelations\Models\Dynamic:dynamicHasOne() : Trying to get property 'created_at' of non-object
|
|
||||||
TXT;
|
|
||||||
}
|
|
||||||
|
|
||||||
$this->assertSame(0, $tester->getStatusCode());
|
$this->assertSame(0, $tester->getStatusCode());
|
||||||
$this->assertStringContainsString('Written new phpDocBlock to', $tester->getDisplay());
|
$this->assertStringContainsString('Written new phpDocBlock to', $tester->getDisplay());
|
||||||
$this->assertStringContainsString($errors, $tester->getDisplay());
|
foreach ($errors as $error) {
|
||||||
|
$this->assertStringContainsString($error, $tester->getDisplay());
|
||||||
|
}
|
||||||
$this->assertMatchesMockedSnapshot();
|
$this->assertMatchesMockedSnapshot();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -12,7 +12,7 @@ use Illuminate\Database\Eloquent\Relations\HasOne;
|
|||||||
/**
|
/**
|
||||||
* Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\DynamicRelations\Models\Dynamic
|
* Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\DynamicRelations\Models\Dynamic
|
||||||
*
|
*
|
||||||
* @property-read \Illuminate\Database\Eloquent\Collection|Dynamic[] $regularHasMany
|
* @property-read \Illuminate\Database\Eloquent\Collection<int, Dynamic> $regularHasMany
|
||||||
* @property-read int|null $regular_has_many_count
|
* @property-read int|null $regular_has_many_count
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder|Dynamic newModelQuery()
|
* @method static \Illuminate\Database\Eloquent\Builder|Dynamic newModelQuery()
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder|Dynamic newQuery()
|
* @method static \Illuminate\Database\Eloquent\Builder|Dynamic newQuery()
|
||||||
|
|||||||
@@ -0,0 +1,30 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\CustomSpace;
|
||||||
|
|
||||||
|
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Models\ModelWithCustomNamespace;
|
||||||
|
use Illuminate\Database\Eloquent\Factories\Factory;
|
||||||
|
|
||||||
|
class ModelWithCustomNamespaceFactory extends Factory
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* The name of the factory's corresponding model.
|
||||||
|
*
|
||||||
|
* @var string
|
||||||
|
*/
|
||||||
|
protected $model = ModelWithCustomNamespace::class;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Define the model's default state.
|
||||||
|
*
|
||||||
|
* @return array
|
||||||
|
*/
|
||||||
|
public function definition()
|
||||||
|
{
|
||||||
|
return [
|
||||||
|
//
|
||||||
|
];
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,30 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Factories;
|
||||||
|
|
||||||
|
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Models\ModelWithFactory;
|
||||||
|
use Illuminate\Database\Eloquent\Factories\Factory;
|
||||||
|
|
||||||
|
class ModelWithFactoryFactory extends Factory
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* The name of the factory's corresponding model.
|
||||||
|
*
|
||||||
|
* @var string
|
||||||
|
*/
|
||||||
|
protected $model = ModelWithFactory::class;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Define the model's default state.
|
||||||
|
*
|
||||||
|
* @return array
|
||||||
|
*/
|
||||||
|
public function definition()
|
||||||
|
{
|
||||||
|
return [
|
||||||
|
//
|
||||||
|
];
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,30 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Factories;
|
||||||
|
|
||||||
|
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Models\ModelWithNestedFactory;
|
||||||
|
use Illuminate\Database\Eloquent\Factories\Factory;
|
||||||
|
|
||||||
|
class ModelWithNestedFactoryFactory extends Factory
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* The name of the factory's corresponding model.
|
||||||
|
*
|
||||||
|
* @var string
|
||||||
|
*/
|
||||||
|
protected $model = ModelWithNestedFactory::class;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Define the model's default state.
|
||||||
|
*
|
||||||
|
* @return array
|
||||||
|
*/
|
||||||
|
public function definition()
|
||||||
|
{
|
||||||
|
return [
|
||||||
|
//
|
||||||
|
];
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,24 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Models;
|
||||||
|
|
||||||
|
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\CustomSpace\ModelWithCustomNamespaceFactory;
|
||||||
|
use Illuminate\Database\Eloquent\Factories\HasFactory;
|
||||||
|
use Illuminate\Database\Eloquent\Model;
|
||||||
|
|
||||||
|
class ModelWithCustomNamespace extends Model
|
||||||
|
{
|
||||||
|
use HasFactory;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a new factory instance for the model.
|
||||||
|
*
|
||||||
|
* @return \Illuminate\Database\Eloquent\Factories\Factory
|
||||||
|
*/
|
||||||
|
protected static function newFactory()
|
||||||
|
{
|
||||||
|
return ModelWithCustomNamespaceFactory::new();
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,13 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Models;
|
||||||
|
|
||||||
|
use Illuminate\Database\Eloquent\Factories\HasFactory;
|
||||||
|
use Illuminate\Database\Eloquent\Model;
|
||||||
|
|
||||||
|
class ModelWithFactory extends Model
|
||||||
|
{
|
||||||
|
use HasFactory;
|
||||||
|
}
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Models;
|
||||||
|
|
||||||
|
class ModelWithNestedFactory extends ModelWithFactory
|
||||||
|
{
|
||||||
|
}
|
||||||
@@ -0,0 +1,13 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Models;
|
||||||
|
|
||||||
|
use Illuminate\Database\Eloquent\Factories\HasFactory;
|
||||||
|
use Illuminate\Database\Eloquent\Model;
|
||||||
|
|
||||||
|
class ModelWithoutFactory extends Model
|
||||||
|
{
|
||||||
|
use HasFactory;
|
||||||
|
}
|
||||||
@@ -0,0 +1,45 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories;
|
||||||
|
|
||||||
|
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
|
||||||
|
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AbstractModelsCommand;
|
||||||
|
use Closure;
|
||||||
|
use Illuminate\Database\Eloquent\Factories\Factory;
|
||||||
|
use Illuminate\Support\Str;
|
||||||
|
|
||||||
|
class Test extends AbstractModelsCommand
|
||||||
|
{
|
||||||
|
public function testFactory(): void
|
||||||
|
{
|
||||||
|
Factory::guessFactoryNamesUsing(static::getFactoryNameResolver());
|
||||||
|
|
||||||
|
$command = $this->app->make(ModelsCommand::class);
|
||||||
|
|
||||||
|
$tester = $this->runCommand($command, [
|
||||||
|
'--write' => true,
|
||||||
|
]);
|
||||||
|
|
||||||
|
$this->assertSame(0, $tester->getStatusCode());
|
||||||
|
$this->assertStringContainsString('Written new phpDocBlock to', $tester->getDisplay());
|
||||||
|
$this->assertStringNotContainsString('not found', $tester->getDisplay());
|
||||||
|
$this->assertMatchesMockedSnapshot();
|
||||||
|
}
|
||||||
|
|
||||||
|
public static function getFactoryNameResolver(): Closure
|
||||||
|
{
|
||||||
|
// This mimics the default resolver, but with adjusted test namespaces.
|
||||||
|
// Illuminate\Database\Eloquent\Factories\Factory::resolveFactoryName
|
||||||
|
return function (string $modelName): string {
|
||||||
|
$appNamespace = 'Barryvdh\\LaravelIdeHelper\\Tests\\Console\\ModelsCommand\\Factories\\';
|
||||||
|
|
||||||
|
$modelName = Str::startsWith($modelName, $appNamespace . 'Models\\')
|
||||||
|
? Str::after($modelName, $appNamespace . 'Models\\')
|
||||||
|
: Str::after($modelName, $appNamespace);
|
||||||
|
|
||||||
|
return $appNamespace . 'Factories\\' . $modelName . 'Factory';
|
||||||
|
};
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,94 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Models;
|
||||||
|
|
||||||
|
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\CustomSpace\ModelWithCustomNamespaceFactory;
|
||||||
|
use Illuminate\Database\Eloquent\Factories\HasFactory;
|
||||||
|
use Illuminate\Database\Eloquent\Model;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Models\ModelWithCustomNamespace
|
||||||
|
*
|
||||||
|
* @method static \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\CustomSpace\ModelWithCustomNamespaceFactory factory($count = null, $state = [])
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|ModelWithCustomNamespace newModelQuery()
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|ModelWithCustomNamespace newQuery()
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|ModelWithCustomNamespace query()
|
||||||
|
* @mixin \Eloquent
|
||||||
|
*/
|
||||||
|
class ModelWithCustomNamespace extends Model
|
||||||
|
{
|
||||||
|
use HasFactory;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a new factory instance for the model.
|
||||||
|
*
|
||||||
|
* @return \Illuminate\Database\Eloquent\Factories\Factory
|
||||||
|
*/
|
||||||
|
protected static function newFactory()
|
||||||
|
{
|
||||||
|
return ModelWithCustomNamespaceFactory::new();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Models;
|
||||||
|
|
||||||
|
use Illuminate\Database\Eloquent\Factories\HasFactory;
|
||||||
|
use Illuminate\Database\Eloquent\Model;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Models\ModelWithFactory
|
||||||
|
*
|
||||||
|
* @method static \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Factories\ModelWithFactoryFactory factory($count = null, $state = [])
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|ModelWithFactory newModelQuery()
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|ModelWithFactory newQuery()
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|ModelWithFactory query()
|
||||||
|
* @mixin \Eloquent
|
||||||
|
*/
|
||||||
|
class ModelWithFactory extends Model
|
||||||
|
{
|
||||||
|
use HasFactory;
|
||||||
|
}
|
||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Models;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Models\ModelWithNestedFactory
|
||||||
|
*
|
||||||
|
* @method static \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Factories\ModelWithNestedFactoryFactory factory($count = null, $state = [])
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|ModelWithNestedFactory newModelQuery()
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|ModelWithNestedFactory newQuery()
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|ModelWithNestedFactory query()
|
||||||
|
* @mixin \Eloquent
|
||||||
|
*/
|
||||||
|
class ModelWithNestedFactory extends ModelWithFactory
|
||||||
|
{
|
||||||
|
}
|
||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Models;
|
||||||
|
|
||||||
|
use Illuminate\Database\Eloquent\Factories\HasFactory;
|
||||||
|
use Illuminate\Database\Eloquent\Model;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Models\ModelWithoutFactory
|
||||||
|
*
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|ModelWithoutFactory newModelQuery()
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|ModelWithoutFactory newQuery()
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|ModelWithoutFactory query()
|
||||||
|
* @mixin \Eloquent
|
||||||
|
*/
|
||||||
|
class ModelWithoutFactory extends Model
|
||||||
|
{
|
||||||
|
use HasFactory;
|
||||||
|
}
|
||||||
@@ -0,0 +1,14 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateBasicPhpDocWithEnumDefaults\Enums;
|
||||||
|
|
||||||
|
enum PostStatus
|
||||||
|
{
|
||||||
|
case Published;
|
||||||
|
|
||||||
|
case Unpublished;
|
||||||
|
|
||||||
|
case Archived;
|
||||||
|
}
|
||||||
@@ -0,0 +1,17 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateBasicPhpDocWithEnumDefaults\Models;
|
||||||
|
|
||||||
|
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateBasicPhpDocWithEnumDefaults\Enums\PostStatus;
|
||||||
|
use Illuminate\Database\Eloquent\Builder;
|
||||||
|
use Illuminate\Database\Eloquent\Model;
|
||||||
|
|
||||||
|
class Post extends Model
|
||||||
|
{
|
||||||
|
public function scopeHasStatus(Builder $query, ?PostStatus $status = PostStatus::Published)
|
||||||
|
{
|
||||||
|
//
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,30 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateBasicPhpDocWithEnumDefaults;
|
||||||
|
|
||||||
|
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
|
||||||
|
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AbstractModelsCommand;
|
||||||
|
|
||||||
|
class Test extends AbstractModelsCommand
|
||||||
|
{
|
||||||
|
public function test(): void
|
||||||
|
{
|
||||||
|
if (!version_compare(PHP_VERSION, '8.1', '>=')) {
|
||||||
|
$this->markTestSkipped(
|
||||||
|
'This test only works in PHP >= 8.1'
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
$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();
|
||||||
|
}
|
||||||
|
}
|
||||||
+172
@@ -0,0 +1,172 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateBasicPhpDocWithEnumDefaults\Models;
|
||||||
|
|
||||||
|
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateBasicPhpDocWithEnumDefaults\Enums\PostStatus;
|
||||||
|
use Illuminate\Database\Eloquent\Builder;
|
||||||
|
use Illuminate\Database\Eloquent\Model;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateBasicPhpDocWithEnumDefaults\Models\Post
|
||||||
|
*
|
||||||
|
* @property integer $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 integer|null $integer_nullable
|
||||||
|
* @property integer $integer_not_nullable
|
||||||
|
* @property integer|null $tiny_integer_nullable
|
||||||
|
* @property integer $tiny_integer_not_nullable
|
||||||
|
* @property integer|null $small_integer_nullable
|
||||||
|
* @property integer $small_integer_not_nullable
|
||||||
|
* @property integer|null $medium_integer_nullable
|
||||||
|
* @property integer $medium_integer_not_nullable
|
||||||
|
* @property integer|null $big_integer_nullable
|
||||||
|
* @property integer $big_integer_not_nullable
|
||||||
|
* @property integer|null $unsigned_integer_nullable
|
||||||
|
* @property integer $unsigned_integer_not_nullable
|
||||||
|
* @property integer|null $unsigned_tiny_integer_nullable
|
||||||
|
* @property integer $unsigned_tiny_integer_not_nullable
|
||||||
|
* @property integer|null $unsigned_small_integer_nullable
|
||||||
|
* @property integer $unsigned_small_integer_not_nullable
|
||||||
|
* @property integer|null $unsigned_medium_integer_nullable
|
||||||
|
* @property integer $unsigned_medium_integer_not_nullable
|
||||||
|
* @property integer|null $unsigned_big_integer_nullable
|
||||||
|
* @property integer $unsigned_big_integer_not_nullable
|
||||||
|
* @property float|null $float_nullable
|
||||||
|
* @property float $float_not_nullable
|
||||||
|
* @property float|null $double_nullable
|
||||||
|
* @property float $double_not_nullable
|
||||||
|
* @property string|null $decimal_nullable
|
||||||
|
* @property string $decimal_not_nullable
|
||||||
|
* @property string|null $unsigned_decimal_nullable
|
||||||
|
* @property string $unsigned_decimal_not_nullable
|
||||||
|
* @property integer|null $boolean_nullable
|
||||||
|
* @property integer $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 integer|null $year_nullable
|
||||||
|
* @property integer $year_not_nullable
|
||||||
|
* @property mixed|null $binary_nullable
|
||||||
|
* @property mixed $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 Builder|Post hasStatus(?\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateBasicPhpDocWithEnumDefaults\Enums\PostStatus $status = \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateBasicPhpDocWithEnumDefaults\Enums\PostStatus::Published)
|
||||||
|
* @method static Builder|Post newModelQuery()
|
||||||
|
* @method static Builder|Post newQuery()
|
||||||
|
* @method static Builder|Post query()
|
||||||
|
* @method static Builder|Post whereBigIntegerNotNullable($value)
|
||||||
|
* @method static Builder|Post whereBigIntegerNullable($value)
|
||||||
|
* @method static Builder|Post whereBinaryNotNullable($value)
|
||||||
|
* @method static Builder|Post whereBinaryNullable($value)
|
||||||
|
* @method static Builder|Post whereBooleanNotNullable($value)
|
||||||
|
* @method static Builder|Post whereBooleanNullable($value)
|
||||||
|
* @method static Builder|Post whereCharNotNullable($value)
|
||||||
|
* @method static Builder|Post whereCharNullable($value)
|
||||||
|
* @method static Builder|Post whereCreatedAt($value)
|
||||||
|
* @method static Builder|Post whereDateNotNullable($value)
|
||||||
|
* @method static Builder|Post whereDateNullable($value)
|
||||||
|
* @method static Builder|Post whereDatetimeNotNullable($value)
|
||||||
|
* @method static Builder|Post whereDatetimeNullable($value)
|
||||||
|
* @method static Builder|Post whereDatetimetzNotNullable($value)
|
||||||
|
* @method static Builder|Post whereDatetimetzNullable($value)
|
||||||
|
* @method static Builder|Post whereDecimalNotNullable($value)
|
||||||
|
* @method static Builder|Post whereDecimalNullable($value)
|
||||||
|
* @method static Builder|Post whereDoubleNotNullable($value)
|
||||||
|
* @method static Builder|Post whereDoubleNullable($value)
|
||||||
|
* @method static Builder|Post whereEnumNotNullable($value)
|
||||||
|
* @method static Builder|Post whereEnumNullable($value)
|
||||||
|
* @method static Builder|Post whereFloatNotNullable($value)
|
||||||
|
* @method static Builder|Post whereFloatNullable($value)
|
||||||
|
* @method static Builder|Post whereId($value)
|
||||||
|
* @method static Builder|Post whereIntegerNotNullable($value)
|
||||||
|
* @method static Builder|Post whereIntegerNullable($value)
|
||||||
|
* @method static Builder|Post whereIpaddressNotNullable($value)
|
||||||
|
* @method static Builder|Post whereIpaddressNullable($value)
|
||||||
|
* @method static Builder|Post whereJsonNotNullable($value)
|
||||||
|
* @method static Builder|Post whereJsonNullable($value)
|
||||||
|
* @method static Builder|Post whereJsonbNotNullable($value)
|
||||||
|
* @method static Builder|Post whereJsonbNullable($value)
|
||||||
|
* @method static Builder|Post whereLongTextNotNullable($value)
|
||||||
|
* @method static Builder|Post whereLongTextNullable($value)
|
||||||
|
* @method static Builder|Post whereMacaddressNotNullable($value)
|
||||||
|
* @method static Builder|Post whereMacaddressNullable($value)
|
||||||
|
* @method static Builder|Post whereMediumIntegerNotNullable($value)
|
||||||
|
* @method static Builder|Post whereMediumIntegerNullable($value)
|
||||||
|
* @method static Builder|Post whereMediumTextNotNullable($value)
|
||||||
|
* @method static Builder|Post whereMediumTextNullable($value)
|
||||||
|
* @method static Builder|Post whereSmallIntegerNotNullable($value)
|
||||||
|
* @method static Builder|Post whereSmallIntegerNullable($value)
|
||||||
|
* @method static Builder|Post whereStringNotNullable($value)
|
||||||
|
* @method static Builder|Post whereStringNullable($value)
|
||||||
|
* @method static Builder|Post whereTextNotNullable($value)
|
||||||
|
* @method static Builder|Post whereTextNullable($value)
|
||||||
|
* @method static Builder|Post whereTimeNotNullable($value)
|
||||||
|
* @method static Builder|Post whereTimeNullable($value)
|
||||||
|
* @method static Builder|Post whereTimestampNotNullable($value)
|
||||||
|
* @method static Builder|Post whereTimestampNullable($value)
|
||||||
|
* @method static Builder|Post whereTimestamptzNotNullable($value)
|
||||||
|
* @method static Builder|Post whereTimestamptzNullable($value)
|
||||||
|
* @method static Builder|Post whereTimetzNotNullable($value)
|
||||||
|
* @method static Builder|Post whereTimetzNullable($value)
|
||||||
|
* @method static Builder|Post whereTinyIntegerNotNullable($value)
|
||||||
|
* @method static Builder|Post whereTinyIntegerNullable($value)
|
||||||
|
* @method static Builder|Post whereUnsignedBigIntegerNotNullable($value)
|
||||||
|
* @method static Builder|Post whereUnsignedBigIntegerNullable($value)
|
||||||
|
* @method static Builder|Post whereUnsignedDecimalNotNullable($value)
|
||||||
|
* @method static Builder|Post whereUnsignedDecimalNullable($value)
|
||||||
|
* @method static Builder|Post whereUnsignedIntegerNotNullable($value)
|
||||||
|
* @method static Builder|Post whereUnsignedIntegerNullable($value)
|
||||||
|
* @method static Builder|Post whereUnsignedMediumIntegerNotNullable($value)
|
||||||
|
* @method static Builder|Post whereUnsignedMediumIntegerNullable($value)
|
||||||
|
* @method static Builder|Post whereUnsignedSmallIntegerNotNullable($value)
|
||||||
|
* @method static Builder|Post whereUnsignedSmallIntegerNullable($value)
|
||||||
|
* @method static Builder|Post whereUnsignedTinyIntegerNotNullable($value)
|
||||||
|
* @method static Builder|Post whereUnsignedTinyIntegerNullable($value)
|
||||||
|
* @method static Builder|Post whereUpdatedAt($value)
|
||||||
|
* @method static Builder|Post whereUuidNotNullable($value)
|
||||||
|
* @method static Builder|Post whereUuidNullable($value)
|
||||||
|
* @method static Builder|Post whereYearNotNullable($value)
|
||||||
|
* @method static Builder|Post whereYearNullable($value)
|
||||||
|
* @mixin \Eloquent
|
||||||
|
*/
|
||||||
|
class Post extends Model
|
||||||
|
{
|
||||||
|
public function scopeHasStatus(Builder $query, ?PostStatus $status = PostStatus::Published)
|
||||||
|
{
|
||||||
|
//
|
||||||
|
}
|
||||||
|
}
|
||||||
+1
@@ -1,6 +1,7 @@
|
|||||||
<?php
|
<?php
|
||||||
|
|
||||||
// @formatter:off
|
// @formatter:off
|
||||||
|
// phpcs:ignoreFile
|
||||||
/**
|
/**
|
||||||
* A helper file for your Eloquent Models
|
* A helper file for your Eloquent Models
|
||||||
* Copy the phpDocs from this file to the correct Model,
|
* Copy the phpDocs from this file to the correct Model,
|
||||||
|
|||||||
+4
-4
@@ -84,12 +84,12 @@ use Illuminate\Database\Eloquent\SoftDeletes;
|
|||||||
* @property string $macaddress_not_nullable
|
* @property string $macaddress_not_nullable
|
||||||
* @property \Illuminate\Support\Carbon|null $created_at
|
* @property \Illuminate\Support\Carbon|null $created_at
|
||||||
* @property \Illuminate\Support\Carbon|null $updated_at
|
* @property \Illuminate\Support\Carbon|null $updated_at
|
||||||
* @property-read \Illuminate\Database\Eloquent\Collection|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post[] $posts
|
* @property-read \Illuminate\Database\Eloquent\Collection<int, \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post> $posts
|
||||||
* @property-read int|null $posts_count
|
* @property-read int|null $posts_count
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post newModelQuery()
|
* @method static \Illuminate\Database\Eloquent\Builder|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post newModelQuery()
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post newQuery()
|
* @method static \Illuminate\Database\Eloquent\Builder|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post newQuery()
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post null(string $unusedParam)
|
* @method static \Illuminate\Database\Eloquent\Builder|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post null(string $unusedParam)
|
||||||
* @method static \Illuminate\Database\Query\Builder|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post onlyTrashed()
|
* @method static \Illuminate\Database\Eloquent\Builder|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post onlyTrashed()
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post query()
|
* @method static \Illuminate\Database\Eloquent\Builder|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post query()
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post whereBigIntegerNotNullable($value)
|
* @method static \Illuminate\Database\Eloquent\Builder|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post whereBigIntegerNotNullable($value)
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post whereBigIntegerNullable($value)
|
* @method static \Illuminate\Database\Eloquent\Builder|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post whereBigIntegerNullable($value)
|
||||||
@@ -164,8 +164,8 @@ use Illuminate\Database\Eloquent\SoftDeletes;
|
|||||||
* @method static \Illuminate\Database\Eloquent\Builder|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post whereUuidNullable($value)
|
* @method static \Illuminate\Database\Eloquent\Builder|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post whereUuidNullable($value)
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post whereYearNotNullable($value)
|
* @method static \Illuminate\Database\Eloquent\Builder|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post whereYearNotNullable($value)
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post whereYearNullable($value)
|
* @method static \Illuminate\Database\Eloquent\Builder|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post whereYearNullable($value)
|
||||||
* @method static \Illuminate\Database\Query\Builder|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post withTrashed()
|
* @method static \Illuminate\Database\Eloquent\Builder|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post withTrashed()
|
||||||
* @method static \Illuminate\Database\Query\Builder|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post withoutTrashed()
|
* @method static \Illuminate\Database\Eloquent\Builder|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post withoutTrashed()
|
||||||
* @mixin \Eloquent
|
* @mixin \Eloquent
|
||||||
*/
|
*/
|
||||||
class Post extends Model
|
class Post extends Model
|
||||||
|
|||||||
@@ -90,12 +90,12 @@ use Illuminate\Support\Carbon;
|
|||||||
* @property string $macaddress_not_nullable
|
* @property string $macaddress_not_nullable
|
||||||
* @property Carbon|null $created_at
|
* @property Carbon|null $created_at
|
||||||
* @property Carbon|null $updated_at
|
* @property Carbon|null $updated_at
|
||||||
* @property-read Collection|Post[] $posts
|
* @property-read Collection<int, Post> $posts
|
||||||
* @property-read int|null $posts_count
|
* @property-read int|null $posts_count
|
||||||
* @method static EloquentBuilder|Post newModelQuery()
|
* @method static EloquentBuilder|Post newModelQuery()
|
||||||
* @method static EloquentBuilder|Post newQuery()
|
* @method static EloquentBuilder|Post newQuery()
|
||||||
* @method static EloquentBuilder|Post null(string $unusedParam)
|
* @method static EloquentBuilder|Post null(string $unusedParam)
|
||||||
* @method static QueryBuilder|Post onlyTrashed()
|
* @method static EloquentBuilder|Post onlyTrashed()
|
||||||
* @method static EloquentBuilder|Post query()
|
* @method static EloquentBuilder|Post query()
|
||||||
* @method static EloquentBuilder|Post whereBigIntegerNotNullable($value)
|
* @method static EloquentBuilder|Post whereBigIntegerNotNullable($value)
|
||||||
* @method static EloquentBuilder|Post whereBigIntegerNullable($value)
|
* @method static EloquentBuilder|Post whereBigIntegerNullable($value)
|
||||||
@@ -170,8 +170,8 @@ use Illuminate\Support\Carbon;
|
|||||||
* @method static EloquentBuilder|Post whereUuidNullable($value)
|
* @method static EloquentBuilder|Post whereUuidNullable($value)
|
||||||
* @method static EloquentBuilder|Post whereYearNotNullable($value)
|
* @method static EloquentBuilder|Post whereYearNotNullable($value)
|
||||||
* @method static EloquentBuilder|Post whereYearNullable($value)
|
* @method static EloquentBuilder|Post whereYearNullable($value)
|
||||||
* @method static QueryBuilder|Post withTrashed()
|
* @method static EloquentBuilder|Post withTrashed()
|
||||||
* @method static QueryBuilder|Post withoutTrashed()
|
* @method static EloquentBuilder|Post withoutTrashed()
|
||||||
* @mixin Eloquent
|
* @mixin Eloquent
|
||||||
*/
|
*/
|
||||||
class Post extends Model
|
class Post extends Model
|
||||||
|
|||||||
+1
@@ -1,6 +1,7 @@
|
|||||||
<?php
|
<?php
|
||||||
|
|
||||||
// @formatter:off
|
// @formatter:off
|
||||||
|
// phpcs:ignoreFile
|
||||||
/**
|
/**
|
||||||
* A helper file for your Eloquent Models
|
* A helper file for your Eloquent Models
|
||||||
* Copy the phpDocs from this file to the correct Model,
|
* Copy the phpDocs from this file to the correct Model,
|
||||||
|
|||||||
@@ -9,6 +9,7 @@ use Illuminate\Database\Eloquent\Model;
|
|||||||
/**
|
/**
|
||||||
* @property $someProp
|
* @property $someProp
|
||||||
* @method someMethod(string $method)
|
* @method someMethod(string $method)
|
||||||
|
* @mixin IdeHelperPost
|
||||||
*/
|
*/
|
||||||
class Post extends Model
|
class Post extends Model
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -17,6 +17,7 @@ class Post extends Model
|
|||||||
<?php
|
<?php
|
||||||
|
|
||||||
// @formatter:off
|
// @formatter:off
|
||||||
|
// phpcs:ignoreFile
|
||||||
/**
|
/**
|
||||||
* A helper file for your Eloquent Models
|
* A helper file for your Eloquent Models
|
||||||
* Copy the phpDocs from this file to the correct Model,
|
* Copy the phpDocs from this file to the correct Model,
|
||||||
@@ -183,6 +184,7 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWi
|
|||||||
* @method static \Illuminate\Database\Eloquent\Builder|Post whereYearNullable($value)
|
* @method static \Illuminate\Database\Eloquent\Builder|Post whereYearNullable($value)
|
||||||
* @mixin \Eloquent
|
* @mixin \Eloquent
|
||||||
*/
|
*/
|
||||||
class IdeHelperPost extends \Eloquent {}
|
#[\AllowDynamicProperties]
|
||||||
|
class IdeHelperPost {}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,23 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenericsSyntaxDisabled\Models;
|
||||||
|
|
||||||
|
use Illuminate\Database\Eloquent\Model;
|
||||||
|
use Illuminate\Database\Eloquent\Relations\BelongsToMany;
|
||||||
|
use Illuminate\Database\Eloquent\Relations\HasMany;
|
||||||
|
|
||||||
|
class Simple extends Model
|
||||||
|
{
|
||||||
|
// Regular relations
|
||||||
|
public function regularHasMany(): HasMany
|
||||||
|
{
|
||||||
|
return $this->hasMany(Simple::class);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function regularBelongsToMany(): BelongsToMany
|
||||||
|
{
|
||||||
|
return $this->belongsToMany(Simple::class);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,31 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenericsSyntaxDisabled;
|
||||||
|
|
||||||
|
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.use_generics_annotations', 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();
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,37 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenericsSyntaxDisabled\Models;
|
||||||
|
|
||||||
|
use Illuminate\Database\Eloquent\Model;
|
||||||
|
use Illuminate\Database\Eloquent\Relations\BelongsToMany;
|
||||||
|
use Illuminate\Database\Eloquent\Relations\HasMany;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenericsSyntaxDisabled\Models\Simple
|
||||||
|
*
|
||||||
|
* @property integer $id
|
||||||
|
* @property-read \Illuminate\Database\Eloquent\Collection|Simple[] $regularBelongsToMany
|
||||||
|
* @property-read int|null $regular_belongs_to_many_count
|
||||||
|
* @property-read \Illuminate\Database\Eloquent\Collection|Simple[] $regularHasMany
|
||||||
|
* @property-read int|null $regular_has_many_count
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|Simple newModelQuery()
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|Simple newQuery()
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|Simple query()
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|Simple whereId($value)
|
||||||
|
* @mixin \Eloquent
|
||||||
|
*/
|
||||||
|
class Simple extends Model
|
||||||
|
{
|
||||||
|
// Regular relations
|
||||||
|
public function regularHasMany(): HasMany
|
||||||
|
{
|
||||||
|
return $this->hasMany(Simple::class);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function regularBelongsToMany(): BelongsToMany
|
||||||
|
{
|
||||||
|
return $this->belongsToMany(Simple::class);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -103,4 +103,8 @@ class Simple extends Model
|
|||||||
public function getAttributeReturnsVoidAttribute(): void
|
public function getAttributeReturnsVoidAttribute(): void
|
||||||
{
|
{
|
||||||
}
|
}
|
||||||
|
|
||||||
|
private function getInvalidAccessModifierAttribute()
|
||||||
|
{
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -133,4 +133,8 @@ class Simple extends Model
|
|||||||
public function getAttributeReturnsVoidAttribute(): void
|
public function getAttributeReturnsVoidAttribute(): void
|
||||||
{
|
{
|
||||||
}
|
}
|
||||||
|
|
||||||
|
private function getInvalidAccessModifierAttribute()
|
||||||
|
{
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,6 +1,7 @@
|
|||||||
<?php
|
<?php
|
||||||
|
|
||||||
// @formatter:off
|
// @formatter:off
|
||||||
|
// phpcs:ignoreFile
|
||||||
/**
|
/**
|
||||||
* A helper file for your Eloquent Models
|
* A helper file for your Eloquent Models
|
||||||
* Copy the phpDocs from this file to the correct Model,
|
* Copy the phpDocs from this file to the correct Model,
|
||||||
|
|||||||
+33
@@ -0,0 +1,33 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts;
|
||||||
|
|
||||||
|
use Illuminate\Contracts\Database\Eloquent\Castable;
|
||||||
|
use Illuminate\Contracts\Database\Eloquent\CastsAttributes;
|
||||||
|
|
||||||
|
class CastableReturnsAnonymousCaster implements Castable
|
||||||
|
{
|
||||||
|
public static function castUsing(array $arguments)
|
||||||
|
{
|
||||||
|
return new class () implements CastsAttributes {
|
||||||
|
/**
|
||||||
|
* @inheritDoc
|
||||||
|
* @return CastedProperty
|
||||||
|
*/
|
||||||
|
public function get($model, string $key, $value, array $attributes)
|
||||||
|
{
|
||||||
|
return new CastedProperty();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @inheritDoc
|
||||||
|
*/
|
||||||
|
public function set($model, string $key, $value, array $attributes)
|
||||||
|
{
|
||||||
|
// TODO: Implement set() method.
|
||||||
|
}
|
||||||
|
};
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,15 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts;
|
||||||
|
|
||||||
|
use Illuminate\Contracts\Database\Eloquent\Castable;
|
||||||
|
|
||||||
|
class CastableReturnsCustomCaster implements Castable
|
||||||
|
{
|
||||||
|
public static function castUsing(array $arguments)
|
||||||
|
{
|
||||||
|
return CustomCasterWithDocblockReturn::class;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,26 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts;
|
||||||
|
|
||||||
|
use Illuminate\Contracts\Database\Eloquent\Castable;
|
||||||
|
use Illuminate\Contracts\Database\Eloquent\CastsAttributes;
|
||||||
|
|
||||||
|
class CastableWithoutReturnType implements Castable
|
||||||
|
{
|
||||||
|
public static function castUsing(array $arguments)
|
||||||
|
{
|
||||||
|
return new class () implements CastsAttributes {
|
||||||
|
public function get($model, string $key, $value, array $attributes)
|
||||||
|
{
|
||||||
|
return new CastedProperty();
|
||||||
|
}
|
||||||
|
|
||||||
|
public function set($model, string $key, $value, array $attributes)
|
||||||
|
{
|
||||||
|
// TODO: Implement set() method.
|
||||||
|
}
|
||||||
|
};
|
||||||
|
}
|
||||||
|
}
|
||||||
+1
-1
@@ -10,7 +10,7 @@ class CustomCasterWithDocblockReturnFqn implements CastsAttributes
|
|||||||
{
|
{
|
||||||
/**
|
/**
|
||||||
* @inheritDoc
|
* @inheritDoc
|
||||||
* @return \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts\CastedProperty
|
* @return CastedProperty
|
||||||
*/
|
*/
|
||||||
public function get($model, string $key, $value, array $attributes)
|
public function get($model, string $key, $value, array $attributes)
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -0,0 +1,15 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts;
|
||||||
|
|
||||||
|
use Illuminate\Contracts\Database\Eloquent\CastsInboundAttributes;
|
||||||
|
|
||||||
|
class InboundAttributeCaster implements CastsInboundAttributes
|
||||||
|
{
|
||||||
|
public function set($model, string $key, $value, array $attributes)
|
||||||
|
{
|
||||||
|
// TODO: Implement set() method.
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -4,6 +4,9 @@ declare(strict_types=1);
|
|||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Models;
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Models;
|
||||||
|
|
||||||
|
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts\CastableReturnsAnonymousCaster;
|
||||||
|
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts\CastableReturnsCustomCaster;
|
||||||
|
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts\CastableWithoutReturnType;
|
||||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts\CustomCasterWithDocblockReturn;
|
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts\CustomCasterWithDocblockReturn;
|
||||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts\CustomCasterWithDocblockReturnFqn;
|
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts\CustomCasterWithDocblockReturnFqn;
|
||||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts\CustomCasterWithNullablePrimitiveReturn;
|
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts\CustomCasterWithNullablePrimitiveReturn;
|
||||||
@@ -14,6 +17,7 @@ use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Cas
|
|||||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts\CustomCasterWithReturnType;
|
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts\CustomCasterWithReturnType;
|
||||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts\ExtendedSelfCastingCasterWithStaticDocblockReturn;
|
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts\ExtendedSelfCastingCasterWithStaticDocblockReturn;
|
||||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts\ExtendedSelfCastingCasterWithThisDocblockReturn;
|
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts\ExtendedSelfCastingCasterWithThisDocblockReturn;
|
||||||
|
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts\InboundAttributeCaster;
|
||||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts\SelfCastingCasterWithStaticDocblockReturn;
|
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts\SelfCastingCasterWithStaticDocblockReturn;
|
||||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts\SelfCastingCasterWithThisDocblockReturn;
|
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts\SelfCastingCasterWithThisDocblockReturn;
|
||||||
use Illuminate\Database\Eloquent\Model;
|
use Illuminate\Database\Eloquent\Model;
|
||||||
@@ -27,12 +31,18 @@ class CustomCast extends Model
|
|||||||
'casted_property_with_return_primitive' => CustomCasterWithPrimitiveReturn::class,
|
'casted_property_with_return_primitive' => CustomCasterWithPrimitiveReturn::class,
|
||||||
'casted_property_with_return_primitive_docblock' => CustomCasterWithPrimitiveDocblockReturn::class,
|
'casted_property_with_return_primitive_docblock' => CustomCasterWithPrimitiveDocblockReturn::class,
|
||||||
'casted_property_with_return_nullable_primitive' => CustomCasterWithNullablePrimitiveReturn::class,
|
'casted_property_with_return_nullable_primitive' => CustomCasterWithNullablePrimitiveReturn::class,
|
||||||
|
'casted_property_with_return_nullable_primitive_and_nullable_column' => CustomCasterWithNullablePrimitiveReturn::class,
|
||||||
'casted_property_without_return' => CustomCasterWithoutReturnType::class,
|
'casted_property_without_return' => CustomCasterWithoutReturnType::class,
|
||||||
'casted_property_with_param' => CustomCasterWithParam::class . ':param',
|
'casted_property_with_param' => CustomCasterWithParam::class . ':param',
|
||||||
'casted_property_with_static_return_docblock' => SelfCastingCasterWithStaticDocblockReturn::class,
|
'casted_property_with_static_return_docblock' => SelfCastingCasterWithStaticDocblockReturn::class,
|
||||||
'casted_property_with_this_return_docblock' => SelfCastingCasterWithThisDocblockReturn::class,
|
'casted_property_with_this_return_docblock' => SelfCastingCasterWithThisDocblockReturn::class,
|
||||||
|
'casted_property_with_castable' => CastableReturnsCustomCaster::class,
|
||||||
|
'casted_property_with_anonymous_cast' => CastableReturnsAnonymousCaster::class,
|
||||||
|
'casted_property_without_return_type' => CastableWithoutReturnType::class,
|
||||||
'extended_casted_property_with_static_return_docblock' => ExtendedSelfCastingCasterWithStaticDocblockReturn::class,
|
'extended_casted_property_with_static_return_docblock' => ExtendedSelfCastingCasterWithStaticDocblockReturn::class,
|
||||||
'extended_casted_property_with_this_return_docblock' => ExtendedSelfCastingCasterWithThisDocblockReturn::class,
|
'extended_casted_property_with_this_return_docblock' => ExtendedSelfCastingCasterWithThisDocblockReturn::class,
|
||||||
'casted_property_with_static_return_docblock_and_param' => SelfCastingCasterWithStaticDocblockReturn::class . ':param',
|
'casted_property_with_static_return_docblock_and_param' => SelfCastingCasterWithStaticDocblockReturn::class . ':param',
|
||||||
|
'cast_without_property' => CustomCasterWithReturnType::class,
|
||||||
|
'cast_inbound_attribute' => InboundAttributeCaster::class,
|
||||||
];
|
];
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -6,19 +6,9 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCas
|
|||||||
|
|
||||||
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
|
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
|
||||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AbstractModelsCommand;
|
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AbstractModelsCommand;
|
||||||
use Illuminate\Foundation\Application;
|
|
||||||
|
|
||||||
class Test extends AbstractModelsCommand
|
class Test extends AbstractModelsCommand
|
||||||
{
|
{
|
||||||
protected function setUp(): void
|
|
||||||
{
|
|
||||||
parent::setUp();
|
|
||||||
|
|
||||||
if (version_compare(Application::VERSION, '7.0', '<')) {
|
|
||||||
$this->markTestSkipped('This test requires Laravel 7.0 or higher');
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
public function test(): void
|
public function test(): void
|
||||||
{
|
{
|
||||||
$command = $this->app->make(ModelsCommand::class);
|
$command = $this->app->make(ModelsCommand::class);
|
||||||
|
|||||||
@@ -4,6 +4,9 @@ declare(strict_types=1);
|
|||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Models;
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Models;
|
||||||
|
|
||||||
|
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts\CastableReturnsAnonymousCaster;
|
||||||
|
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts\CastableReturnsCustomCaster;
|
||||||
|
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts\CastableWithoutReturnType;
|
||||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts\CustomCasterWithDocblockReturn;
|
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts\CustomCasterWithDocblockReturn;
|
||||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts\CustomCasterWithDocblockReturnFqn;
|
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts\CustomCasterWithDocblockReturnFqn;
|
||||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts\CustomCasterWithNullablePrimitiveReturn;
|
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts\CustomCasterWithNullablePrimitiveReturn;
|
||||||
@@ -14,6 +17,7 @@ use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Cas
|
|||||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts\CustomCasterWithReturnType;
|
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts\CustomCasterWithReturnType;
|
||||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts\ExtendedSelfCastingCasterWithStaticDocblockReturn;
|
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts\ExtendedSelfCastingCasterWithStaticDocblockReturn;
|
||||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts\ExtendedSelfCastingCasterWithThisDocblockReturn;
|
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts\ExtendedSelfCastingCasterWithThisDocblockReturn;
|
||||||
|
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts\InboundAttributeCaster;
|
||||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts\SelfCastingCasterWithStaticDocblockReturn;
|
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts\SelfCastingCasterWithStaticDocblockReturn;
|
||||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts\SelfCastingCasterWithThisDocblockReturn;
|
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts\SelfCastingCasterWithThisDocblockReturn;
|
||||||
use Illuminate\Database\Eloquent\Model;
|
use Illuminate\Database\Eloquent\Model;
|
||||||
@@ -25,8 +29,9 @@ use Illuminate\Database\Eloquent\Model;
|
|||||||
* @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
|
||||||
* @property \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts\CastedProperty $casted_property_with_return_docblock_fqn
|
* @property \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts\CastedProperty $casted_property_with_return_docblock_fqn
|
||||||
* @property array $casted_property_with_return_primitive
|
* @property array $casted_property_with_return_primitive
|
||||||
* @property array|null $casted_property_with_return_primitive_docblock
|
* @property array $casted_property_with_return_primitive_docblock
|
||||||
* @property array|null $casted_property_with_return_nullable_primitive
|
* @property array $casted_property_with_return_nullable_primitive
|
||||||
|
* @property array|null $casted_property_with_return_nullable_primitive_and_nullable_column
|
||||||
* @property $casted_property_without_return
|
* @property $casted_property_without_return
|
||||||
* @property \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts\CastedProperty $casted_property_with_param
|
* @property \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts\CastedProperty $casted_property_with_param
|
||||||
* @property SelfCastingCasterWithStaticDocblockReturn $casted_property_with_static_return_docblock
|
* @property SelfCastingCasterWithStaticDocblockReturn $casted_property_with_static_return_docblock
|
||||||
@@ -34,6 +39,11 @@ use Illuminate\Database\Eloquent\Model;
|
|||||||
* @property ExtendedSelfCastingCasterWithStaticDocblockReturn $extended_casted_property_with_static_return_docblock
|
* @property ExtendedSelfCastingCasterWithStaticDocblockReturn $extended_casted_property_with_static_return_docblock
|
||||||
* @property ExtendedSelfCastingCasterWithThisDocblockReturn $extended_casted_property_with_this_return_docblock
|
* @property ExtendedSelfCastingCasterWithThisDocblockReturn $extended_casted_property_with_this_return_docblock
|
||||||
* @property SelfCastingCasterWithStaticDocblockReturn $casted_property_with_static_return_docblock_and_param
|
* @property SelfCastingCasterWithStaticDocblockReturn $casted_property_with_static_return_docblock_and_param
|
||||||
|
* @property \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts\CastedProperty $casted_property_with_castable
|
||||||
|
* @property \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts\CastedProperty $casted_property_with_anonymous_cast
|
||||||
|
* @property CastableWithoutReturnType $casted_property_without_return_type
|
||||||
|
* @property \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts\CastedProperty $cast_without_property
|
||||||
|
* @property mixed $cast_inbound_attribute
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder|CustomCast newModelQuery()
|
* @method static \Illuminate\Database\Eloquent\Builder|CustomCast newModelQuery()
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder|CustomCast newQuery()
|
* @method static \Illuminate\Database\Eloquent\Builder|CustomCast newQuery()
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder|CustomCast query()
|
* @method static \Illuminate\Database\Eloquent\Builder|CustomCast query()
|
||||||
@@ -41,6 +51,7 @@ use Illuminate\Database\Eloquent\Model;
|
|||||||
* @method static \Illuminate\Database\Eloquent\Builder|CustomCast whereCastedPropertyWithReturnDocblock($value)
|
* @method static \Illuminate\Database\Eloquent\Builder|CustomCast whereCastedPropertyWithReturnDocblock($value)
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder|CustomCast whereCastedPropertyWithReturnDocblockFqn($value)
|
* @method static \Illuminate\Database\Eloquent\Builder|CustomCast whereCastedPropertyWithReturnDocblockFqn($value)
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder|CustomCast whereCastedPropertyWithReturnNullablePrimitive($value)
|
* @method static \Illuminate\Database\Eloquent\Builder|CustomCast whereCastedPropertyWithReturnNullablePrimitive($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|CustomCast whereCastedPropertyWithReturnNullablePrimitiveAndNullableColumn($value)
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder|CustomCast whereCastedPropertyWithReturnPrimitive($value)
|
* @method static \Illuminate\Database\Eloquent\Builder|CustomCast whereCastedPropertyWithReturnPrimitive($value)
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder|CustomCast whereCastedPropertyWithReturnPrimitiveDocblock($value)
|
* @method static \Illuminate\Database\Eloquent\Builder|CustomCast whereCastedPropertyWithReturnPrimitiveDocblock($value)
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder|CustomCast whereCastedPropertyWithReturnType($value)
|
* @method static \Illuminate\Database\Eloquent\Builder|CustomCast whereCastedPropertyWithReturnType($value)
|
||||||
@@ -61,12 +72,18 @@ class CustomCast extends Model
|
|||||||
'casted_property_with_return_primitive' => CustomCasterWithPrimitiveReturn::class,
|
'casted_property_with_return_primitive' => CustomCasterWithPrimitiveReturn::class,
|
||||||
'casted_property_with_return_primitive_docblock' => CustomCasterWithPrimitiveDocblockReturn::class,
|
'casted_property_with_return_primitive_docblock' => CustomCasterWithPrimitiveDocblockReturn::class,
|
||||||
'casted_property_with_return_nullable_primitive' => CustomCasterWithNullablePrimitiveReturn::class,
|
'casted_property_with_return_nullable_primitive' => CustomCasterWithNullablePrimitiveReturn::class,
|
||||||
|
'casted_property_with_return_nullable_primitive_and_nullable_column' => CustomCasterWithNullablePrimitiveReturn::class,
|
||||||
'casted_property_without_return' => CustomCasterWithoutReturnType::class,
|
'casted_property_without_return' => CustomCasterWithoutReturnType::class,
|
||||||
'casted_property_with_param' => CustomCasterWithParam::class . ':param',
|
'casted_property_with_param' => CustomCasterWithParam::class . ':param',
|
||||||
'casted_property_with_static_return_docblock' => SelfCastingCasterWithStaticDocblockReturn::class,
|
'casted_property_with_static_return_docblock' => SelfCastingCasterWithStaticDocblockReturn::class,
|
||||||
'casted_property_with_this_return_docblock' => SelfCastingCasterWithThisDocblockReturn::class,
|
'casted_property_with_this_return_docblock' => SelfCastingCasterWithThisDocblockReturn::class,
|
||||||
|
'casted_property_with_castable' => CastableReturnsCustomCaster::class,
|
||||||
|
'casted_property_with_anonymous_cast' => CastableReturnsAnonymousCaster::class,
|
||||||
|
'casted_property_without_return_type' => CastableWithoutReturnType::class,
|
||||||
'extended_casted_property_with_static_return_docblock' => ExtendedSelfCastingCasterWithStaticDocblockReturn::class,
|
'extended_casted_property_with_static_return_docblock' => ExtendedSelfCastingCasterWithStaticDocblockReturn::class,
|
||||||
'extended_casted_property_with_this_return_docblock' => ExtendedSelfCastingCasterWithThisDocblockReturn::class,
|
'extended_casted_property_with_this_return_docblock' => ExtendedSelfCastingCasterWithThisDocblockReturn::class,
|
||||||
'casted_property_with_static_return_docblock_and_param' => SelfCastingCasterWithStaticDocblockReturn::class . ':param',
|
'casted_property_with_static_return_docblock_and_param' => SelfCastingCasterWithStaticDocblockReturn::class . ':param',
|
||||||
|
'cast_without_property' => CustomCasterWithReturnType::class,
|
||||||
|
'cast_inbound_attribute' => InboundAttributeCaster::class,
|
||||||
];
|
];
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,18 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\ModelHooks\Hooks;
|
||||||
|
|
||||||
|
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
|
||||||
|
use Barryvdh\LaravelIdeHelper\Contracts\ModelHookInterface;
|
||||||
|
use Illuminate\Database\Eloquent\Builder;
|
||||||
|
use Illuminate\Database\Eloquent\Model;
|
||||||
|
|
||||||
|
class CustomMethod implements ModelHookInterface
|
||||||
|
{
|
||||||
|
public function run(ModelsCommand $command, Model $model): void
|
||||||
|
{
|
||||||
|
$command->setMethod('custom', $command->getMethodType($model, Builder::class), ['$custom']);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,17 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\ModelHooks\Hooks;
|
||||||
|
|
||||||
|
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
|
||||||
|
use Barryvdh\LaravelIdeHelper\Contracts\ModelHookInterface;
|
||||||
|
use Illuminate\Database\Eloquent\Model;
|
||||||
|
|
||||||
|
class CustomProperty implements ModelHookInterface
|
||||||
|
{
|
||||||
|
public function run(ModelsCommand $command, Model $model): void
|
||||||
|
{
|
||||||
|
$command->setProperty('custom', 'string', true, false);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,17 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\ModelHooks\Hooks;
|
||||||
|
|
||||||
|
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
|
||||||
|
use Barryvdh\LaravelIdeHelper\Contracts\ModelHookInterface;
|
||||||
|
use Illuminate\Database\Eloquent\Model;
|
||||||
|
|
||||||
|
class UnsetMethod implements ModelHookInterface
|
||||||
|
{
|
||||||
|
public function run(ModelsCommand $command, Model $model): void
|
||||||
|
{
|
||||||
|
$command->unsetMethod('newmodelquery');
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\ModelHooks\Models;
|
||||||
|
|
||||||
|
use Illuminate\Database\Eloquent\Model;
|
||||||
|
|
||||||
|
class Simple extends Model
|
||||||
|
{
|
||||||
|
}
|
||||||
@@ -0,0 +1,92 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\ModelHooks;
|
||||||
|
|
||||||
|
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
|
||||||
|
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
|
||||||
|
{
|
||||||
|
protected function getEnvironmentSetUp($app)
|
||||||
|
{
|
||||||
|
parent::getEnvironmentSetUp($app);
|
||||||
|
|
||||||
|
$app['config']->set('ide-helper', [
|
||||||
|
'model_locations' => [
|
||||||
|
// This is calculated from the base_path() which points to
|
||||||
|
// vendor/orchestra/testbench-core/laravel
|
||||||
|
'/../../../../tests/Console/ModelsCommand/ModelHooks/Models',
|
||||||
|
],
|
||||||
|
'model_hooks' => [
|
||||||
|
CustomProperty::class,
|
||||||
|
CustomMethod::class,
|
||||||
|
UnsetMethod::class,
|
||||||
|
],
|
||||||
|
]);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function test(): void
|
||||||
|
{
|
||||||
|
$actualContent = null;
|
||||||
|
|
||||||
|
$mockFilesystem = Mockery::mock(Filesystem::class);
|
||||||
|
$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, [
|
||||||
|
'--write' => true,
|
||||||
|
]);
|
||||||
|
|
||||||
|
$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;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\ModelHooks\Models\Simple
|
||||||
|
*
|
||||||
|
* @property int $id
|
||||||
|
* @property-read string $custom
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|Simple custom($custom)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|Simple newQuery()
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|Simple query()
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|Simple whereId($value)
|
||||||
|
* @mixin \Eloquent
|
||||||
|
*/
|
||||||
|
class Simple extends Model
|
||||||
|
{
|
||||||
|
}
|
||||||
|
|
||||||
|
PHP;
|
||||||
|
|
||||||
|
$this->assertSame($expectedContent, $actualContent);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -83,7 +83,7 @@ use Illuminate\Database\Eloquent\Relations\HasMany;
|
|||||||
* @property string $macaddress_not_nullable
|
* @property string $macaddress_not_nullable
|
||||||
* @property \Illuminate\Support\Carbon|null $created_at
|
* @property \Illuminate\Support\Carbon|null $created_at
|
||||||
* @property \Illuminate\Support\Carbon|null $updated_at
|
* @property \Illuminate\Support\Carbon|null $updated_at
|
||||||
* @property-read \Illuminate\Database\Eloquent\Collection|Post[] $relationHasMany
|
* @property-read \Illuminate\Database\Eloquent\Collection<int, Post> $relationHasMany
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder|Post newModelQuery()
|
* @method static \Illuminate\Database\Eloquent\Builder|Post newModelQuery()
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder|Post newQuery()
|
* @method static \Illuminate\Database\Eloquent\Builder|Post newQuery()
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder|Post query()
|
* @method static \Illuminate\Database\Eloquent\Builder|Post query()
|
||||||
|
|||||||
@@ -0,0 +1,31 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Models;
|
||||||
|
|
||||||
|
use Illuminate\Database\Eloquent\Model;
|
||||||
|
use Illuminate\Database\Eloquent\Relations\BelongsTo;
|
||||||
|
|
||||||
|
class BelongsToVariation extends Model
|
||||||
|
{
|
||||||
|
public function notNullColumnWithForeignKeyConstraint(): BelongsTo
|
||||||
|
{
|
||||||
|
return $this->belongsTo(self::class, 'not_null_column_with_foreign_key_constraint');
|
||||||
|
}
|
||||||
|
|
||||||
|
public function notNullColumnWithNoForeignKeyConstraint(): BelongsTo
|
||||||
|
{
|
||||||
|
return $this->belongsTo(self::class, 'not_null_column_with_no_foreign_key_constraint');
|
||||||
|
}
|
||||||
|
|
||||||
|
public function nullableColumnWithForeignKeyConstraint(): BelongsTo
|
||||||
|
{
|
||||||
|
return $this->belongsTo(self::class, 'nullable_column_with_foreign_key_constraint');
|
||||||
|
}
|
||||||
|
|
||||||
|
public function nullableColumnWithNoForeignKeyConstraint(): BelongsTo
|
||||||
|
{
|
||||||
|
return $this->belongsTo(self::class, 'nullable_column_with_no_foreign_key_constraint');
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,41 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Models;
|
||||||
|
|
||||||
|
use Illuminate\Database\Eloquent\Model;
|
||||||
|
use Illuminate\Database\Eloquent\Relations\BelongsTo;
|
||||||
|
|
||||||
|
class CompositeBelongsToVariation extends Model
|
||||||
|
{
|
||||||
|
public $table = 'belongs_to_variations';
|
||||||
|
|
||||||
|
public function bothNonNullableWithForeignKeyConstraint(): BelongsTo
|
||||||
|
{
|
||||||
|
// Note, duplicating the keys here for simplicity.
|
||||||
|
return $this->belongsTo(
|
||||||
|
self::class,
|
||||||
|
['not_null_column_with_foreign_key_constraint', 'not_null_column_with_foreign_key_constraint'],
|
||||||
|
['not_null_column_with_foreign_key_constraint', 'not_null_column_with_foreign_key_constraint'],
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function nonNullableMixedWithoutForeignKeyConstraint(): BelongsTo
|
||||||
|
{
|
||||||
|
return $this->belongsTo(
|
||||||
|
self::class,
|
||||||
|
['not_null_column_with_foreign_key_constraint', 'not_null_column_with_no_foreign_key_constraint'],
|
||||||
|
['not_null_column_with_foreign_key_constraint', 'not_null_column_with_no_foreign_key_constraint'],
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function nullableMixedWithForeignKeyConstraint(): BelongsTo
|
||||||
|
{
|
||||||
|
return $this->belongsTo(
|
||||||
|
self::class,
|
||||||
|
['nullable_column_with_no_foreign_key_constraint', 'not_null_column_with_foreign_key_constraint'],
|
||||||
|
['nullable_column_with_no_foreign_key_constraint', 'not_null_column_with_foreign_key_constraint'],
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -97,4 +97,19 @@ class Simple extends Model
|
|||||||
{
|
{
|
||||||
return $this->testToManyRelation(Simple::class);
|
return $this->testToManyRelation(Simple::class);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public function relationSampleToAnyRelationType()
|
||||||
|
{
|
||||||
|
return $this->testToAnyRelation(Simple::class);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function relationSampleToAnyMorphedRelationType()
|
||||||
|
{
|
||||||
|
return $this->testToAnyMorphedRelation(Simple::class);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function relationSampleToBadlyNamedNotManyRelation()
|
||||||
|
{
|
||||||
|
return $this->testToBadlyNamedNotManyRelation(Simple::class);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -6,6 +6,9 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations;
|
|||||||
|
|
||||||
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
|
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
|
||||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AbstractModelsCommand;
|
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AbstractModelsCommand;
|
||||||
|
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Types\SampleToAnyMorphedRelationType;
|
||||||
|
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Types\SampleToAnyRelationType;
|
||||||
|
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Types\SampleToBadlyNamedNotManyRelationType;
|
||||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Types\SampleToManyRelationType;
|
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Types\SampleToManyRelationType;
|
||||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Types\SampleToOneRelationType;
|
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Types\SampleToOneRelationType;
|
||||||
use Illuminate\Support\Facades\Config;
|
use Illuminate\Support\Facades\Config;
|
||||||
@@ -19,6 +22,15 @@ class Test extends AbstractModelsCommand
|
|||||||
Config::set('ide-helper.additional_relation_types', [
|
Config::set('ide-helper.additional_relation_types', [
|
||||||
'testToOneRelation' => SampleToOneRelationType::class,
|
'testToOneRelation' => SampleToOneRelationType::class,
|
||||||
'testToManyRelation' => SampleToManyRelationType::class,
|
'testToManyRelation' => SampleToManyRelationType::class,
|
||||||
|
'testToAnyRelation' => SampleToAnyRelationType::class,
|
||||||
|
'testToAnyMorphedRelation' => SampleToAnyMorphedRelationType::class,
|
||||||
|
'testToBadlyNamedNotManyRelation' => SampleToBadlyNamedNotManyRelationType::class,
|
||||||
|
]);
|
||||||
|
|
||||||
|
Config::set('ide-helper.additional_relation_return_types', [
|
||||||
|
'testToAnyRelation' => 'many',
|
||||||
|
'testToAnyMorphedRelation' => 'morphTo',
|
||||||
|
'testToBadlyNamedNotManyRelation' => 'one',
|
||||||
]);
|
]);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -4,6 +4,9 @@ declare(strict_types=1);
|
|||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Traits;
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Traits;
|
||||||
|
|
||||||
|
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Types\SampleToAnyMorphedRelationType;
|
||||||
|
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Types\SampleToAnyRelationType;
|
||||||
|
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Types\SampleToBadlyNamedNotManyRelationType;
|
||||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Types\SampleToManyRelationType;
|
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Types\SampleToManyRelationType;
|
||||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Types\SampleToOneRelationType;
|
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Types\SampleToOneRelationType;
|
||||||
|
|
||||||
@@ -20,4 +23,22 @@ trait HasTestRelations
|
|||||||
$instance = $this->newRelatedInstance($related);
|
$instance = $this->newRelatedInstance($related);
|
||||||
return new SampleToManyRelationType($instance->newQuery(), $this);
|
return new SampleToManyRelationType($instance->newQuery(), $this);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public function testToAnyRelation($related)
|
||||||
|
{
|
||||||
|
$instance = $this->newRelatedInstance($related);
|
||||||
|
return new SampleToAnyRelationType($instance->newQuery(), $this);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testToAnyMorphedRelation($related)
|
||||||
|
{
|
||||||
|
$instance = $this->newRelatedInstance($related);
|
||||||
|
return new SampleToAnyMorphedRelationType($instance->newQuery(), $this);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testToBadlyNamedNotManyRelation($related)
|
||||||
|
{
|
||||||
|
$instance = $this->newRelatedInstance($related);
|
||||||
|
return new SampleToBadlyNamedNotManyRelationType($instance->newQuery(), $this);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,36 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Types;
|
||||||
|
|
||||||
|
use Illuminate\Database\Eloquent\Collection;
|
||||||
|
use Illuminate\Database\Eloquent\Relations\Relation;
|
||||||
|
|
||||||
|
class SampleToAnyMorphedRelationType extends Relation
|
||||||
|
{
|
||||||
|
public function addConstraints()
|
||||||
|
{
|
||||||
|
// Fake
|
||||||
|
}
|
||||||
|
|
||||||
|
public function addEagerConstraints(array $models)
|
||||||
|
{
|
||||||
|
// Fake
|
||||||
|
}
|
||||||
|
|
||||||
|
public function initRelation(array $models, $relation)
|
||||||
|
{
|
||||||
|
// Fake
|
||||||
|
}
|
||||||
|
|
||||||
|
public function match(array $models, Collection $results, $relation)
|
||||||
|
{
|
||||||
|
// Fake
|
||||||
|
}
|
||||||
|
|
||||||
|
public function getResults()
|
||||||
|
{
|
||||||
|
// Fake
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,36 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Types;
|
||||||
|
|
||||||
|
use Illuminate\Database\Eloquent\Collection;
|
||||||
|
use Illuminate\Database\Eloquent\Relations\Relation;
|
||||||
|
|
||||||
|
class SampleToAnyRelationType extends Relation
|
||||||
|
{
|
||||||
|
public function addConstraints()
|
||||||
|
{
|
||||||
|
// Fake
|
||||||
|
}
|
||||||
|
|
||||||
|
public function addEagerConstraints(array $models)
|
||||||
|
{
|
||||||
|
// Fake
|
||||||
|
}
|
||||||
|
|
||||||
|
public function initRelation(array $models, $relation)
|
||||||
|
{
|
||||||
|
// Fake
|
||||||
|
}
|
||||||
|
|
||||||
|
public function match(array $models, Collection $results, $relation)
|
||||||
|
{
|
||||||
|
// Fake
|
||||||
|
}
|
||||||
|
|
||||||
|
public function getResults()
|
||||||
|
{
|
||||||
|
// Fake
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,52 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Types;
|
||||||
|
|
||||||
|
use Illuminate\Database\Eloquent\Collection;
|
||||||
|
use Illuminate\Database\Eloquent\Model;
|
||||||
|
use Illuminate\Database\Eloquent\Relations\Concerns\SupportsDefaultModels;
|
||||||
|
use Illuminate\Database\Eloquent\Relations\Relation;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sample for custom relation
|
||||||
|
*
|
||||||
|
* the relation is a big fake and only for testing of the docblock generation
|
||||||
|
*
|
||||||
|
* @package Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations
|
||||||
|
*/
|
||||||
|
class SampleToBadlyNamedNotManyRelationType extends Relation
|
||||||
|
{
|
||||||
|
use SupportsDefaultModels;
|
||||||
|
|
||||||
|
public function addConstraints()
|
||||||
|
{
|
||||||
|
// Fake
|
||||||
|
}
|
||||||
|
|
||||||
|
public function addEagerConstraints(array $models)
|
||||||
|
{
|
||||||
|
// Fake
|
||||||
|
}
|
||||||
|
|
||||||
|
public function initRelation(array $models, $relation)
|
||||||
|
{
|
||||||
|
// Fake
|
||||||
|
}
|
||||||
|
|
||||||
|
public function match(array $models, Collection $results, $relation)
|
||||||
|
{
|
||||||
|
// Fake
|
||||||
|
}
|
||||||
|
|
||||||
|
public function getResults()
|
||||||
|
{
|
||||||
|
// Fake
|
||||||
|
}
|
||||||
|
|
||||||
|
protected function newRelatedInstanceFor(Model $parent)
|
||||||
|
{
|
||||||
|
// Fake
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -4,6 +4,121 @@ declare(strict_types=1);
|
|||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Models;
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Models;
|
||||||
|
|
||||||
|
use Illuminate\Database\Eloquent\Model;
|
||||||
|
use Illuminate\Database\Eloquent\Relations\BelongsTo;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Models\BelongsToVariation
|
||||||
|
*
|
||||||
|
* @property integer $id
|
||||||
|
* @property integer $not_null_column_with_foreign_key_constraint
|
||||||
|
* @property integer $not_null_column_with_no_foreign_key_constraint
|
||||||
|
* @property integer|null $nullable_column_with_foreign_key_constraint
|
||||||
|
* @property integer|null $nullable_column_with_no_foreign_key_constraint
|
||||||
|
* @property-read BelongsToVariation $notNullColumnWithForeignKeyConstraint
|
||||||
|
* @property-read BelongsToVariation|null $notNullColumnWithNoForeignKeyConstraint
|
||||||
|
* @property-read BelongsToVariation|null $nullableColumnWithForeignKeyConstraint
|
||||||
|
* @property-read BelongsToVariation|null $nullableColumnWithNoForeignKeyConstraint
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|BelongsToVariation newModelQuery()
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|BelongsToVariation newQuery()
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|BelongsToVariation query()
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|BelongsToVariation whereId($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|BelongsToVariation whereNotNullColumnWithForeignKeyConstraint($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|BelongsToVariation whereNotNullColumnWithNoForeignKeyConstraint($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|BelongsToVariation whereNullableColumnWithForeignKeyConstraint($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|BelongsToVariation whereNullableColumnWithNoForeignKeyConstraint($value)
|
||||||
|
* @mixin \Eloquent
|
||||||
|
*/
|
||||||
|
class BelongsToVariation extends Model
|
||||||
|
{
|
||||||
|
public function notNullColumnWithForeignKeyConstraint(): BelongsTo
|
||||||
|
{
|
||||||
|
return $this->belongsTo(self::class, 'not_null_column_with_foreign_key_constraint');
|
||||||
|
}
|
||||||
|
|
||||||
|
public function notNullColumnWithNoForeignKeyConstraint(): BelongsTo
|
||||||
|
{
|
||||||
|
return $this->belongsTo(self::class, 'not_null_column_with_no_foreign_key_constraint');
|
||||||
|
}
|
||||||
|
|
||||||
|
public function nullableColumnWithForeignKeyConstraint(): BelongsTo
|
||||||
|
{
|
||||||
|
return $this->belongsTo(self::class, 'nullable_column_with_foreign_key_constraint');
|
||||||
|
}
|
||||||
|
|
||||||
|
public function nullableColumnWithNoForeignKeyConstraint(): BelongsTo
|
||||||
|
{
|
||||||
|
return $this->belongsTo(self::class, 'nullable_column_with_no_foreign_key_constraint');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Models;
|
||||||
|
|
||||||
|
use Illuminate\Database\Eloquent\Model;
|
||||||
|
use Illuminate\Database\Eloquent\Relations\BelongsTo;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Models\CompositeBelongsToVariation
|
||||||
|
*
|
||||||
|
* @property integer $id
|
||||||
|
* @property integer $not_null_column_with_foreign_key_constraint
|
||||||
|
* @property integer $not_null_column_with_no_foreign_key_constraint
|
||||||
|
* @property integer|null $nullable_column_with_foreign_key_constraint
|
||||||
|
* @property integer|null $nullable_column_with_no_foreign_key_constraint
|
||||||
|
* @property-read CompositeBelongsToVariation $bothNonNullableWithForeignKeyConstraint
|
||||||
|
* @property-read CompositeBelongsToVariation|null $nonNullableMixedWithoutForeignKeyConstraint
|
||||||
|
* @property-read CompositeBelongsToVariation|null $nullableMixedWithForeignKeyConstraint
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|CompositeBelongsToVariation newModelQuery()
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|CompositeBelongsToVariation newQuery()
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|CompositeBelongsToVariation query()
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|CompositeBelongsToVariation whereId($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|CompositeBelongsToVariation whereNotNullColumnWithForeignKeyConstraint($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|CompositeBelongsToVariation whereNotNullColumnWithNoForeignKeyConstraint($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|CompositeBelongsToVariation whereNullableColumnWithForeignKeyConstraint($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder|CompositeBelongsToVariation whereNullableColumnWithNoForeignKeyConstraint($value)
|
||||||
|
* @mixin \Eloquent
|
||||||
|
*/
|
||||||
|
class CompositeBelongsToVariation extends Model
|
||||||
|
{
|
||||||
|
public $table = 'belongs_to_variations';
|
||||||
|
|
||||||
|
public function bothNonNullableWithForeignKeyConstraint(): BelongsTo
|
||||||
|
{
|
||||||
|
// Note, duplicating the keys here for simplicity.
|
||||||
|
return $this->belongsTo(
|
||||||
|
self::class,
|
||||||
|
['not_null_column_with_foreign_key_constraint', 'not_null_column_with_foreign_key_constraint'],
|
||||||
|
['not_null_column_with_foreign_key_constraint', 'not_null_column_with_foreign_key_constraint'],
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function nonNullableMixedWithoutForeignKeyConstraint(): BelongsTo
|
||||||
|
{
|
||||||
|
return $this->belongsTo(
|
||||||
|
self::class,
|
||||||
|
['not_null_column_with_foreign_key_constraint', 'not_null_column_with_no_foreign_key_constraint'],
|
||||||
|
['not_null_column_with_foreign_key_constraint', 'not_null_column_with_no_foreign_key_constraint'],
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function nullableMixedWithForeignKeyConstraint(): BelongsTo
|
||||||
|
{
|
||||||
|
return $this->belongsTo(
|
||||||
|
self::class,
|
||||||
|
['nullable_column_with_no_foreign_key_constraint', 'not_null_column_with_foreign_key_constraint'],
|
||||||
|
['nullable_column_with_no_foreign_key_constraint', 'not_null_column_with_foreign_key_constraint'],
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Models;
|
||||||
|
|
||||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\ModelsOtherNamespace\AnotherModel;
|
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\ModelsOtherNamespace\AnotherModel;
|
||||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Traits\HasTestRelations;
|
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Traits\HasTestRelations;
|
||||||
use Illuminate\Database\Eloquent\Model;
|
use Illuminate\Database\Eloquent\Model;
|
||||||
@@ -20,27 +135,31 @@ use Illuminate\Database\Eloquent\Relations\MorphToMany;
|
|||||||
* Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Models\Simple
|
* Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Models\Simple
|
||||||
*
|
*
|
||||||
* @property integer $id
|
* @property integer $id
|
||||||
* @property-read Simple $relationBelongsTo
|
* @property-read Simple|null $relationBelongsTo
|
||||||
* @property-read AnotherModel $relationBelongsToInAnotherNamespace
|
* @property-read AnotherModel|null $relationBelongsToInAnotherNamespace
|
||||||
* @property-read \Illuminate\Database\Eloquent\Collection|Simple[] $relationBelongsToMany
|
* @property-read \Illuminate\Database\Eloquent\Collection<int, Simple> $relationBelongsToMany
|
||||||
* @property-read int|null $relation_belongs_to_many_count
|
* @property-read int|null $relation_belongs_to_many_count
|
||||||
* @property-read \Illuminate\Database\Eloquent\Collection|Simple[] $relationBelongsToManyWithSub
|
* @property-read \Illuminate\Database\Eloquent\Collection<int, Simple> $relationBelongsToManyWithSub
|
||||||
* @property-read int|null $relation_belongs_to_many_with_sub_count
|
* @property-read int|null $relation_belongs_to_many_with_sub_count
|
||||||
* @property-read \Illuminate\Database\Eloquent\Collection|Simple[] $relationBelongsToManyWithSubAnother
|
* @property-read \Illuminate\Database\Eloquent\Collection<int, Simple> $relationBelongsToManyWithSubAnother
|
||||||
* @property-read int|null $relation_belongs_to_many_with_sub_another_count
|
* @property-read int|null $relation_belongs_to_many_with_sub_another_count
|
||||||
* @property-read AnotherModel $relationBelongsToSameNameAsColumn
|
* @property-read AnotherModel|null $relationBelongsToSameNameAsColumn
|
||||||
* @property-read \Illuminate\Database\Eloquent\Collection|Simple[] $relationHasMany
|
* @property-read \Illuminate\Database\Eloquent\Collection<int, Simple> $relationHasMany
|
||||||
* @property-read int|null $relation_has_many_count
|
* @property-read int|null $relation_has_many_count
|
||||||
* @property-read Simple|null $relationHasOne
|
* @property-read Simple|null $relationHasOne
|
||||||
* @property-read Simple $relationHasOneWithDefault
|
* @property-read Simple $relationHasOneWithDefault
|
||||||
* @property-read \Illuminate\Database\Eloquent\Collection|Simple[] $relationMorphMany
|
* @property-read \Illuminate\Database\Eloquent\Collection<int, Simple> $relationMorphMany
|
||||||
* @property-read int|null $relation_morph_many_count
|
* @property-read int|null $relation_morph_many_count
|
||||||
* @property-read Simple|null $relationMorphOne
|
* @property-read Simple|null $relationMorphOne
|
||||||
* @property-read Model|\Eloquent $relationMorphTo
|
* @property-read Model|\Eloquent $relationMorphTo
|
||||||
* @property-read \Illuminate\Database\Eloquent\Collection|Simple[] $relationMorphedByMany
|
* @property-read \Illuminate\Database\Eloquent\Collection<int, Simple> $relationMorphedByMany
|
||||||
* @property-read int|null $relation_morphed_by_many_count
|
* @property-read int|null $relation_morphed_by_many_count
|
||||||
* @property-read \Illuminate\Database\Eloquent\Collection|Simple[] $relationSampleRelationType
|
* @property-read \Illuminate\Database\Eloquent\Collection<int, Simple> $relationSampleRelationType
|
||||||
* @property-read int|null $relation_sample_relation_type_count
|
* @property-read int|null $relation_sample_relation_type_count
|
||||||
|
* @property-read Model|\Eloquent $relationSampleToAnyMorphedRelationType
|
||||||
|
* @property-read \Illuminate\Database\Eloquent\Collection<int, Simple> $relationSampleToAnyRelationType
|
||||||
|
* @property-read int|null $relation_sample_to_any_relation_type_count
|
||||||
|
* @property-read Simple $relationSampleToBadlyNamedNotManyRelation
|
||||||
* @property-read Simple $relationSampleToManyRelationType
|
* @property-read Simple $relationSampleToManyRelationType
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder|Simple newModelQuery()
|
* @method static \Illuminate\Database\Eloquent\Builder|Simple newModelQuery()
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder|Simple newQuery()
|
* @method static \Illuminate\Database\Eloquent\Builder|Simple newQuery()
|
||||||
@@ -129,4 +248,19 @@ class Simple extends Model
|
|||||||
{
|
{
|
||||||
return $this->testToManyRelation(Simple::class);
|
return $this->testToManyRelation(Simple::class);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public function relationSampleToAnyRelationType()
|
||||||
|
{
|
||||||
|
return $this->testToAnyRelation(Simple::class);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function relationSampleToAnyMorphedRelationType()
|
||||||
|
{
|
||||||
|
return $this->testToAnyMorphedRelation(Simple::class);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function relationSampleToBadlyNamedNotManyRelation()
|
||||||
|
{
|
||||||
|
return $this->testToBadlyNamedNotManyRelation(Simple::class);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user