mirror of
https://github.com/barryvdh/laravel-ide-helper.git
synced 2026-08-18 01:57:13 +00:00
Compare commits
27
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
2a41415f01 | ||
|
|
a7fc73e8e4 | ||
|
|
f343efa140 | ||
|
|
0fa0403e57 | ||
|
|
97e3b5eaa0 | ||
|
|
99554aef3c | ||
|
|
0b2eeb4627 | ||
|
|
4ad74ba241 | ||
|
|
347483be03 | ||
|
|
14fdb572bb | ||
|
|
c33eacdefc | ||
|
|
a25b947851 | ||
|
|
59eb26742b | ||
|
|
b7675670f7 | ||
|
|
edb56754d1 | ||
|
|
4d2728c4f0 | ||
|
|
5da09fad67 | ||
|
|
788e72e7dd | ||
|
|
e3ec773374 | ||
|
|
64588afe8b | ||
|
|
472c1bad5d | ||
|
|
90e7c5ac47 | ||
|
|
07e3bd8796 | ||
|
|
7c2fa01d36 | ||
|
|
75b05a9f74 | ||
|
|
71aa6a6cf3 | ||
|
|
be806dc316 |
@@ -13,6 +13,5 @@
|
|||||||
|
|
||||||
### Checklist
|
### Checklist
|
||||||
- [ ] Existing tests have been adapted and/or new tests have been added
|
- [ ] Existing tests have been adapted and/or new tests have been added
|
||||||
- [ ] Add a CHANGELOG.md entry
|
|
||||||
- [ ] Update the README.md
|
- [ ] Update the README.md
|
||||||
- [ ] Code style has been fixed via `composer fix-style`
|
- [ ] Code style has been fixed via `composer fix-style`
|
||||||
|
|||||||
@@ -0,0 +1,4 @@
|
|||||||
|
template: |
|
||||||
|
## What’s Changed
|
||||||
|
|
||||||
|
$CHANGES
|
||||||
@@ -0,0 +1,41 @@
|
|||||||
|
name: Release Drafter
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
# branches to consider in the event; optional, defaults to all
|
||||||
|
branches:
|
||||||
|
- master
|
||||||
|
# pull_request event is required only for autolabeler
|
||||||
|
pull_request:
|
||||||
|
# Only following types are handled by the action, but one can default to all as well
|
||||||
|
types: [opened, reopened, synchronize]
|
||||||
|
# pull_request_target event is required for autolabeler to support PRs from forks
|
||||||
|
# pull_request_target:
|
||||||
|
# types: [opened, reopened, synchronize]
|
||||||
|
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
update_release_draft:
|
||||||
|
permissions:
|
||||||
|
# write permission is required to create a github release
|
||||||
|
contents: write
|
||||||
|
# write permission is required for autolabeler
|
||||||
|
# otherwise, read permission is required at least
|
||||||
|
pull-requests: write
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
# (Optional) GitHub Enterprise requires GHE_HOST variable set
|
||||||
|
#- name: Set GHE_HOST
|
||||||
|
# run: |
|
||||||
|
# echo "GHE_HOST=${GITHUB_SERVER_URL##https:\/\/}" >> $GITHUB_ENV
|
||||||
|
|
||||||
|
# Drafts your next Release notes as Pull Requests are merged into "master"
|
||||||
|
- uses: release-drafter/release-drafter@v6
|
||||||
|
# (Optional) specify config name to use, relative to .github/. Default: release-drafter.yml
|
||||||
|
# with:
|
||||||
|
# config-name: my-config.yml
|
||||||
|
# disable-autolabeler: true
|
||||||
|
env:
|
||||||
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
@@ -0,0 +1,34 @@
|
|||||||
|
name: "Update Changelog"
|
||||||
|
|
||||||
|
on:
|
||||||
|
release:
|
||||||
|
types: [released]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
update:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
|
permissions:
|
||||||
|
# Give the default GITHUB_TOKEN write permission to commit and push the
|
||||||
|
# updated CHANGELOG back to the repository.
|
||||||
|
# https://github.blog/changelog/2023-02-02-github-actions-updating-the-default-github_token-permissions-to-read-only/
|
||||||
|
contents: write
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Checkout code
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
ref: ${{ github.event.release.target_commitish }}
|
||||||
|
|
||||||
|
- name: Update Changelog
|
||||||
|
uses: stefanzweifel/changelog-updater-action@v1
|
||||||
|
with:
|
||||||
|
latest-version: ${{ github.event.release.tag_name }}
|
||||||
|
release-notes: ${{ github.event.release.body }}
|
||||||
|
|
||||||
|
- name: Commit updated CHANGELOG
|
||||||
|
uses: stefanzweifel/git-auto-commit-action@v5
|
||||||
|
with:
|
||||||
|
branch: ${{ github.event.release.target_commitish }}
|
||||||
|
commit_message: Update CHANGELOG
|
||||||
|
file_pattern: CHANGELOG.md
|
||||||
+212
-130
@@ -1,74 +1,120 @@
|
|||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
All notable changes to this project will be documented in this file.
|
## v3.3.0 - 2024-12-18
|
||||||
|
|
||||||
[Next release](https://github.com/barryvdh/laravel-ide-helper/compare/v3.2.0...master)
|
### What's Changed
|
||||||
--------------
|
|
||||||
|
|
||||||
### Changed
|
* Feature: Add Config Option to Enforce Nullable Relationships by @jeramyhing in https://github.com/barryvdh/laravel-ide-helper/pull/1580
|
||||||
- Add support for multiple pivot types when using the same accessor.
|
* Improve replacement of return type for methods from Query\Builder by @pjio in https://github.com/barryvdh/laravel-ide-helper/pull/1575
|
||||||
- Smarter reset, keep tags that IDE helper doesn't use
|
* Update CHANGELOG.md, fix typo(s) by @NicholasWilsonDEV in https://github.com/barryvdh/laravel-ide-helper/pull/1613
|
||||||
- Use `numeric` type on fields with `decimal` casts
|
* Fixed PHP 8.4 deprecation warning by @eusonlito in https://github.com/barryvdh/laravel-ide-helper/pull/1622
|
||||||
|
* Fix PHP 8.4 deprecations by @JeppeKnockaert in https://github.com/barryvdh/laravel-ide-helper/pull/1618
|
||||||
|
* Assign $output method parameter to $this->output on Generator by @eusonlito in https://github.com/barryvdh/laravel-ide-helper/pull/1623
|
||||||
|
|
||||||
|
### New Contributors
|
||||||
|
|
||||||
2024-10-18, 3.2.0
|
* @jeramyhing made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1580
|
||||||
--------------
|
* @pjio made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1575
|
||||||
|
* @NicholasWilsonDEV made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1613
|
||||||
|
* @eusonlito made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1622
|
||||||
|
|
||||||
|
**Full Changelog**: https://github.com/barryvdh/laravel-ide-helper/compare/v3.2.2...v3.3.0
|
||||||
|
|
||||||
|
## v3.2.2 - 2024-10-29
|
||||||
|
|
||||||
|
### What’s Changed
|
||||||
|
|
||||||
|
* fix(pivot): only use unique classes in the pivot union (Fixes #1606) (#1607) @pataar
|
||||||
|
* docs(pr): remove the changelog checklist item (#1608) @pataar
|
||||||
|
* Create update-changelog.yaml (#1605) @barryvdh
|
||||||
|
|
||||||
|
**Full Changelog**: https://github.com/barryvdh/laravel-ide-helper/compare/v3.2.1...v3.2.2
|
||||||
|
|
||||||
|
## 3.2.1 - 2024-10-28
|
||||||
|
|
||||||
|
### What's Changed
|
||||||
|
|
||||||
|
* chore: Fix the description of unused option by @KentarouTakeda in https://github.com/barryvdh/laravel-ide-helper/pull/1600
|
||||||
|
* feat(pivot): add support for multiple pivot types when using the same accessor by @pataar in https://github.com/barryvdh/laravel-ide-helper/pull/1597
|
||||||
|
* Add support for `AsCollection::using` and `AsEnumCollection::of` casts by @uno-sw in https://github.com/barryvdh/laravel-ide-helper/pull/1577
|
||||||
|
* Smarter reset by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1603
|
||||||
|
* feat: use `numeric` type on fields with `decimal` casts by @ekisu in https://github.com/barryvdh/laravel-ide-helper/pull/1583
|
||||||
|
|
||||||
|
### New Contributors
|
||||||
|
|
||||||
|
* @uno-sw made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1577
|
||||||
|
* @ekisu made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1583
|
||||||
|
|
||||||
|
**Full Changelog**: https://github.com/barryvdh/laravel-ide-helper/compare/v3.2.0...v3.2.1
|
||||||
|
|
||||||
|
## 3.2.0 - 2024-10-18
|
||||||
|
|
||||||
### Fixed
|
### Fixed
|
||||||
|
|
||||||
- Fix type of hashed model property to `string`
|
- Fix type of hashed model property to `string`
|
||||||
|
|
||||||
### Changed
|
### Changed
|
||||||
|
- Update view "version" variable name to avoid potential conflicts
|
||||||
|
|
||||||
- Add support for EloquentBuilder generics introduced in Laravel 11.15.
|
- Add support for EloquentBuilder generics introduced in Laravel 11.15.
|
||||||
- Drop support for Laravel versions earlier than 11.15.
|
- Drop support for Laravel versions earlier than 11.15.
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|
||||||
|
- Introduce `enforce_nullable_relationships` configuration option to control how nullable Eloquent relationships are enforced during static analysis. This provides flexibility for scenarios where application logic ensures data integrity without relying on database constraints. [#1580 / jeramyhing](https://github.com/barryvdh/laravel-ide-helper/pull/1580)
|
||||||
|
|
||||||
- Add support for AsCollection::using and AsEnumCollection::of casts [#1577 / uno-sw](https://github.com/barryvdh/laravel-ide-helper/pull/1577)
|
- Add support for AsCollection::using and AsEnumCollection::of casts [#1577 / uno-sw](https://github.com/barryvdh/laravel-ide-helper/pull/1577)
|
||||||
|
|
||||||
2024-07-12, 3.1.0
|
|
||||||
------------------
|
## 3.1.0 - 2024-07-12
|
||||||
|
|
||||||
### Fixed
|
### Fixed
|
||||||
|
|
||||||
- Fix return value of query scopes from parent class [#1366 / sforward](https://github.com/barryvdh/laravel-ide-helper/pull/1366)
|
- Fix return value of query scopes from parent class [#1366 / sforward](https://github.com/barryvdh/laravel-ide-helper/pull/1366)
|
||||||
- Add static to isBuiltin() check in ide-helper:models [#1541 / bram-pkg](https://github.com/barryvdh/laravel-ide-helper/pull/1541)
|
- Add static to isBuiltin() check in ide-helper:models [#1541 / bram-pkg](https://github.com/barryvdh/laravel-ide-helper/pull/1541)
|
||||||
- Fix for getSomethingAttribute functions which return a collection with type templating in the phpDoc. [#1567 / stefanScrumble](https://github.com/barryvdh/laravel-ide-helper/pull/1567)
|
- Fix for getSomethingAttribute functions which return a collection with type templating in the phpDoc. [#1567 / stefanScrumble](https://github.com/barryvdh/laravel-ide-helper/pull/1567)
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
- Add type to pivot when using a custom pivot class [#1518 / d3v2a](https://github.com/barryvdh/laravel-ide-helper/pull/1518)
|
|
||||||
- Add support in morphTo relationship for null values [#1547 / matysekmichal](https://github.com/barryvdh/laravel-ide-helper/pull/1547)
|
|
||||||
- Add support for AsEnumCollection casts [#1557 / Braunson](https://github.com/barryvdh/laravel-ide-helper/pull/1557)
|
|
||||||
- Support for Attribute class in attributes [#1567 / stefanScrumble](https://github.com/barryvdh/laravel-ide-helper/pull/1567)
|
|
||||||
|
|
||||||
2024-03-01, 3.0.0
|
- Add type to pivot when using a custom pivot class [#1518 / d3v2a](https://github.com/barryvdh/laravel-ide-helper/pull/1518)
|
||||||
------------------
|
- Add support in morphTo relationship for null values [#1547 / matysekmichal](https://github.com/barryvdh/laravel-ide-helper/pull/1547)
|
||||||
|
- Add support for AsEnumCollection casts [#1557 / Braunson](https://github.com/barryvdh/laravel-ide-helper/pull/1557)
|
||||||
|
- Support for Attribute class in attributes [#1567 / stefanScrumble](https://github.com/barryvdh/laravel-ide-helper/pull/1567)
|
||||||
|
|
||||||
|
## 3.0.0 - 2024-03-01
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|
||||||
- Support for Laravel 11 [#1520 / KentarouTakeda](https://github.com/barryvdh/laravel-ide-helper/pull/1520)
|
- Support for Laravel 11 [#1520 / KentarouTakeda](https://github.com/barryvdh/laravel-ide-helper/pull/1520)
|
||||||
|
|
||||||
### Changed
|
### Changed
|
||||||
|
|
||||||
- Make `--reset` always keep the text and remove `--smart-reset`. Always skip the classname [#1523 / barryvdh](https://github.com/barryvdh/laravel-ide-helper/pull/1523) & [#1525 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/1525)
|
- Make `--reset` always keep the text and remove `--smart-reset`. Always skip the classname [#1523 / barryvdh](https://github.com/barryvdh/laravel-ide-helper/pull/1523) & [#1525 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/1525)
|
||||||
- Use short types (`int` and `bool` instead of `integer` and `boolean`) [#1524 / barryvdh](https://github.com/barryvdh/laravel-ide-helper/pull/1524)
|
- Use short types (`int` and `bool` instead of `integer` and `boolean`) [#1524 / barryvdh](https://github.com/barryvdh/laravel-ide-helper/pull/1524)
|
||||||
|
|
||||||
### Removed
|
### Removed
|
||||||
|
|
||||||
- Support for Laravel 9 and use of doctrine/dbal [#1512 / barryvdh](https://github.com/barryvdh/laravel-ide-helper/pull/1512)
|
- Support for Laravel 9 and use of doctrine/dbal [#1512 / barryvdh](https://github.com/barryvdh/laravel-ide-helper/pull/1512)
|
||||||
With this functionality gone, a few changes have been made:
|
With this functionality gone, a few changes have been made:
|
||||||
- support for custom datatypes has been dropped (config `custom_db_types`) unknown data types default to `string` now and to fix the type, add a proper cast in Eloquent
|
- support for custom datatypes has been dropped (config `custom_db_types`) unknown data types default to `string` now and to fix the type, add a proper cast in Eloquent
|
||||||
- You _might_ have top-level dependency on doctrine/dbal. This may have been in the past due to ide-helper, we suggest to check if you still need it and remove it otherwise
|
- You *might* have top-level dependency on doctrine/dbal. This may have been in the past due to ide-helper, we suggest to check if you still need it and remove it otherwise
|
||||||
- Minimum PHP version, due to Laravel 10, is now PHP 8.1
|
- Minimum PHP version, due to Laravel 10, is now PHP 8.1
|
||||||
|
|
||||||
2024-02-15, 2.15.1
|
|
||||||
------------------
|
## 2024-02-15, 2.15.1
|
||||||
|
|
||||||
### Fixed
|
### Fixed
|
||||||
|
|
||||||
- Fix final class keyword in wrong position [#1517 / barryvdh](https://github.com/barryvdh/laravel-ide-helper/pull/1517)
|
- Fix final class keyword in wrong position [#1517 / barryvdh](https://github.com/barryvdh/laravel-ide-helper/pull/1517)
|
||||||
|
|
||||||
### Changed
|
### Changed
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|
||||||
2024-02-14, 2.15.0
|
## 2024-02-14, 2.15.0
|
||||||
------------------
|
|
||||||
### Fixed
|
### Fixed
|
||||||
|
|
||||||
- Fix case issue in `ModelsCommand::unsetMethod()` [#1453 / leo108](https://github.com/barryvdh/laravel-ide-helper/pull/1453)
|
- 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)
|
- 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)
|
- Skip swoole, otherwise fatal error [#1477 / TimoFrenzel](https://github.com/barryvdh/laravel-ide-helper/pull/1477)
|
||||||
@@ -78,10 +124,12 @@ All notable changes to this project will be documented in this file.
|
|||||||
- Fix #1300 relation_return_type must take precedence if it is defined [#1394 / menthol](https://github.com/barryvdh/laravel-ide-helper/pull/1394)
|
- Fix #1300 relation_return_type must take precedence if it is defined [#1394 / menthol](https://github.com/barryvdh/laravel-ide-helper/pull/1394)
|
||||||
|
|
||||||
### Changed
|
### Changed
|
||||||
|
|
||||||
- Disable inspections of helper files [#1486 / eidng8](https://github.com/barryvdh/laravel-ide-helper/pull/1486)
|
- 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)
|
- Removed support for Laravel 8 and therefore for PHP < 8.0 [#1504 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/1504)
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|
||||||
- Add support for enum default arguments using enum cases. [#1464 / d8vjork](https://github.com/barryvdh/laravel-ide-helper/pull/1464)
|
- 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 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 relations with composite keys. [#1479 / calebdw](https://github.com/barryvdh/laravel-ide-helper/pull/1479)
|
||||||
@@ -91,25 +139,27 @@ All notable changes to this project will be documented in this file.
|
|||||||
- Support the BINARY(...) database field type [#1434 / Sfonxs](https://github.com/barryvdh/laravel-ide-helper/pull/1434)
|
- 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)
|
- 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
|
## 2024-02-05, 2.14.0
|
||||||
------------------
|
|
||||||
|
|
||||||
### Changed
|
### Changed
|
||||||
|
|
||||||
- Official support for Lumen has been dropped [#1425 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/1425)
|
- 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)
|
- Refactor resolving of null information for custom casted attribute types [#1330 / wimski](https://github.com/barryvdh/laravel-ide-helper/pull/1330)
|
||||||
|
|
||||||
### Fixed
|
### Fixed
|
||||||
|
|
||||||
- Catch exceptions when loading aliases [#1465 / dongm2ez](https://github.com/barryvdh/laravel-ide-helper/pull/1465)
|
- Catch exceptions when loading aliases [#1465 / dongm2ez](https://github.com/barryvdh/laravel-ide-helper/pull/1465)
|
||||||
|
|
||||||
### Added
|
### 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 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 `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)
|
- 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
|
## 2023-02-04, 2.13.0
|
||||||
------------------
|
|
||||||
|
|
||||||
### Fixed
|
### Fixed
|
||||||
|
|
||||||
- Fix return type of methods provided by `SoftDeletes` [#1345 / KentarouTakeda](https://github.com/barryvdh/laravel-ide-helper/pull/1345)
|
- 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)
|
- 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 issue where \Eloquent is not included when using write_mixin [#1352 / Jefemy](https://github.com/barryvdh/laravel-ide-helper/pull/1352)
|
||||||
@@ -118,176 +168,208 @@ All notable changes to this project will be documented in this file.
|
|||||||
- Fix Castable class if failed to detect it from return types [#1388 / kwarcu](https://github.com/barryvdh/laravel-ide-helper/pull/1388)
|
- Fix Castable class if failed to detect it from return types [#1388 / kwarcu](https://github.com/barryvdh/laravel-ide-helper/pull/1388)
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|
||||||
- Added Laravel 10 support [#1407 / lptn](https://github.com/barryvdh/laravel-ide-helper/pull/1407)
|
- 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 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)
|
- 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
|
## 2022-03-06, 2.12.3
|
||||||
------------------
|
|
||||||
|
|
||||||
### Fixed
|
### 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 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)
|
- 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
|
## 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
|
### Fixed
|
||||||
|
|
||||||
|
- Remove composer dependency, 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)
|
- Properly handle `Castable`s without return type. [#1306 / binotaliu](https://github.com/barryvdh/laravel-ide-helper/pull/1306)
|
||||||
|
|
||||||
2022-01-23, 2.12.0
|
## 2022-01-23, 2.12.0
|
||||||
------------------
|
|
||||||
### Added
|
### Added
|
||||||
|
|
||||||
- Add support for custom casts that using `Castable` [#1287 / binotaliu](https://github.com/barryvdh/laravel-ide-helper/pull/1287)
|
- 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 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
|
- Added option `additional_relation_return_types` for custom relations that don't fit the typical naming scheme
|
||||||
|
|
||||||
2022-01-03, 2.11.0
|
## 2022-01-03, 2.11.0
|
||||||
------------------
|
|
||||||
### Added
|
### Added
|
||||||
- Add support for Laravel 8.77 Attributes [\#1289 / SimonJnsson](https://github.com/barryvdh/laravel-ide-helper/pull/1289)
|
|
||||||
|
- 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 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 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)
|
- Add support of custom casts without properties [#1267 / sparclex](https://github.com/barryvdh/laravel-ide-helper/pull/1267)
|
||||||
|
|
||||||
### Fixed
|
### 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)
|
- 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
|
### 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
|
- 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
|
||||||
- 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)
|
|
||||||
|
- 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
|
### 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
|
- 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
|
### Added
|
||||||
- Allowing Methods to be set or unset in ModelHooks [\#1198 / jenga201](https://github.com/barryvdh/laravel-ide-helper/pull/1198)\
|
|
||||||
|
- 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**!
|
Note: the visibility of `\Barryvdh\LaravelIdeHelper\Console\ModelsCommand::setMethod` has been changed to **public**!
|
||||||
|
|
||||||
### Fixed
|
### Fixed
|
||||||
- Fixing issue where incorrect autoloader unregistered [\#1210 / tezhm](https://github.com/barryvdh/laravel-ide-helper/pull/1210)
|
|
||||||
|
|
||||||
2021-04-02, 2.9.3
|
- Fixing issue where incorrect autoloader unregistered [#1210 / tezhm](https://github.com/barryvdh/laravel-ide-helper/pull/1210)
|
||||||
-----------------
|
|
||||||
|
## 2021-04-02, 2.9.3
|
||||||
|
|
||||||
### Fixed
|
### 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
|
- 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
|
### 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)
|
|
||||||
|
- 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
|
### 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
|
- 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
|
### 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)
|
- Generate PHPDoc for Laravel 8.x factories [#1074 / ahmed-aliraqi](https://github.com/barryvdh/laravel-ide-helper/pull/1074)
|
||||||
- Added `post_migrate` hook to run commands after a migration [\#1163 / netpok](https://github.com/barryvdh/laravel-ide-helper/pull/1163)
|
- Add a comment to a property like table columns [#1168 / biiiiiigmonster](https://github.com/barryvdh/laravel-ide-helper/pull/1168)
|
||||||
- Allow for PhpDoc for macros with union types [\#1148 / riesjart](https://github.com/barryvdh/laravel-ide-helper/pull/1148)
|
- 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
|
### 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
|
- 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)
|
||||||
### Changed
|
- Relative class names are not converted to fully-qualified class names [#1005 / SavKS](https://github.com/barryvdh/laravel-ide-helper/pull/1005)
|
||||||
- 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
|
## 2020-12-30, 2.9.0
|
||||||
- `Macro::initPhpDoc()` will save original docblock if present [\#1116 / LastDragon-ru](https://github.com/barryvdh/laravel-ide-helper/pull/1116)
|
|
||||||
- `Alias` will grab macros from `\Illuminate\Database\Eloquent\Builder` too [\#1118 / LastDragon-ru](https://github.com/barryvdh/laravel-ide-helper/pull/1118)
|
|
||||||
|
|
||||||
2020-12-08, 2.8.2
|
|
||||||
-----------------
|
|
||||||
### Added
|
|
||||||
- Fix phpdoc generate for custom cast with parameter [\#986 / artelkr](https://github.com/barryvdh/laravel-ide-helper/pull/986)
|
|
||||||
- Created a possibility to add custom relation type [\#987 / efinder2](https://github.com/barryvdh/laravel-ide-helper/pull/987)
|
|
||||||
- Added `@see` with macro/mixin definition location to PhpDoc [\#1054 / riesjart](https://github.com/barryvdh/laravel-ide-helper/pull/1054)
|
|
||||||
- Initial compatibility for PHP8 [\#1106 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/1106)
|
|
||||||
|
|
||||||
### Changed
|
### Changed
|
||||||
- Implement DeferrableProvider [\#914 / kon-shou](https://github.com/barryvdh/laravel-ide-helper/pull/914)
|
|
||||||
|
- 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
|
### Fixed
|
||||||
- Compatibility with Lumen [\#1043 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/1043)
|
|
||||||
- Allow model_locations to have glob patterns [\#1059 / saackearl](https://github.com/barryvdh/laravel-ide-helper/pull/1059)
|
- `Macro::initPhpDoc()` will save original docblock if present [#1116 / LastDragon-ru](https://github.com/barryvdh/laravel-ide-helper/pull/1116)
|
||||||
- Error when generating helper for macroable classes which are not facades and contain a "fake" method [\#1066 / domkrm] (https://github.com/barryvdh/laravel-ide-helper/pull/1066)
|
- `Alias` will grab macros from `\Illuminate\Database\Eloquent\Builder` too [#1118 / LastDragon-ru](https://github.com/barryvdh/laravel-ide-helper/pull/1118)
|
||||||
- Casts with a return type of `static` or `$this` now resolve to an instance of the cast [\#1103 / riesjart](https://github.com/barryvdh/laravel-ide-helper/pull/1103)
|
|
||||||
|
## 2020-12-08, 2.8.2
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- Fix phpdoc generate for custom cast with parameter [#986 / artelkr](https://github.com/barryvdh/laravel-ide-helper/pull/986)
|
||||||
|
- Created a possibility to add custom relation type [#987 / efinder2](https://github.com/barryvdh/laravel-ide-helper/pull/987)
|
||||||
|
- Added `@see` with macro/mixin definition location to PhpDoc [#1054 / riesjart](https://github.com/barryvdh/laravel-ide-helper/pull/1054)
|
||||||
|
- Initial compatibility for PHP8 [#1106 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/1106)
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
|
||||||
|
- Implement DeferrableProvider [#914 / kon-shou](https://github.com/barryvdh/laravel-ide-helper/pull/914)
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
|
||||||
|
- Compatibility with Lumen [#1043 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/1043)
|
||||||
|
- Allow model_locations to have glob patterns [#1059 / saackearl](https://github.com/barryvdh/laravel-ide-helper/pull/1059)
|
||||||
|
- Error when generating helper for macroable classes which are not facades and contain a "fake" method [#1066 / domkrm] (https://github.com/barryvdh/laravel-ide-helper/pull/1066)
|
||||||
|
- Casts with a return type of `static` or `$this` now resolve to an instance of the cast [#1103 / riesjart](https://github.com/barryvdh/laravel-ide-helper/pull/1103)
|
||||||
|
|
||||||
### Removed
|
### Removed
|
||||||
- Removed format and broken generateJsonHelper [\#1053 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/1053)
|
|
||||||
|
|
||||||
2020-09-07, 2.8.1
|
- Removed format and broken generateJsonHelper [#1053 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/1053)
|
||||||
-----------------
|
|
||||||
### Added
|
## 2020-09-07, 2.8.1
|
||||||
- Support Laravel 8 [\#1022 / barryvdh](https://github.com/barryvdh/laravel-ide-helper/pull/1022)
|
|
||||||
- Add option to force usage of FQN [\#1031 / edvordo](https://github.com/barryvdh/laravel-ide-helper/pull/1031)
|
|
||||||
- Add support for macros of all macroable classes [\#1006 / domkrm](https://github.com/barryvdh/laravel-ide-helper/pull/1006)
|
|
||||||
|
|
||||||
2020-08-11, 2.8.0
|
|
||||||
-----------------
|
|
||||||
### Added
|
### Added
|
||||||
- Add static return type to builder methods [\#924 / dmason30](https://github.com/barryvdh/laravel-ide-helper/pull/924)
|
|
||||||
- Add `optonal` to meta generator for PhpStorm [\#932 / halaei](https://github.com/barryvdh/laravel-ide-helper/pull/932)
|
- Support Laravel 8 [#1022 / barryvdh](https://github.com/barryvdh/laravel-ide-helper/pull/1022)
|
||||||
- Decimal columns as string in Models [\#948 / fgibaux](https://github.com/barryvdh/laravel-ide-helper/pull/948)
|
- Add option to force usage of FQN [#1031 / edvordo](https://github.com/barryvdh/laravel-ide-helper/pull/1031)
|
||||||
- Simplify full namespaces for already included resources [\#954 / LANGERGabriel](https://github.com/barryvdh/laravel-ide-helper/pull/954)
|
- Add support for macros of all macroable classes [#1006 / domkrm](https://github.com/barryvdh/laravel-ide-helper/pull/1006)
|
||||||
- Make writing relation count properties optional [\#969 / AegirLeet](https://github.com/barryvdh/laravel-ide-helper/pull/969)
|
|
||||||
- Add more methods able to resolve container instances [\#996 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/996)
|
## 2020-08-11, 2.8.0
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- Add static return type to builder methods [#924 / dmason30](https://github.com/barryvdh/laravel-ide-helper/pull/924)
|
||||||
|
- Add `optional` to meta generator for PhpStorm [#932 / halaei](https://github.com/barryvdh/laravel-ide-helper/pull/932)
|
||||||
|
- Decimal columns as string in Models [#948 / fgibaux](https://github.com/barryvdh/laravel-ide-helper/pull/948)
|
||||||
|
- Simplify full namespaces for already included resources [#954 / LANGERGabriel](https://github.com/barryvdh/laravel-ide-helper/pull/954)
|
||||||
|
- Make writing relation count properties optional [#969 / AegirLeet](https://github.com/barryvdh/laravel-ide-helper/pull/969)
|
||||||
|
- Add more methods able to resolve container instances [#996 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/996)
|
||||||
|
|
||||||
### Fixed
|
### Fixed
|
||||||
- Test `auth` is bound before detect Auth driver [\#946 / zhwei](https://github.com/barryvdh/laravel-ide-helper/pull/946)
|
|
||||||
- Fix inline doc-block for final models [\#944 / Gummibeer](https://github.com/barryvdh/laravel-ide-helper/pull/955)
|
|
||||||
|
|
||||||
2020-04-22, 2.7.0
|
- Test `auth` is bound before detect Auth driver [#946 / zhwei](https://github.com/barryvdh/laravel-ide-helper/pull/946)
|
||||||
-----------------
|
- Fix inline doc-block for final models [#944 / Gummibeer](https://github.com/barryvdh/laravel-ide-helper/pull/955)
|
||||||
|
|
||||||
|
## 2020-04-22, 2.7.0
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
- Add `ignored_models` as config option [\#890 / pataar](https://github.com/barryvdh/laravel-ide-helper/pull/890)
|
|
||||||
- Infer return type from reflection if no phpdoc given [\#906 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/906)
|
- Add `ignored_models` as config option [#890 / pataar](https://github.com/barryvdh/laravel-ide-helper/pull/890)
|
||||||
- Add custom collection support for get and all methods [\#903 / dmason30](https://github.com/barryvdh/laravel-ide-helper/pull/903)
|
- Infer return type from reflection if no phpdoc given [#906 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/906)
|
||||||
- if a model implements interfaces, include them in the stub [\#920 / mr-feek](https://github.com/barryvdh/laravel-ide-helper/pull/920)
|
- Add custom collection support for get and all methods [#903 / dmason30](https://github.com/barryvdh/laravel-ide-helper/pull/903)
|
||||||
- Generate noinspections PHPStorm tags [\#905 / mzglinski](https://github.com/barryvdh/laravel-ide-helper/pull/905)
|
- if a model implements interfaces, include them in the stub [#920 / mr-feek](https://github.com/barryvdh/laravel-ide-helper/pull/920)
|
||||||
- Added support for Laravel 7 custom casts [\#913 / belamov](https://github.com/barryvdh/laravel-ide-helper/pull/913)
|
- Generate noinspections PHPStorm tags [#905 / mzglinski](https://github.com/barryvdh/laravel-ide-helper/pull/905)
|
||||||
- Ability to use patterns for model_locations [\#921 / 4n70w4](https://github.com/barryvdh/laravel-ide-helper/pull/921)
|
- Added support for Laravel 7 custom casts [#913 / belamov](https://github.com/barryvdh/laravel-ide-helper/pull/913)
|
||||||
|
- Ability to use patterns for model_locations [#921 / 4n70w4](https://github.com/barryvdh/laravel-ide-helper/pull/921)
|
||||||
|
|
||||||
### Fixed
|
### Fixed
|
||||||
- MorphToMany relations with query not working [\#894 / UksusoFF](https://github.com/barryvdh/laravel-ide-helper/pull/894)
|
|
||||||
- Fix camelCase duplicated properties generator [\#881 / bop10](https://github.com/barryvdh/laravel-ide-helper/pull/881)
|
|
||||||
- Prevent generation of invalid code for certain parameter default values [\#901 / loilo](https://github.com/barryvdh/laravel-ide-helper/pull/901)
|
|
||||||
- Make hasOne and morphOne nullable [\#864 / leo108](https://github.com/barryvdh/laravel-ide-helper/pull/864)
|
|
||||||
- Remove unnecessary and wrong definition of SoftDelete methods [\#918 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/918)
|
|
||||||
- Unregister meta command custom autoloader when it is no longer needed [\#919 / mr-feek](https://github.com/barryvdh/laravel-ide-helper/pull/919)
|
|
||||||
|
|
||||||
2020-02-25, 2.6.7
|
- MorphToMany relations with query not working [#894 / UksusoFF](https://github.com/barryvdh/laravel-ide-helper/pull/894)
|
||||||
-----------------
|
- Fix camelCase duplicated properties generator [#881 / bop10](https://github.com/barryvdh/laravel-ide-helper/pull/881)
|
||||||
|
- Prevent generation of invalid code for certain parameter default values [#901 / loilo](https://github.com/barryvdh/laravel-ide-helper/pull/901)
|
||||||
|
- Make hasOne and morphOne nullable [#864 / leo108](https://github.com/barryvdh/laravel-ide-helper/pull/864)
|
||||||
|
- Remove unnecessary and wrong definition of SoftDelete methods [#918 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/918)
|
||||||
|
- Unregister meta command custom autoloader when it is no longer needed [#919 / mr-feek](https://github.com/barryvdh/laravel-ide-helper/pull/919)
|
||||||
|
|
||||||
|
## 2020-02-25, 2.6.7
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|
||||||
- Support for Laravel 7 [commit by barryvdh](https://github.com/barryvdh/laravel-ide-helper/commit/edd69c5e0508972c81f1f7173236de2459c45814)
|
- Support for Laravel 7 [commit by barryvdh](https://github.com/barryvdh/laravel-ide-helper/commit/edd69c5e0508972c81f1f7173236de2459c45814)
|
||||||
|
|
||||||
2019-12-02, 2.6.6
|
## 2019-12-02, 2.6.6
|
||||||
-----------------
|
|
||||||
### Added
|
### Added
|
||||||
- Add splat operator (...) support [\#860 / ngmy](https://github.com/barryvdh/laravel-ide-helper/pull/860)
|
|
||||||
- Add support for custom date class via Date::use() [\#859 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/859)
|
- Add splat operator (...) support [#860 / ngmy](https://github.com/barryvdh/laravel-ide-helper/pull/860)
|
||||||
|
- Add support for custom date class via Date::use() [#859 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/859)
|
||||||
|
|
||||||
### Fixed
|
### Fixed
|
||||||
- Prevent undefined property errors [\#877 / matt-allan](https://github.com/barryvdh/laravel-ide-helper/pull/877)
|
|
||||||
|
|
||||||
----
|
- Prevent undefined property errors [#877 / matt-allan](https://github.com/barryvdh/laravel-ide-helper/pull/877)
|
||||||
|
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
Missing an older changelog? Feel free to submit a PR!
|
Missing an older changelog? Feel free to submit a PR!
|
||||||
|
|||||||
@@ -33,42 +33,27 @@ 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.
|
|
||||||
|
|
||||||
If for some reason you want manually control this:
|
|
||||||
- add the package to the `extra.laravel.dont-discover` key in `composer.json`, e.g.
|
|
||||||
```json
|
|
||||||
"extra": {
|
|
||||||
"laravel": {
|
|
||||||
"dont-discover": [
|
|
||||||
"barryvdh/laravel-ide-helper"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
- Add the following class to the `providers` array in `config/app.php`:
|
|
||||||
```php
|
|
||||||
Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider::class,
|
|
||||||
```
|
|
||||||
If you want to manually load it only in non-production environments, instead you can add this to your `AppServiceProvider` with the `register()` method:
|
|
||||||
```php
|
|
||||||
public function register()
|
|
||||||
{
|
|
||||||
if ($this->app->isLocal()) {
|
|
||||||
$this->app->register(\Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider::class);
|
|
||||||
}
|
|
||||||
// ...
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
> Note: Avoid caching the configuration in your development environment, it may cause issues after installing this package; respectively clear the cache beforehand via `php artisan cache:clear` if you encounter problems when running the commands
|
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
|
### TL;DR
|
||||||
|
|
||||||
|
Run this to generate autocompletion for Facades. This creates _ide_helper.php
|
||||||
|
|
||||||
|
```
|
||||||
|
php artisan ide-helper:generate
|
||||||
|
```
|
||||||
|
|
||||||
|
Run this to add phpdocs for your models. Add -RW to Reset existing phpdocs and Write to the models directly.
|
||||||
|
```
|
||||||
|
php artisan ide-helper:models -RW
|
||||||
|
```
|
||||||
|
|
||||||
|
If you don't want the full _ide_helper.php file, you can run add `--write-eloquent-helper` to the model command to generate small version, which is required for the `@mixin \Eloquent` to be able to add the QueryBuilder methods.
|
||||||
|
|
||||||
|
If you don't want to add all the phpdocs to your Models directly, you can use `--nowrite` to create a seperate file. The `--write-mixin` option can be used to only add a `@mixin` to your models, but add the generated phpdocs in a seperate file. This avoids having the results marked as duplicate.
|
||||||
|
|
||||||
|
|
||||||
_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)
|
||||||
@@ -76,7 +61,7 @@ _Check out [this Laracasts video](https://laracasts.com/series/how-to-be-awesome
|
|||||||
- `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
|
||||||
|
|
||||||
### Automatic PHPDoc generation for Laravel Facades
|
### Automatic PHPDoc generation for Laravel Facades
|
||||||
|
|
||||||
@@ -86,8 +71,6 @@ You can now re-generate the docs yourself (for future updates)
|
|||||||
php artisan ide-helper:generate
|
php artisan ide-helper:generate
|
||||||
```
|
```
|
||||||
|
|
||||||
Note: `bootstrap/compiled.php` has to be cleared first, so run `php artisan clear-compiled` before generating.
|
|
||||||
|
|
||||||
This will generate the file `_ide_helper.php` which is expected to be additionally parsed by your IDE for autocomplete. You can use the config `filename` to change its name.
|
This will generate the file `_ide_helper.php` which is expected to be additionally parsed by your IDE for autocomplete. You can use the config `filename` to change its name.
|
||||||
|
|
||||||
You can configure your `composer.json` to do this each time you update your dependencies:
|
You can configure your `composer.json` to do this each time you update your dependencies:
|
||||||
@@ -115,7 +98,7 @@ 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.
|
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.
|
> **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.
|
||||||
@@ -149,6 +132,8 @@ 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.
|
||||||
|
|
||||||
|
> You need the _ide_helper.php file to add the QueryBuilder methods. You can add --write-eloquent-helper/-E to generate a minimal version. If this file does not exist, you will be prompted for it.
|
||||||
|
|
||||||
Writing to the models should keep the existing comments and only append new properties/methods. It will not update changed properties/methods.
|
Writing to the models should keep the existing comments and only append new properties/methods. It will not update changed properties/methods.
|
||||||
|
|
||||||
With the `--reset (-R)` option, the whole existing PHPDoc is replaced, including any comments that have been made.
|
With the `--reset (-R)` option, the whole existing PHPDoc is replaced, including any comments that have been made.
|
||||||
@@ -382,7 +367,7 @@ app(App\SomeClass::class);
|
|||||||
```
|
```
|
||||||
|
|
||||||
> Note: You might need to restart PhpStorm and make sure `.phpstorm.meta.php` is indexed.
|
> Note: You might need to restart PhpStorm and make sure `.phpstorm.meta.php` is indexed.
|
||||||
>
|
|
||||||
> Note: When you receive a FatalException: class not found, check your config
|
> 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).
|
||||||
|
|
||||||
|
|||||||
+2
-2
@@ -22,7 +22,7 @@
|
|||||||
"require": {
|
"require": {
|
||||||
"php": "^8.2",
|
"php": "^8.2",
|
||||||
"ext-json": "*",
|
"ext-json": "*",
|
||||||
"barryvdh/reflection-docblock": "^2.1.2",
|
"barryvdh/reflection-docblock": "^2.2",
|
||||||
"composer/class-map-generator": "^1.0",
|
"composer/class-map-generator": "^1.0",
|
||||||
"illuminate/console": "^11.15",
|
"illuminate/console": "^11.15",
|
||||||
"illuminate/database": "^11.15",
|
"illuminate/database": "^11.15",
|
||||||
@@ -65,7 +65,7 @@
|
|||||||
},
|
},
|
||||||
"extra": {
|
"extra": {
|
||||||
"branch-alias": {
|
"branch-alias": {
|
||||||
"dev-master": "3.2-dev"
|
"dev-master": "3.4-dev"
|
||||||
},
|
},
|
||||||
"laravel": {
|
"laravel": {
|
||||||
"providers": [
|
"providers": [
|
||||||
|
|||||||
@@ -299,6 +299,29 @@ return [
|
|||||||
*/
|
*/
|
||||||
'additional_relation_return_types' => [],
|
'additional_relation_return_types' => [],
|
||||||
|
|
||||||
|
/*
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
| Enforce nullable Eloquent relationships on not null columns
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
|
|
||||||
|
| When set to true (default), this option enforces nullable Eloquent relationships.
|
||||||
|
| However, in cases where the application logic ensures the presence of related
|
||||||
|
| records it may be desirable to set this option to false to avoid unwanted null warnings.
|
||||||
|
|
|
||||||
|
| Default: true
|
||||||
|
| A not null column with no foreign key constraint will have a "nullable" relationship.
|
||||||
|
| * @property int $not_null_column_with_no_foreign_key_constraint
|
||||||
|
| * @property-read BelongsToVariation|null $notNullColumnWithNoForeignKeyConstraint
|
||||||
|
|
|
||||||
|
| Option: false
|
||||||
|
| A not null column with no foreign key constraint will have a "not nullable" relationship.
|
||||||
|
| * @property int $not_null_column_with_no_foreign_key_constraint
|
||||||
|
| * @property-read BelongsToVariation $notNullColumnWithNoForeignKeyConstraint
|
||||||
|
|
|
||||||
|
*/
|
||||||
|
|
||||||
|
'enforce_nullable_relationships' => true,
|
||||||
|
|
||||||
/*
|
/*
|
||||||
|--------------------------------------------------------------------------
|
|--------------------------------------------------------------------------
|
||||||
| Run artisan commands after migrations to generate model helpers
|
| Run artisan commands after migrations to generate model helpers
|
||||||
|
|||||||
+39
-32
@@ -1,8 +1,8 @@
|
|||||||
<?= '<?php' ?>
|
<?= '<?php' ?>
|
||||||
<?php
|
<?php
|
||||||
/**
|
/**
|
||||||
* @var \Barryvdh\LaravelIdeHelper\Alias[][] $namespaces_by_alias_ns
|
* @var Barryvdh\LaravelIdeHelper\Alias[][] $namespaces_by_alias_ns
|
||||||
* @var \Barryvdh\LaravelIdeHelper\Alias[][] $namespaces_by_extends_ns
|
* @var Barryvdh\LaravelIdeHelper\Alias[][] $namespaces_by_extends_ns
|
||||||
* @var bool $include_fluent
|
* @var bool $include_fluent
|
||||||
* @var string $helpers
|
* @var string $helpers
|
||||||
*/
|
*/
|
||||||
@@ -14,31 +14,34 @@
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* A helper file for Laravel, to provide autocomplete information to your IDE
|
* A helper file for Laravel, to provide autocomplete information to your IDE
|
||||||
* Generated for Laravel <?= $version ?>.
|
* Generated for Laravel <?= app()->version() ?>.
|
||||||
*
|
*
|
||||||
* This file should not be included in your code, only analyzed by your IDE!
|
* This file should not be included in your code, only analyzed by your IDE!
|
||||||
*
|
*
|
||||||
* @author Barry vd. Heuvel <[email protected]>
|
* @author Barry vd. Heuvel <[email protected]>
|
||||||
* @see https://github.com/barryvdh/laravel-ide-helper
|
* @see https://github.com/barryvdh/laravel-ide-helper
|
||||||
*/
|
*/
|
||||||
|
<?php
|
||||||
|
$s1 = ' ';
|
||||||
|
$s2 = $s1 . $s1;
|
||||||
|
$s3 = $s1 . $s2;
|
||||||
|
?>
|
||||||
<?php foreach ($namespaces_by_extends_ns as $namespace => $aliases) : ?>
|
<?php foreach ($namespaces_by_extends_ns as $namespace => $aliases) : ?>
|
||||||
namespace <?= $namespace == '__root' ? '' : trim($namespace, '\\') ?> {
|
namespace <?= $namespace === '__root' ? '' : trim($namespace, '\\') ?> {
|
||||||
<?php foreach ($aliases as $alias) : ?>
|
<?php foreach ($aliases as $alias) : ?>
|
||||||
<?= trim($alias->getDocComment(' ')) ?>
|
<?php echo trim($alias->getDocComment($s1)) . "\n{$s1}" . $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($s2)) . "\n{$s2}" ?>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() ?>
|
<?= "\n" . $s3?>//Method inherited from <?= $method->getDeclaringClass() ?>
|
||||||
<?php endif; ?>
|
<?php endif; ?>
|
||||||
|
|
||||||
<?php if ($method->isInstanceCall()) : ?>
|
<?php if ($method->isInstanceCall()) : ?>
|
||||||
/** @var <?=$method->getRoot()?> $instance */
|
<?= $s3 ?>/** @var <?=$method->getRoot()?> $instance */
|
||||||
<?php endif?>
|
<?php endif?>
|
||||||
<?= $method->shouldReturn() ? 'return ' : '' ?><?= $method->getRootMethodCall() ?>;
|
<?= $s3 . ($method->shouldReturn() ? 'return ' : '') ?><?= $method->getRootMethodCall() ?>;
|
||||||
}
|
}
|
||||||
|
|
||||||
<?php endforeach; ?>
|
<?php endforeach; ?>
|
||||||
}
|
}
|
||||||
<?php endforeach; ?>
|
<?php endforeach; ?>
|
||||||
@@ -47,24 +50,28 @@ namespace <?= $namespace == '__root' ? '' : trim($namespace, '\\') ?> {
|
|||||||
<?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') : ?>
|
<?php if ($alias->getExtendsNamespace() === '\Illuminate\Database\Eloquent') : ?>
|
||||||
<?php foreach ($alias->getMethods() as $method) : ?>
|
<?= "\n" . $alias->getPhpDocTemplates($s1) . "\n" ?>
|
||||||
<?= trim($method->getDocComment(' ')) ?>
|
<?php endif?>
|
||||||
public static function <?= $method->getName() ?>(<?= $method->getParamsWithDefault() ?>)
|
<?= $s1 . $alias->getClassType() ?> <?= $alias->getShortName() ?> extends <?= $alias->getExtends() ?> {<?php if ($alias->getExtendsNamespace() === '\Illuminate\Database\Eloquent') : ?>
|
||||||
{<?php if ($method->getDeclaringClass() !== $method->getRoot()) : ?>
|
<?php foreach ($alias->getMethods() as $method) : ?>
|
||||||
//Method inherited from <?= $method->getDeclaringClass() ?>
|
<?= $s2 . trim($method->getDocComment($s2)) . "\n" ?>
|
||||||
<?php endif; ?>
|
<?= $s2 ?>public static function <?= $method->getName() ?>(<?= $method->getParamsWithDefault() ?>)
|
||||||
|
<?= $s2?>{<?php if ($method->getDeclaringClass() !== $method->getRoot()) : ?>
|
||||||
|
<?= $s2 ?>//Method inherited from <?= $method->getDeclaringClass() ?>
|
||||||
|
<?php endif; ?>
|
||||||
|
|
||||||
<?php if ($method->isInstanceCall()) : ?>
|
<?php if ($method->isInstanceCall()) : ?>
|
||||||
/** @var <?=$method->getRoot()?> $instance */
|
<?= $s3 ?>/** @var <?=$method->getRoot()?> $instance */
|
||||||
<?php endif?>
|
<?php endif?>
|
||||||
<?= $method->shouldReturn() ? 'return ' : '' ?><?= $method->getRootMethodCall() ?>;
|
<?= $s3 . ($method->shouldReturn() ? 'return ' : '') ?><?= $method->getRootMethodCall() ?>;
|
||||||
}
|
<?= $s2 ?>}
|
||||||
<?php endforeach; ?>
|
|
||||||
<?php endif; ?>}
|
<?php endforeach; ?>
|
||||||
<?php endforeach; ?>
|
<?php endif; ?>}
|
||||||
|
<?php endforeach; ?>
|
||||||
}
|
}
|
||||||
|
|
||||||
<?php endforeach; ?>
|
<?php endforeach; ?>
|
||||||
|
|||||||
+64
-4
@@ -18,6 +18,7 @@ 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\Database\Eloquent\Builder as EloquentBuilder;
|
||||||
|
use Illuminate\Database\Query\Builder as QueryBuilder;
|
||||||
use Illuminate\Support\Facades\Facade;
|
use Illuminate\Support\Facades\Facade;
|
||||||
use ReflectionClass;
|
use ReflectionClass;
|
||||||
use Throwable;
|
use Throwable;
|
||||||
@@ -80,7 +81,12 @@ class Alias
|
|||||||
$this->detectExtendsNamespace();
|
$this->detectExtendsNamespace();
|
||||||
|
|
||||||
if (!empty($this->namespace)) {
|
if (!empty($this->namespace)) {
|
||||||
$this->classAliases = (new UsesResolver())->loadFromClass($this->root);
|
try {
|
||||||
|
$this->classAliases = (new UsesResolver())->loadFromClass($this->root);
|
||||||
|
} catch (Throwable $e) {
|
||||||
|
$this->classAliases = [];
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
//Create a DocBlock and serializer instance
|
//Create a DocBlock and serializer instance
|
||||||
$this->phpdoc = new DocBlock(new ReflectionClass($alias), new Context($this->namespace, $this->classAliases));
|
$this->phpdoc = new DocBlock(new ReflectionClass($alias), new Context($this->namespace, $this->classAliases));
|
||||||
@@ -333,7 +339,15 @@ class Alias
|
|||||||
|
|
||||||
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->classAliases);
|
$this->methods[] = new Method(
|
||||||
|
$method,
|
||||||
|
$this->alias,
|
||||||
|
$class,
|
||||||
|
$magic,
|
||||||
|
$this->interfaces,
|
||||||
|
$this->classAliases,
|
||||||
|
$this->getReturnTypeNormalizers($class)
|
||||||
|
);
|
||||||
}
|
}
|
||||||
$this->usedMethods[] = $magic;
|
$this->usedMethods[] = $magic;
|
||||||
}
|
}
|
||||||
@@ -363,7 +377,8 @@ class Alias
|
|||||||
$reflection,
|
$reflection,
|
||||||
$method->name,
|
$method->name,
|
||||||
$this->interfaces,
|
$this->interfaces,
|
||||||
$this->classAliases
|
$this->classAliases,
|
||||||
|
$this->getReturnTypeNormalizers($reflection)
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
$this->usedMethods[] = $method->name;
|
$this->usedMethods[] = $method->name;
|
||||||
@@ -386,7 +401,8 @@ class Alias
|
|||||||
$reflection,
|
$reflection,
|
||||||
$macro_name,
|
$macro_name,
|
||||||
$this->interfaces,
|
$this->interfaces,
|
||||||
$this->classAliases
|
$this->classAliases,
|
||||||
|
$this->getReturnTypeNormalizers($reflection)
|
||||||
);
|
);
|
||||||
$this->usedMethods[] = $macro_name;
|
$this->usedMethods[] = $macro_name;
|
||||||
}
|
}
|
||||||
@@ -395,6 +411,21 @@ class Alias
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param ReflectionClass $class
|
||||||
|
* @return array<string, string>
|
||||||
|
*/
|
||||||
|
protected function getReturnTypeNormalizers($class)
|
||||||
|
{
|
||||||
|
if ($this->alias === 'Eloquent' && in_array($class->getName(), [EloquentBuilder::class, QueryBuilder::class])) {
|
||||||
|
return [
|
||||||
|
'$this' => '\\' . EloquentBuilder::class . ($this->config->get('ide-helper.use_generics_annotations') ? '<static>' : '|static'),
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param $macro_func
|
* @param $macro_func
|
||||||
*
|
*
|
||||||
@@ -442,6 +473,35 @@ class Alias
|
|||||||
return $serializer->getDocComment($this->phpdoc);
|
return $serializer->getDocComment($this->phpdoc);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param $prefix
|
||||||
|
* @return string
|
||||||
|
* @throws \ReflectionException
|
||||||
|
*/
|
||||||
|
public function getPhpDocTemplates($prefix = "\t\t")
|
||||||
|
{
|
||||||
|
$templateDoc = new DocBlock('');
|
||||||
|
$serializer = new DocBlockSerializer(1, $prefix);
|
||||||
|
|
||||||
|
foreach ($this->classes as $class) {
|
||||||
|
$reflection = new ReflectionClass($class);
|
||||||
|
$traits = collect($reflection->getTraitNames());
|
||||||
|
|
||||||
|
foreach ($traits as $trait) {
|
||||||
|
$phpdoc = new DocBlock(new ReflectionClass($trait));
|
||||||
|
$templates = $phpdoc->getTagsByName('template');
|
||||||
|
|
||||||
|
/** @var DocBlock\Tag\TemplateTag $template */
|
||||||
|
foreach ($templates as $template) {
|
||||||
|
$template->setBound('static');
|
||||||
|
$template->setDocBlock($templateDoc);
|
||||||
|
$templateDoc->appendTag($template);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return $serializer->getDocComment($templateDoc);
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Removes method tags from the doc comment that already appear as functions inside the class.
|
* Removes method tags from the doc comment that already appear as functions inside the class.
|
||||||
* This prevents duplicate function errors in the IDE.
|
* This prevents duplicate function errors in the IDE.
|
||||||
|
|||||||
@@ -14,7 +14,9 @@ namespace Barryvdh\LaravelIdeHelper\Console;
|
|||||||
use Barryvdh\LaravelIdeHelper\Eloquent;
|
use Barryvdh\LaravelIdeHelper\Eloquent;
|
||||||
use Barryvdh\LaravelIdeHelper\Generator;
|
use Barryvdh\LaravelIdeHelper\Generator;
|
||||||
use Illuminate\Console\Command;
|
use Illuminate\Console\Command;
|
||||||
|
use Illuminate\Contracts\Config\Repository;
|
||||||
use Illuminate\Filesystem\Filesystem;
|
use Illuminate\Filesystem\Filesystem;
|
||||||
|
use Illuminate\View\Factory;
|
||||||
use Symfony\Component\Console\Input\InputArgument;
|
use Symfony\Component\Console\Input\InputArgument;
|
||||||
use Symfony\Component\Console\Input\InputOption;
|
use Symfony\Component\Console\Input\InputOption;
|
||||||
|
|
||||||
@@ -45,7 +47,7 @@ class GeneratorCommand extends Command
|
|||||||
/** @var Filesystem */
|
/** @var Filesystem */
|
||||||
protected $files;
|
protected $files;
|
||||||
|
|
||||||
/** @var \Illuminate\View\Factory */
|
/** @var Factory */
|
||||||
protected $view;
|
protected $view;
|
||||||
|
|
||||||
protected $onlyExtend;
|
protected $onlyExtend;
|
||||||
@@ -55,14 +57,12 @@ class GeneratorCommand extends Command
|
|||||||
*
|
*
|
||||||
* @param \Illuminate\Config\Repository $config
|
* @param \Illuminate\Config\Repository $config
|
||||||
* @param Filesystem $files
|
* @param Filesystem $files
|
||||||
* @param \Illuminate\View\Factory $view
|
* @param Factory $view
|
||||||
*/
|
*/
|
||||||
public function __construct(
|
public function __construct(
|
||||||
/*ConfigRepository */
|
Repository $config,
|
||||||
$config,
|
|
||||||
Filesystem $files,
|
Filesystem $files,
|
||||||
/* Illuminate\View\Factory */
|
Factory $view
|
||||||
$view
|
|
||||||
) {
|
) {
|
||||||
$this->config = $config;
|
$this->config = $config;
|
||||||
$this->files = $files;
|
$this->files = $files;
|
||||||
@@ -113,7 +113,12 @@ class GeneratorCommand extends Command
|
|||||||
}
|
}
|
||||||
|
|
||||||
$generator = new Generator($this->config, $this->view, $this->getOutput(), $helpers);
|
$generator = new Generator($this->config, $this->view, $this->getOutput(), $helpers);
|
||||||
$content = $generator->generate();
|
if ($this->option('eloquent')) {
|
||||||
|
$content = $generator->generateEloquent();
|
||||||
|
} else {
|
||||||
|
$content = $generator->generate();
|
||||||
|
}
|
||||||
|
|
||||||
$written = $this->files->put($filename, $content);
|
$written = $this->files->put($filename, $content);
|
||||||
|
|
||||||
if ($written !== false) {
|
if ($written !== false) {
|
||||||
@@ -169,6 +174,7 @@ class GeneratorCommand extends Command
|
|||||||
['write_mixins', 'W', InputOption::VALUE_OPTIONAL, 'Write mixins to Laravel Model?', $writeMixins],
|
['write_mixins', 'W', InputOption::VALUE_OPTIONAL, 'Write mixins to Laravel Model?', $writeMixins],
|
||||||
['helpers', 'H', InputOption::VALUE_NONE, 'Include the helper files'],
|
['helpers', 'H', InputOption::VALUE_NONE, 'Include the helper files'],
|
||||||
['memory', 'M', InputOption::VALUE_NONE, 'Use sqlite memory driver'],
|
['memory', 'M', InputOption::VALUE_NONE, 'Use sqlite memory driver'],
|
||||||
|
['eloquent', 'E', InputOption::VALUE_NONE, 'Only write Eloquent methods'],
|
||||||
];
|
];
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -13,6 +13,9 @@ namespace Barryvdh\LaravelIdeHelper\Console;
|
|||||||
|
|
||||||
use Barryvdh\LaravelIdeHelper\Factories;
|
use Barryvdh\LaravelIdeHelper\Factories;
|
||||||
use Illuminate\Console\Command;
|
use Illuminate\Console\Command;
|
||||||
|
use Illuminate\Contracts\Config\Repository;
|
||||||
|
use Illuminate\Contracts\View\Factory;
|
||||||
|
use Illuminate\Filesystem\Filesystem;
|
||||||
use RuntimeException;
|
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;
|
||||||
@@ -41,10 +44,10 @@ class MetaCommand extends Command
|
|||||||
/** @var \Illuminate\Contracts\Filesystem\Filesystem */
|
/** @var \Illuminate\Contracts\Filesystem\Filesystem */
|
||||||
protected $files;
|
protected $files;
|
||||||
|
|
||||||
/** @var \Illuminate\Contracts\View\Factory */
|
/** @var Factory */
|
||||||
protected $view;
|
protected $view;
|
||||||
|
|
||||||
/** @var \Illuminate\Contracts\Config\Repository */
|
/** @var Repository */
|
||||||
protected $config;
|
protected $config;
|
||||||
|
|
||||||
protected $methods = [
|
protected $methods = [
|
||||||
@@ -63,12 +66,15 @@ class MetaCommand extends Command
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
*
|
*
|
||||||
* @param \Illuminate\Contracts\Filesystem\Filesystem $files
|
* @param Filesystem $files
|
||||||
* @param \Illuminate\Contracts\View\Factory $view
|
* @param Factory $view
|
||||||
* @param \Illuminate\Contracts\Config\Repository $config
|
* @param Repository $config
|
||||||
*/
|
*/
|
||||||
public function __construct($files, $view, $config)
|
public function __construct(
|
||||||
{
|
Filesystem $files,
|
||||||
|
Factory $view,
|
||||||
|
Repository $config
|
||||||
|
) {
|
||||||
$this->files = $files;
|
$this->files = $files;
|
||||||
$this->view = $view;
|
$this->view = $view;
|
||||||
$this->config = $config;
|
$this->config = $config;
|
||||||
|
|||||||
@@ -12,6 +12,7 @@
|
|||||||
namespace Barryvdh\LaravelIdeHelper\Console;
|
namespace Barryvdh\LaravelIdeHelper\Console;
|
||||||
|
|
||||||
use Barryvdh\LaravelIdeHelper\Contracts\ModelHookInterface;
|
use Barryvdh\LaravelIdeHelper\Contracts\ModelHookInterface;
|
||||||
|
use Barryvdh\LaravelIdeHelper\Generator;
|
||||||
use Barryvdh\LaravelIdeHelper\Parsers\PhpDocReturnTypeParser;
|
use Barryvdh\LaravelIdeHelper\Parsers\PhpDocReturnTypeParser;
|
||||||
use Barryvdh\Reflection\DocBlock;
|
use Barryvdh\Reflection\DocBlock;
|
||||||
use Barryvdh\Reflection\DocBlock\Context;
|
use Barryvdh\Reflection\DocBlock\Context;
|
||||||
@@ -19,6 +20,7 @@ use Barryvdh\Reflection\DocBlock\Serializer as DocBlockSerializer;
|
|||||||
use Barryvdh\Reflection\DocBlock\Tag;
|
use Barryvdh\Reflection\DocBlock\Tag;
|
||||||
use Composer\ClassMapGenerator\ClassMapGenerator;
|
use Composer\ClassMapGenerator\ClassMapGenerator;
|
||||||
use Illuminate\Console\Command;
|
use Illuminate\Console\Command;
|
||||||
|
use Illuminate\Contracts\Config\Repository;
|
||||||
use Illuminate\Contracts\Database\Eloquent\Castable;
|
use Illuminate\Contracts\Database\Eloquent\Castable;
|
||||||
use Illuminate\Contracts\Database\Eloquent\CastsAttributes;
|
use Illuminate\Contracts\Database\Eloquent\CastsAttributes;
|
||||||
use Illuminate\Contracts\Database\Eloquent\CastsInboundAttributes;
|
use Illuminate\Contracts\Database\Eloquent\CastsInboundAttributes;
|
||||||
@@ -46,6 +48,7 @@ use Illuminate\Filesystem\Filesystem;
|
|||||||
use Illuminate\Support\Arr;
|
use Illuminate\Support\Arr;
|
||||||
use Illuminate\Support\Collection;
|
use Illuminate\Support\Collection;
|
||||||
use Illuminate\Support\Str;
|
use Illuminate\Support\Str;
|
||||||
|
use Illuminate\View\Factory as ViewFactory;
|
||||||
use phpDocumentor\Reflection\Types\ContextFactory;
|
use phpDocumentor\Reflection\Types\ContextFactory;
|
||||||
use ReflectionClass;
|
use ReflectionClass;
|
||||||
use ReflectionNamedType;
|
use ReflectionNamedType;
|
||||||
@@ -82,6 +85,14 @@ class ModelsCommand extends Command
|
|||||||
*/
|
*/
|
||||||
protected $files;
|
protected $files;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @var Repository
|
||||||
|
*/
|
||||||
|
protected $config;
|
||||||
|
|
||||||
|
/** @var ViewFactory */
|
||||||
|
protected $view;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The console command name.
|
* The console command name.
|
||||||
*
|
*
|
||||||
@@ -131,10 +142,12 @@ class ModelsCommand extends Command
|
|||||||
/**
|
/**
|
||||||
* @param Filesystem $files
|
* @param Filesystem $files
|
||||||
*/
|
*/
|
||||||
public function __construct(Filesystem $files)
|
public function __construct(Filesystem $files, Repository $config, ViewFactory $view)
|
||||||
{
|
{
|
||||||
parent::__construct();
|
$this->config = $config;
|
||||||
$this->files = $files;
|
$this->files = $files;
|
||||||
|
$this->view = $view;
|
||||||
|
parent::__construct();
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -187,6 +200,27 @@ class ModelsCommand extends Command
|
|||||||
$this->error("Failed to write model information to $filename");
|
$this->error("Failed to write model information to $filename");
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
$helperFilename = $this->config->get('ide-helper.filename');
|
||||||
|
$writeHelper = $this->option('write-eloquent-helper');
|
||||||
|
|
||||||
|
if (!$writeHelper && !$this->files->exists($helperFilename) && ($this->write || $this->write_mixin)) {
|
||||||
|
if ($this->confirm("{$helperFilename} does not exist.
|
||||||
|
Do you want to generate a minimal helper to generate the Eloquent methods?")) {
|
||||||
|
$writeHelper = true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($writeHelper) {
|
||||||
|
$generator = new Generator($this->config, $this->view, $this->getOutput());
|
||||||
|
$content = $generator->generateEloquent();
|
||||||
|
$written = $this->files->put($helperFilename, $content);
|
||||||
|
if ($written !== false) {
|
||||||
|
$this->info("Eloquent helper was written to $helperFilename");
|
||||||
|
} else {
|
||||||
|
$this->error("Failed to write eloquent helper to $helperFilename");
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
@@ -217,6 +251,9 @@ class ModelsCommand extends Command
|
|||||||
['write-mixin', 'M', InputOption::VALUE_NONE,
|
['write-mixin', 'M', InputOption::VALUE_NONE,
|
||||||
"Write models to {$this->filename} and adds @mixin to each model, avoiding IDE duplicate declaration warnings",
|
"Write models to {$this->filename} and adds @mixin to each model, avoiding IDE duplicate declaration warnings",
|
||||||
],
|
],
|
||||||
|
['write-eloquent-helper', 'E', InputOption::VALUE_NONE,
|
||||||
|
'Write Eloquent helper file to _ide_helper.php',
|
||||||
|
],
|
||||||
['nowrite', 'N', InputOption::VALUE_NONE, 'Don\'t write to Model file'],
|
['nowrite', 'N', InputOption::VALUE_NONE, 'Don\'t write to Model file'],
|
||||||
['reset', 'R', InputOption::VALUE_NONE, 'Remove the original phpdocs instead of appending'],
|
['reset', 'R', InputOption::VALUE_NONE, 'Remove the original phpdocs instead of appending'],
|
||||||
['smart-reset', 'r', InputOption::VALUE_NONE, 'Retained for compatibility, while it no longer has any effect'],
|
['smart-reset', 'r', InputOption::VALUE_NONE, 'Retained for compatibility, while it no longer has any effect'],
|
||||||
@@ -389,7 +426,7 @@ class ModelsCommand extends Command
|
|||||||
break;
|
break;
|
||||||
case 'array':
|
case 'array':
|
||||||
case 'json':
|
case 'json':
|
||||||
$realType = 'array';
|
$realType = 'array<array-key, mixed>';
|
||||||
break;
|
break;
|
||||||
case 'object':
|
case 'object':
|
||||||
$realType = 'object';
|
$realType = 'object';
|
||||||
@@ -413,10 +450,10 @@ class ModelsCommand extends Command
|
|||||||
$realType = '\Carbon\CarbonImmutable';
|
$realType = '\Carbon\CarbonImmutable';
|
||||||
break;
|
break;
|
||||||
case 'collection':
|
case 'collection':
|
||||||
$realType = '\Illuminate\Support\Collection';
|
$realType = '\Illuminate\Support\Collection<array-key, mixed>';
|
||||||
break;
|
break;
|
||||||
case AsArrayObject::class:
|
case AsArrayObject::class:
|
||||||
$realType = '\ArrayObject';
|
$realType = '\ArrayObject<array-key, mixed>';
|
||||||
break;
|
break;
|
||||||
default:
|
default:
|
||||||
// In case of an optional custom cast parameter , only evaluate
|
// In case of an optional custom cast parameter , only evaluate
|
||||||
@@ -720,7 +757,7 @@ class ModelsCommand extends Command
|
|||||||
$relationReturnType === 'many' ||
|
$relationReturnType === 'many' ||
|
||||||
(
|
(
|
||||||
!$relationReturnType &&
|
!$relationReturnType &&
|
||||||
strpos(get_class($relationObj), 'Many') !== false
|
str_contains(get_class($relationObj), 'Many')
|
||||||
)
|
)
|
||||||
) {
|
) {
|
||||||
if ($relationObj instanceof BelongsToMany) {
|
if ($relationObj instanceof BelongsToMany) {
|
||||||
@@ -729,16 +766,22 @@ class ModelsCommand extends Command
|
|||||||
$pivot = $this->getClassNameInDestinationFile($model, $pivot);
|
$pivot = $this->getClassNameInDestinationFile($model, $pivot);
|
||||||
|
|
||||||
if ($existingPivot = ($this->properties[$relationObj->getPivotAccessor()] ?? null)) {
|
if ($existingPivot = ($this->properties[$relationObj->getPivotAccessor()] ?? null)) {
|
||||||
// If the pivot is already set, we need to append the type to it
|
$existingClasses = explode('|', $existingPivot['type']);
|
||||||
$pivot .= '|' . $existingPivot['type'];
|
|
||||||
|
if (!in_array($pivot, $existingClasses)) {
|
||||||
|
array_unshift($existingClasses, $pivot);
|
||||||
|
}
|
||||||
} else {
|
} else {
|
||||||
// pivots are not always set
|
// No existing pivot property, so we need to add a null type
|
||||||
$pivot .= '|null';
|
$existingClasses = [$pivot, 'null'];
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// create a union type of all pivot classes
|
||||||
|
$unionType = implode('|', $existingClasses);
|
||||||
|
|
||||||
$this->setProperty(
|
$this->setProperty(
|
||||||
$relationObj->getPivotAccessor(),
|
$relationObj->getPivotAccessor(),
|
||||||
$pivot,
|
$unionType,
|
||||||
true,
|
true,
|
||||||
false
|
false
|
||||||
);
|
);
|
||||||
@@ -830,13 +873,15 @@ class ModelsCommand extends Command
|
|||||||
$fkProp = $reflectionObj->getProperty('foreignKey');
|
$fkProp = $reflectionObj->getProperty('foreignKey');
|
||||||
$fkProp->setAccessible(true);
|
$fkProp->setAccessible(true);
|
||||||
|
|
||||||
|
$enforceNullableRelation = $this->laravel['config']->get('ide-helper.enforce_nullable_relationships', true);
|
||||||
|
|
||||||
foreach (Arr::wrap($fkProp->getValue($relationObj)) as $foreignKey) {
|
foreach (Arr::wrap($fkProp->getValue($relationObj)) as $foreignKey) {
|
||||||
if (isset($this->nullableColumns[$foreignKey])) {
|
if (isset($this->nullableColumns[$foreignKey])) {
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
if (!in_array($foreignKey, $this->foreignKeyConstraintsColumns, true)) {
|
if (!in_array($foreignKey, $this->foreignKeyConstraintsColumns, true)) {
|
||||||
return true;
|
return $enforceNullableRelation;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -1293,10 +1338,11 @@ class ModelsCommand extends Command
|
|||||||
* Get method return type based on it DocBlock comment
|
* Get method return type based on it DocBlock comment
|
||||||
*
|
*
|
||||||
* @param \ReflectionMethod $reflection
|
* @param \ReflectionMethod $reflection
|
||||||
|
* @param ?\Reflector $reflectorForContext
|
||||||
*
|
*
|
||||||
* @return null|string
|
* @return null|string
|
||||||
*/
|
*/
|
||||||
protected function getReturnTypeFromDocBlock(\ReflectionMethod $reflection, \Reflector $reflectorForContext = null)
|
protected function getReturnTypeFromDocBlock(\ReflectionMethod $reflection, ?\Reflector $reflectorForContext = null)
|
||||||
{
|
{
|
||||||
$phpDocContext = (new ContextFactory())->createFromReflector($reflectorForContext ?? $reflection);
|
$phpDocContext = (new ContextFactory())->createFromReflector($reflectorForContext ?? $reflection);
|
||||||
$context = new Context(
|
$context = new Context(
|
||||||
|
|||||||
+30
-3
@@ -11,6 +11,7 @@
|
|||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper;
|
namespace Barryvdh\LaravelIdeHelper;
|
||||||
|
|
||||||
|
use Illuminate\Database\Eloquent\Model;
|
||||||
use Illuminate\Foundation\AliasLoader;
|
use Illuminate\Foundation\AliasLoader;
|
||||||
use Illuminate\Support\Collection;
|
use Illuminate\Support\Collection;
|
||||||
use Illuminate\Support\Facades\Facade;
|
use Illuminate\Support\Facades\Facade;
|
||||||
@@ -42,7 +43,7 @@ class Generator
|
|||||||
/**
|
/**
|
||||||
* @param \Illuminate\Config\Repository $config
|
* @param \Illuminate\Config\Repository $config
|
||||||
* @param \Illuminate\View\Factory $view
|
* @param \Illuminate\View\Factory $view
|
||||||
* @param OutputInterface $output
|
* @param ?OutputInterface $output
|
||||||
* @param string $helpers
|
* @param string $helpers
|
||||||
*/
|
*/
|
||||||
public function __construct(
|
public function __construct(
|
||||||
@@ -50,11 +51,12 @@ class Generator
|
|||||||
$config,
|
$config,
|
||||||
/* Illuminate\View\Factory */
|
/* Illuminate\View\Factory */
|
||||||
$view,
|
$view,
|
||||||
OutputInterface $output = null,
|
?OutputInterface $output = null,
|
||||||
$helpers = ''
|
$helpers = ''
|
||||||
) {
|
) {
|
||||||
$this->config = $config;
|
$this->config = $config;
|
||||||
$this->view = $view;
|
$this->view = $view;
|
||||||
|
$this->output = $output;
|
||||||
|
|
||||||
// Find the drivers to add to the extra/interfaces
|
// Find the drivers to add to the extra/interfaces
|
||||||
$this->detectDrivers();
|
$this->detectDrivers();
|
||||||
@@ -82,12 +84,37 @@ class Generator
|
|||||||
->with('namespaces_by_alias_ns', $this->getAliasesByAliasNamespace())
|
->with('namespaces_by_alias_ns', $this->getAliasesByAliasNamespace())
|
||||||
->with('real_time_facades', $this->getRealTimeFacades())
|
->with('real_time_facades', $this->getRealTimeFacades())
|
||||||
->with('helpers', $this->helpers)
|
->with('helpers', $this->helpers)
|
||||||
->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))
|
||||||
->with('factories', $this->config->get('ide-helper.include_factory_builders') ? Factories::all() : [])
|
->with('factories', $this->config->get('ide-helper.include_factory_builders') ? Factories::all() : [])
|
||||||
->render();
|
->render();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public function generateEloquent()
|
||||||
|
{
|
||||||
|
$name = 'Eloquent';
|
||||||
|
$facade = Model::class;
|
||||||
|
$magicMethods = array_key_exists($name, $this->magic) ? $this->magic[$name] : [];
|
||||||
|
$alias = new Alias($this->config, $name, $facade, $magicMethods, $this->interfaces);
|
||||||
|
if (!$alias->isValid()) {
|
||||||
|
throw new \RuntimeException('Cannot generate Eloquent helper');
|
||||||
|
}
|
||||||
|
|
||||||
|
//Add extra methods, from other classes (magic static calls)
|
||||||
|
if (array_key_exists($name, $this->extra)) {
|
||||||
|
$alias->addClass($this->extra[$name]);
|
||||||
|
}
|
||||||
|
|
||||||
|
$app = app();
|
||||||
|
return $this->view->make('helper')
|
||||||
|
->with('namespaces_by_extends_ns', [])
|
||||||
|
->with('namespaces_by_alias_ns', ['__root' => [$alias]])
|
||||||
|
->with('real_time_facades', [])
|
||||||
|
->with('helpers', '')
|
||||||
|
->with('include_fluent', false)
|
||||||
|
->with('factories', [])
|
||||||
|
->render();
|
||||||
|
}
|
||||||
|
|
||||||
protected function detectDrivers()
|
protected function detectDrivers()
|
||||||
{
|
{
|
||||||
$defaultUserModel = config('auth.providers.users.model', config('auth.model', 'App\User'));
|
$defaultUserModel = config('auth.providers.users.model', config('auth.model', 'App\User'));
|
||||||
|
|||||||
@@ -64,41 +64,20 @@ class IdeHelperServiceProvider extends ServiceProvider implements DeferrableProv
|
|||||||
{
|
{
|
||||||
$configPath = __DIR__ . '/../config/ide-helper.php';
|
$configPath = __DIR__ . '/../config/ide-helper.php';
|
||||||
$this->mergeConfigFrom($configPath, 'ide-helper');
|
$this->mergeConfigFrom($configPath, 'ide-helper');
|
||||||
$localViewFactory = $this->createLocalViewFactory();
|
|
||||||
|
|
||||||
$this->app->singleton(
|
$this->app->when([GeneratorCommand::class, MetaCommand::class, ModelsCommand::class])
|
||||||
'command.ide-helper.generate',
|
->needs(\Illuminate\Contracts\View\Factory::class)
|
||||||
function ($app) use ($localViewFactory) {
|
->give(function () {
|
||||||
return new GeneratorCommand($app['config'], $app['files'], $localViewFactory);
|
return $this->createLocalViewFactory();
|
||||||
}
|
});
|
||||||
);
|
|
||||||
|
|
||||||
$this->app->singleton(
|
|
||||||
'command.ide-helper.models',
|
|
||||||
function ($app) {
|
|
||||||
return new ModelsCommand($app['files']);
|
|
||||||
}
|
|
||||||
);
|
|
||||||
|
|
||||||
$this->app->singleton(
|
|
||||||
'command.ide-helper.meta',
|
|
||||||
function ($app) use ($localViewFactory) {
|
|
||||||
return new MetaCommand($app['files'], $localViewFactory, $app['config']);
|
|
||||||
}
|
|
||||||
);
|
|
||||||
|
|
||||||
$this->app->singleton(
|
|
||||||
'command.ide-helper.eloquent',
|
|
||||||
function ($app) {
|
|
||||||
return new EloquentCommand($app['files']);
|
|
||||||
}
|
|
||||||
);
|
|
||||||
|
|
||||||
$this->commands(
|
$this->commands(
|
||||||
'command.ide-helper.generate',
|
[
|
||||||
'command.ide-helper.models',
|
GeneratorCommand::class,
|
||||||
'command.ide-helper.meta',
|
ModelsCommand::class,
|
||||||
'command.ide-helper.eloquent'
|
MetaCommand::class,
|
||||||
|
EloquentCommand::class,
|
||||||
|
]
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -109,7 +88,12 @@ class IdeHelperServiceProvider extends ServiceProvider implements DeferrableProv
|
|||||||
*/
|
*/
|
||||||
public function provides()
|
public function provides()
|
||||||
{
|
{
|
||||||
return ['command.ide-helper.generate', 'command.ide-helper.models'];
|
return [
|
||||||
|
GeneratorCommand::class,
|
||||||
|
ModelsCommand::class,
|
||||||
|
MetaCommand::class,
|
||||||
|
EloquentCommand::class,
|
||||||
|
];
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|||||||
+4
-2
@@ -18,6 +18,7 @@ class Macro extends Method
|
|||||||
* @param null $methodName
|
* @param null $methodName
|
||||||
* @param array $interfaces
|
* @param array $interfaces
|
||||||
* @param array $classAliases
|
* @param array $classAliases
|
||||||
|
* @param array $returnTypeNormalizers
|
||||||
*/
|
*/
|
||||||
public function __construct(
|
public function __construct(
|
||||||
$method,
|
$method,
|
||||||
@@ -25,9 +26,10 @@ class Macro extends Method
|
|||||||
$class,
|
$class,
|
||||||
$methodName = null,
|
$methodName = null,
|
||||||
$interfaces = [],
|
$interfaces = [],
|
||||||
$classAliases = []
|
$classAliases = [],
|
||||||
|
$returnTypeNormalizers = []
|
||||||
) {
|
) {
|
||||||
parent::__construct($method, $alias, $class, $methodName, $interfaces, $classAliases);
|
parent::__construct($method, $alias, $class, $methodName, $interfaces, $classAliases, $returnTypeNormalizers);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|||||||
+34
-14
@@ -17,8 +17,6 @@ use Barryvdh\Reflection\DocBlock\Serializer as DocBlockSerializer;
|
|||||||
use Barryvdh\Reflection\DocBlock\Tag;
|
use Barryvdh\Reflection\DocBlock\Tag;
|
||||||
use Barryvdh\Reflection\DocBlock\Tag\ParamTag;
|
use Barryvdh\Reflection\DocBlock\Tag\ParamTag;
|
||||||
use Barryvdh\Reflection\DocBlock\Tag\ReturnTag;
|
use Barryvdh\Reflection\DocBlock\Tag\ReturnTag;
|
||||||
use Illuminate\Database\Eloquent\Builder;
|
|
||||||
use Illuminate\Support\Str;
|
|
||||||
|
|
||||||
class Method
|
class Method
|
||||||
{
|
{
|
||||||
@@ -39,6 +37,7 @@ class Method
|
|||||||
protected $return = null;
|
protected $return = null;
|
||||||
protected $root;
|
protected $root;
|
||||||
protected $classAliases;
|
protected $classAliases;
|
||||||
|
protected $returnTypeNormalizers;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param \ReflectionMethod|\ReflectionFunctionAbstract $method
|
* @param \ReflectionMethod|\ReflectionFunctionAbstract $method
|
||||||
@@ -47,12 +46,14 @@ class Method
|
|||||||
* @param string|null $methodName
|
* @param string|null $methodName
|
||||||
* @param array $interfaces
|
* @param array $interfaces
|
||||||
* @param array $classAliases
|
* @param array $classAliases
|
||||||
|
* @param array $returnTypeNormalizers
|
||||||
*/
|
*/
|
||||||
public function __construct($method, $alias, $class, $methodName = null, $interfaces = [], array $classAliases = [])
|
public function __construct($method, $alias, $class, $methodName = null, $interfaces = [], array $classAliases = [], array $returnTypeNormalizers = [])
|
||||||
{
|
{
|
||||||
$this->method = $method;
|
$this->method = $method;
|
||||||
$this->interfaces = $interfaces;
|
$this->interfaces = $interfaces;
|
||||||
$this->classAliases = $classAliases;
|
$this->classAliases = $classAliases;
|
||||||
|
$this->returnTypeNormalizers = $returnTypeNormalizers;
|
||||||
$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);
|
||||||
@@ -180,6 +181,25 @@ class Method
|
|||||||
return $implode ? implode(', ', $this->params) : $this->params;
|
return $implode ? implode(', ', $this->params) : $this->params;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param DocBlock|null $phpdoc
|
||||||
|
* @return ReturnTag|null
|
||||||
|
*/
|
||||||
|
public function getReturnTag($phpdoc = null)
|
||||||
|
{
|
||||||
|
if ($phpdoc === null) {
|
||||||
|
$phpdoc = $this->phpdoc;
|
||||||
|
}
|
||||||
|
|
||||||
|
$returnTags = $phpdoc->getTagsByName('return');
|
||||||
|
|
||||||
|
if (count($returnTags) === 0) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
return reset($returnTags);
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the parameters for this method including default values
|
* Get the parameters for this method including default values
|
||||||
*
|
*
|
||||||
@@ -248,25 +268,31 @@ class Method
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Normalize the return tag (make full namespace, replace interfaces)
|
* Normalize the return tag (make full namespace, replace interfaces, resolve $this)
|
||||||
*
|
*
|
||||||
* @param DocBlock $phpdoc
|
* @param DocBlock $phpdoc
|
||||||
*/
|
*/
|
||||||
protected function normalizeReturn(DocBlock $phpdoc)
|
protected function normalizeReturn(DocBlock $phpdoc)
|
||||||
{
|
{
|
||||||
//Get the return type and adjust them for better autocomplete
|
//Get the return type and adjust them for better autocomplete
|
||||||
$returnTags = $phpdoc->getTagsByName('return');
|
$tag = $this->getReturnTag($phpdoc);
|
||||||
|
|
||||||
if (count($returnTags) === 0) {
|
if ($tag === null) {
|
||||||
$this->return = null;
|
$this->return = null;
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
/** @var ReturnTag $tag */
|
|
||||||
$tag = reset($returnTags);
|
|
||||||
// Get the expanded type
|
// Get the expanded type
|
||||||
$returnValue = $tag->getType();
|
$returnValue = $tag->getType();
|
||||||
|
|
||||||
|
if (array_key_exists($returnValue, $this->returnTypeNormalizers)) {
|
||||||
|
$returnValue = $this->returnTypeNormalizers[$returnValue];
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($returnValue === '$this') {
|
||||||
|
$returnValue = $this->root;
|
||||||
|
}
|
||||||
|
|
||||||
// Replace the interfaces
|
// Replace the interfaces
|
||||||
foreach ($this->interfaces as $interface => $real) {
|
foreach ($this->interfaces as $interface => $real) {
|
||||||
$returnValue = str_replace($interface, $real, $returnValue);
|
$returnValue = str_replace($interface, $real, $returnValue);
|
||||||
@@ -275,12 +301,6 @@ class Method
|
|||||||
// Set the changed content
|
// Set the changed content
|
||||||
$tag->setContent($returnValue . ' ' . $tag->getDescription());
|
$tag->setContent($returnValue . ' ' . $tag->getDescription());
|
||||||
$this->return = $returnValue;
|
$this->return = $returnValue;
|
||||||
|
|
||||||
if ($tag->getType() === '$this') {
|
|
||||||
Str::contains($this->root, Builder::class)
|
|
||||||
? $tag->setType($this->root . '|static')
|
|
||||||
: $tag->setType($this->root);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
declare(strict_types=1);
|
declare(strict_types=1);
|
||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console;
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\EloquentCommand;
|
||||||
|
|
||||||
use Barryvdh\LaravelIdeHelper\Console\EloquentCommand;
|
use Barryvdh\LaravelIdeHelper\Console\EloquentCommand;
|
||||||
use Barryvdh\LaravelIdeHelper\Tests\TestCase;
|
use Barryvdh\LaravelIdeHelper\Tests\TestCase;
|
||||||
@@ -23,7 +23,7 @@ class EloquentCommandTest extends TestCase
|
|||||||
}
|
}
|
||||||
|
|
||||||
$actualContent = null;
|
$actualContent = null;
|
||||||
$mockFilesystem = Mockery::mock(Filesystem::class);
|
$mockFilesystem = Mockery::mock(Filesystem::class)->makePartial();
|
||||||
$mockFilesystem
|
$mockFilesystem
|
||||||
->shouldReceive('get')
|
->shouldReceive('get')
|
||||||
// We don't care about actual args (filename)
|
// We don't care about actual args (filename)
|
||||||
|
|||||||
@@ -0,0 +1,35 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\GeneratorCommand;
|
||||||
|
|
||||||
|
use Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider;
|
||||||
|
use Barryvdh\LaravelIdeHelper\Tests\SnapshotPhpDriver;
|
||||||
|
use Barryvdh\LaravelIdeHelper\Tests\TestCase;
|
||||||
|
|
||||||
|
abstract class AbstractGeneratorCommand extends TestCase
|
||||||
|
{
|
||||||
|
protected function setUp(): void
|
||||||
|
{
|
||||||
|
parent::setUp();
|
||||||
|
$this->mockFilesystem();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get package providers.
|
||||||
|
*
|
||||||
|
* @param \Illuminate\Foundation\Application $app
|
||||||
|
*
|
||||||
|
* @return array
|
||||||
|
*/
|
||||||
|
protected function getPackageProviders($app)
|
||||||
|
{
|
||||||
|
return [IdeHelperServiceProvider::class];
|
||||||
|
}
|
||||||
|
|
||||||
|
protected function assertMatchesMockedSnapshot()
|
||||||
|
{
|
||||||
|
$this->assertMatchesSnapshot($this->mockFilesystemOutput, new SnapshotPhpDriver());
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,25 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\GeneratorCommand\GenerateEloquentOnly;
|
||||||
|
|
||||||
|
use Barryvdh\LaravelIdeHelper\Console\GeneratorCommand;
|
||||||
|
use Barryvdh\LaravelIdeHelper\Tests\Console\GeneratorCommand\AbstractGeneratorCommand;
|
||||||
|
|
||||||
|
class Test extends AbstractGeneratorCommand
|
||||||
|
{
|
||||||
|
public function testGenerator(): void
|
||||||
|
{
|
||||||
|
$command = $this->app->make(GeneratorCommand::class);
|
||||||
|
|
||||||
|
$tester = $this->runCommand($command, [
|
||||||
|
'--eloquent' => true,
|
||||||
|
]);
|
||||||
|
|
||||||
|
$this->assertSame(0, $tester->getStatusCode());
|
||||||
|
$this->assertStringContainsString('A new helper file was written to _ide_helper.php', $tester->getDisplay());
|
||||||
|
$this->assertStringNotContainsString('public static function configure($basePath = null)', $this->mockFilesystemOutput);
|
||||||
|
$this->assertStringContainsString('class Eloquent extends \Illuminate\Database\Eloquent\Model', $this->mockFilesystemOutput);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,34 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\GeneratorCommand\GenerateIdeHelper;
|
||||||
|
|
||||||
|
use Barryvdh\LaravelIdeHelper\Console\GeneratorCommand;
|
||||||
|
use Barryvdh\LaravelIdeHelper\Tests\Console\GeneratorCommand\AbstractGeneratorCommand;
|
||||||
|
|
||||||
|
class Test extends AbstractGeneratorCommand
|
||||||
|
{
|
||||||
|
public function testGenerator(): void
|
||||||
|
{
|
||||||
|
$command = $this->app->make(GeneratorCommand::class);
|
||||||
|
|
||||||
|
$tester = $this->runCommand($command);
|
||||||
|
|
||||||
|
$this->assertSame(0, $tester->getStatusCode());
|
||||||
|
$this->assertStringContainsString('A new helper file was written to _ide_helper.php', $tester->getDisplay());
|
||||||
|
$this->assertStringContainsString('public static function configure($basePath = null)', $this->mockFilesystemOutput);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testFilename(): void
|
||||||
|
{
|
||||||
|
$command = $this->app->make(GeneratorCommand::class);
|
||||||
|
|
||||||
|
$tester = $this->runCommand($command, [
|
||||||
|
'filename' => 'foo.php',
|
||||||
|
]);
|
||||||
|
|
||||||
|
$this->assertSame(0, $tester->getStatusCode());
|
||||||
|
$this->assertStringContainsString('A new helper file was written to foo.php', $tester->getDisplay());
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -12,13 +12,18 @@ use stdClass;
|
|||||||
|
|
||||||
class MetaCommandTest extends TestCase
|
class MetaCommandTest extends TestCase
|
||||||
{
|
{
|
||||||
|
protected function setUp(): void
|
||||||
|
{
|
||||||
|
parent::setUp();
|
||||||
|
|
||||||
|
$this->mockFilesystem();
|
||||||
|
}
|
||||||
|
|
||||||
public function testCommand(): void
|
public function testCommand(): void
|
||||||
{
|
{
|
||||||
$this->mockFilesystem();
|
|
||||||
|
|
||||||
/** @var Filesystem|MockInterface $mockFileSystem */
|
/** @var Filesystem|MockInterface $mockFileSystem */
|
||||||
$mockFileSystem = $this->app->make(Filesystem::class);
|
$mockFileSystem = $this->app->make(Filesystem::class);
|
||||||
$this->instance('files', $mockFileSystem);
|
$this->instance(Filesystem::class, $mockFileSystem);
|
||||||
|
|
||||||
$mockFileSystem
|
$mockFileSystem
|
||||||
->shouldReceive('getRequire')
|
->shouldReceive('getRequire')
|
||||||
@@ -49,11 +54,9 @@ class MetaCommandTest extends TestCase
|
|||||||
return new stdClass();
|
return new stdClass();
|
||||||
});
|
});
|
||||||
|
|
||||||
$this->mockFilesystem();
|
|
||||||
|
|
||||||
/** @var Filesystem|MockInterface $mockFileSystem */
|
/** @var Filesystem|MockInterface $mockFileSystem */
|
||||||
$mockFileSystem = $this->app->make(Filesystem::class);
|
$mockFileSystem = $this->app->make(Filesystem::class);
|
||||||
$this->instance('files', $mockFileSystem);
|
$this->instance(Filesystem::class, $mockFileSystem);
|
||||||
|
|
||||||
$mockFileSystem
|
$mockFileSystem
|
||||||
->shouldReceive('getRequire')
|
->shouldReceive('getRequire')
|
||||||
|
|||||||
@@ -22,13 +22,13 @@ use Illuminate\Database\Eloquent\Model;
|
|||||||
* @property \Carbon\CarbonImmutable $cast_to_immutable_datetime
|
* @property \Carbon\CarbonImmutable $cast_to_immutable_datetime
|
||||||
* @property int $cast_to_timestamp
|
* @property int $cast_to_timestamp
|
||||||
* @property mixed $cast_to_encrypted
|
* @property mixed $cast_to_encrypted
|
||||||
* @property array $cast_to_encrypted_array
|
* @property array<array-key, mixed> $cast_to_encrypted_array
|
||||||
* @property \Illuminate\Support\Collection $cast_to_encrypted_collection
|
* @property \Illuminate\Support\Collection<array-key, mixed> $cast_to_encrypted_collection
|
||||||
* @property array $cast_to_encrypted_json
|
* @property array<array-key, mixed> $cast_to_encrypted_json
|
||||||
* @property object $cast_to_encrypted_object
|
* @property object $cast_to_encrypted_object
|
||||||
* @property \Illuminate\Support\Collection $cast_to_as_collection
|
* @property \Illuminate\Support\Collection $cast_to_as_collection
|
||||||
* @property \Illuminate\Support\Collection $cast_to_as_enum_collection
|
* @property \Illuminate\Support\Collection $cast_to_as_enum_collection
|
||||||
* @property \ArrayObject $cast_to_as_array_object
|
* @property \ArrayObject<array-key, mixed> $cast_to_as_array_object
|
||||||
* @property AdvancedCastCollection $cast_to_as_collection_using
|
* @property AdvancedCastCollection $cast_to_as_collection_using
|
||||||
* @property \Illuminate\Support\Collection<int, AdvancedCastEnum> $cast_to_as_enum_collection_of
|
* @property \Illuminate\Support\Collection<int, AdvancedCastEnum> $cast_to_as_enum_collection_of
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|AdvancedCast newModelQuery()
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|AdvancedCast newModelQuery()
|
||||||
|
|||||||
@@ -19,6 +19,8 @@ class Test extends AbstractModelsCommand
|
|||||||
|
|
||||||
$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('Do you want to generate a minimal helper to generate the Eloquent methods?', $tester->getDisplay());
|
||||||
|
|
||||||
$this->assertMatchesMockedSnapshot();
|
$this->assertMatchesMockedSnapshot();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,11 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateBasicPhpdocWithEloquentHelper\Models;
|
||||||
|
|
||||||
|
use Illuminate\Database\Eloquent\Model;
|
||||||
|
|
||||||
|
class Post extends Model
|
||||||
|
{
|
||||||
|
}
|
||||||
@@ -0,0 +1,28 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateBasicPhpdocWithEloquentHelper;
|
||||||
|
|
||||||
|
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,
|
||||||
|
'--write-eloquent-helper' => true,
|
||||||
|
]);
|
||||||
|
|
||||||
|
$this->assertSame(0, $tester->getStatusCode());
|
||||||
|
$this->assertStringContainsString('Written new phpDocBlock to', $tester->getDisplay());
|
||||||
|
$this->assertStringNotContainsString('Do you want to generate a minimal helper to generate the Eloquent methods?', $tester->getDisplay());
|
||||||
|
$this->assertStringContainsString('Eloquent helper was written to _ide_helper.php', $tester->getDisplay());
|
||||||
|
|
||||||
|
// $this->assertMatchesMockedSnapshot();
|
||||||
|
}
|
||||||
|
}
|
||||||
+161
@@ -0,0 +1,161 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateBasicPhpdocWithEloquentHelper\Models;
|
||||||
|
|
||||||
|
use Illuminate\Database\Eloquent\Model;
|
||||||
|
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
*
|
||||||
|
* @property int $id
|
||||||
|
* @property string|null $char_nullable
|
||||||
|
* @property string $char_not_nullable
|
||||||
|
* @property string|null $string_nullable
|
||||||
|
* @property string $string_not_nullable
|
||||||
|
* @property string|null $text_nullable
|
||||||
|
* @property string $text_not_nullable
|
||||||
|
* @property string|null $medium_text_nullable
|
||||||
|
* @property string $medium_text_not_nullable
|
||||||
|
* @property string|null $long_text_nullable
|
||||||
|
* @property string $long_text_not_nullable
|
||||||
|
* @property int|null $integer_nullable
|
||||||
|
* @property int $integer_not_nullable
|
||||||
|
* @property int|null $tiny_integer_nullable
|
||||||
|
* @property int $tiny_integer_not_nullable
|
||||||
|
* @property int|null $small_integer_nullable
|
||||||
|
* @property int $small_integer_not_nullable
|
||||||
|
* @property int|null $medium_integer_nullable
|
||||||
|
* @property int $medium_integer_not_nullable
|
||||||
|
* @property int|null $big_integer_nullable
|
||||||
|
* @property int $big_integer_not_nullable
|
||||||
|
* @property int|null $unsigned_integer_nullable
|
||||||
|
* @property int $unsigned_integer_not_nullable
|
||||||
|
* @property int|null $unsigned_tiny_integer_nullable
|
||||||
|
* @property int $unsigned_tiny_integer_not_nullable
|
||||||
|
* @property int|null $unsigned_small_integer_nullable
|
||||||
|
* @property int $unsigned_small_integer_not_nullable
|
||||||
|
* @property int|null $unsigned_medium_integer_nullable
|
||||||
|
* @property int $unsigned_medium_integer_not_nullable
|
||||||
|
* @property int|null $unsigned_big_integer_nullable
|
||||||
|
* @property int $unsigned_big_integer_not_nullable
|
||||||
|
* @property float|null $float_nullable
|
||||||
|
* @property float $float_not_nullable
|
||||||
|
* @property float|null $double_nullable
|
||||||
|
* @property float $double_not_nullable
|
||||||
|
* @property string|null $decimal_nullable
|
||||||
|
* @property string $decimal_not_nullable
|
||||||
|
* @property int|null $boolean_nullable
|
||||||
|
* @property int $boolean_not_nullable
|
||||||
|
* @property string|null $enum_nullable
|
||||||
|
* @property string $enum_not_nullable
|
||||||
|
* @property string|null $json_nullable
|
||||||
|
* @property string $json_not_nullable
|
||||||
|
* @property string|null $jsonb_nullable
|
||||||
|
* @property string $jsonb_not_nullable
|
||||||
|
* @property string|null $date_nullable
|
||||||
|
* @property string $date_not_nullable
|
||||||
|
* @property string|null $datetime_nullable
|
||||||
|
* @property string $datetime_not_nullable
|
||||||
|
* @property string|null $datetimetz_nullable
|
||||||
|
* @property string $datetimetz_not_nullable
|
||||||
|
* @property string|null $time_nullable
|
||||||
|
* @property string $time_not_nullable
|
||||||
|
* @property string|null $timetz_nullable
|
||||||
|
* @property string $timetz_not_nullable
|
||||||
|
* @property string|null $timestamp_nullable
|
||||||
|
* @property string $timestamp_not_nullable
|
||||||
|
* @property string|null $timestamptz_nullable
|
||||||
|
* @property string $timestamptz_not_nullable
|
||||||
|
* @property int|null $year_nullable
|
||||||
|
* @property int $year_not_nullable
|
||||||
|
* @property string|null $binary_nullable
|
||||||
|
* @property string $binary_not_nullable
|
||||||
|
* @property string|null $uuid_nullable
|
||||||
|
* @property string $uuid_not_nullable
|
||||||
|
* @property string|null $ipaddress_nullable
|
||||||
|
* @property string $ipaddress_not_nullable
|
||||||
|
* @property string|null $macaddress_nullable
|
||||||
|
* @property string $macaddress_not_nullable
|
||||||
|
* @property \Illuminate\Support\Carbon|null $created_at
|
||||||
|
* @property \Illuminate\Support\Carbon|null $updated_at
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post newModelQuery()
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post newQuery()
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post query()
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereBigIntegerNotNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereBigIntegerNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereBinaryNotNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereBinaryNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereBooleanNotNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereBooleanNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereCharNotNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereCharNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereCreatedAt($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDateNotNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDateNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDatetimeNotNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDatetimeNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDatetimetzNotNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDatetimetzNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDecimalNotNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDecimalNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDoubleNotNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDoubleNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereEnumNotNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereEnumNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereFloatNotNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereFloatNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereId($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereIntegerNotNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereIntegerNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereIpaddressNotNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereIpaddressNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereJsonNotNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereJsonNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereJsonbNotNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereJsonbNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereLongTextNotNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereLongTextNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereMacaddressNotNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereMacaddressNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereMediumIntegerNotNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereMediumIntegerNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereMediumTextNotNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereMediumTextNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereSmallIntegerNotNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereSmallIntegerNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereStringNotNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereStringNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTextNotNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTextNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTimeNotNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTimeNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTimestampNotNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTimestampNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTimestamptzNotNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTimestamptzNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTimetzNotNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTimetzNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTinyIntegerNotNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTinyIntegerNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedBigIntegerNotNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedBigIntegerNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedIntegerNotNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedIntegerNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedMediumIntegerNotNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedMediumIntegerNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedSmallIntegerNotNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedSmallIntegerNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedTinyIntegerNotNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedTinyIntegerNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUpdatedAt($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUuidNotNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUuidNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereYearNotNullable($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereYearNullable($value)
|
||||||
|
* @mixin \Eloquent
|
||||||
|
*/
|
||||||
|
class Post extends Model
|
||||||
|
{
|
||||||
|
}
|
||||||
@@ -36,7 +36,7 @@ class Test extends AbstractModelsCommand
|
|||||||
{
|
{
|
||||||
$actualContent = null;
|
$actualContent = null;
|
||||||
|
|
||||||
$mockFilesystem = Mockery::mock(Filesystem::class);
|
$mockFilesystem = Mockery::mock(Filesystem::class)->makePartial();
|
||||||
$mockFilesystem
|
$mockFilesystem
|
||||||
->shouldReceive('get')
|
->shouldReceive('get')
|
||||||
->andReturn(file_get_contents(__DIR__ . '/Models/Simple.php'))
|
->andReturn(file_get_contents(__DIR__ . '/Models/Simple.php'))
|
||||||
|
|||||||
@@ -33,6 +33,12 @@ class ModelWithPivot extends Model
|
|||||||
->using(CustomPivot::class);
|
->using(CustomPivot::class);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public function relationCustomPivotUsingSameAccessorAndClass()
|
||||||
|
{
|
||||||
|
return $this->belongsToMany(ModelwithPivot::class)
|
||||||
|
->using(CustomPivot::class);
|
||||||
|
}
|
||||||
|
|
||||||
public function relationWithDifferentCustomPivotUsingSameAccessor()
|
public function relationWithDifferentCustomPivotUsingSameAccessor()
|
||||||
{
|
{
|
||||||
return $this->belongsToMany(ModelwithPivot::class)
|
return $this->belongsToMany(ModelwithPivot::class)
|
||||||
|
|||||||
@@ -14,6 +14,8 @@ use Illuminate\Database\Eloquent\Model;
|
|||||||
* @property-read DifferentCustomPivot|CustomPivot|null $pivot
|
* @property-read DifferentCustomPivot|CustomPivot|null $pivot
|
||||||
* @property-read \Illuminate\Database\Eloquent\Collection<int, ModelWithPivot> $relationCustomPivotUsingSameAccessor
|
* @property-read \Illuminate\Database\Eloquent\Collection<int, ModelWithPivot> $relationCustomPivotUsingSameAccessor
|
||||||
* @property-read int|null $relation_custom_pivot_using_same_accessor_count
|
* @property-read int|null $relation_custom_pivot_using_same_accessor_count
|
||||||
|
* @property-read \Illuminate\Database\Eloquent\Collection<int, ModelWithPivot> $relationCustomPivotUsingSameAccessorAndClass
|
||||||
|
* @property-read int|null $relation_custom_pivot_using_same_accessor_and_class_count
|
||||||
* @property-read CustomPivot|null $customAccessor
|
* @property-read CustomPivot|null $customAccessor
|
||||||
* @property-read \Illuminate\Database\Eloquent\Collection<int, ModelWithPivot> $relationWithCustomPivot
|
* @property-read \Illuminate\Database\Eloquent\Collection<int, ModelWithPivot> $relationWithCustomPivot
|
||||||
* @property-read int|null $relation_with_custom_pivot_count
|
* @property-read int|null $relation_with_custom_pivot_count
|
||||||
@@ -52,6 +54,12 @@ class ModelWithPivot extends Model
|
|||||||
->using(CustomPivot::class);
|
->using(CustomPivot::class);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public function relationCustomPivotUsingSameAccessorAndClass()
|
||||||
|
{
|
||||||
|
return $this->belongsToMany(ModelwithPivot::class)
|
||||||
|
->using(CustomPivot::class);
|
||||||
|
}
|
||||||
|
|
||||||
public function relationWithDifferentCustomPivotUsingSameAccessor()
|
public function relationWithDifferentCustomPivotUsingSameAccessor()
|
||||||
{
|
{
|
||||||
return $this->belongsToMany(ModelwithPivot::class)
|
return $this->belongsToMany(ModelwithPivot::class)
|
||||||
|
|||||||
@@ -46,4 +46,23 @@ class Test extends AbstractModelsCommand
|
|||||||
$this->assertStringContainsString('Written new phpDocBlock to', $tester->getDisplay());
|
$this->assertStringContainsString('Written new phpDocBlock to', $tester->getDisplay());
|
||||||
$this->assertMatchesMockedSnapshot();
|
$this->assertMatchesMockedSnapshot();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public function testRelationNotNullable(): void
|
||||||
|
{
|
||||||
|
// Disable enforcing nullable relationships
|
||||||
|
Config::set('ide-helper.enforce_nullable_relationships', false);
|
||||||
|
|
||||||
|
$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();
|
||||||
|
|
||||||
|
// Re-enable default enforcing nullable relationships
|
||||||
|
Config::set('ide-helper.enforce_nullable_relationships', true);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
+266
@@ -0,0 +1,266 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Models;
|
||||||
|
|
||||||
|
use Illuminate\Database\Eloquent\Model;
|
||||||
|
use Illuminate\Database\Eloquent\Relations\BelongsTo;
|
||||||
|
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
*
|
||||||
|
* @property int $id
|
||||||
|
* @property int $not_null_column_with_foreign_key_constraint
|
||||||
|
* @property int $not_null_column_with_no_foreign_key_constraint
|
||||||
|
* @property int|null $nullable_column_with_foreign_key_constraint
|
||||||
|
* @property int|null $nullable_column_with_no_foreign_key_constraint
|
||||||
|
* @property-read BelongsToVariation $notNullColumnWithForeignKeyConstraint
|
||||||
|
* @property-read BelongsToVariation $notNullColumnWithNoForeignKeyConstraint
|
||||||
|
* @property-read BelongsToVariation|null $nullableColumnWithForeignKeyConstraint
|
||||||
|
* @property-read BelongsToVariation|null $nullableColumnWithNoForeignKeyConstraint
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|BelongsToVariation newModelQuery()
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|BelongsToVariation newQuery()
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|BelongsToVariation query()
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|BelongsToVariation whereId($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|BelongsToVariation whereNotNullColumnWithForeignKeyConstraint($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|BelongsToVariation whereNotNullColumnWithNoForeignKeyConstraint($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|BelongsToVariation whereNullableColumnWithForeignKeyConstraint($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|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;
|
||||||
|
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
*
|
||||||
|
* @property int $id
|
||||||
|
* @property int $not_null_column_with_foreign_key_constraint
|
||||||
|
* @property int $not_null_column_with_no_foreign_key_constraint
|
||||||
|
* @property int|null $nullable_column_with_foreign_key_constraint
|
||||||
|
* @property int|null $nullable_column_with_no_foreign_key_constraint
|
||||||
|
* @property-read CompositeBelongsToVariation $bothNonNullableWithForeignKeyConstraint
|
||||||
|
* @property-read CompositeBelongsToVariation $nonNullableMixedWithoutForeignKeyConstraint
|
||||||
|
* @property-read CompositeBelongsToVariation|null $nullableMixedWithForeignKeyConstraint
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|CompositeBelongsToVariation newModelQuery()
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|CompositeBelongsToVariation newQuery()
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|CompositeBelongsToVariation query()
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|CompositeBelongsToVariation whereId($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|CompositeBelongsToVariation whereNotNullColumnWithForeignKeyConstraint($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|CompositeBelongsToVariation whereNotNullColumnWithNoForeignKeyConstraint($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|CompositeBelongsToVariation whereNullableColumnWithForeignKeyConstraint($value)
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|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\Traits\HasTestRelations;
|
||||||
|
use Illuminate\Database\Eloquent\Model;
|
||||||
|
use Illuminate\Database\Eloquent\Relations\BelongsTo;
|
||||||
|
use Illuminate\Database\Eloquent\Relations\BelongsToMany;
|
||||||
|
use Illuminate\Database\Eloquent\Relations\HasMany;
|
||||||
|
use Illuminate\Database\Eloquent\Relations\HasOne;
|
||||||
|
use Illuminate\Database\Eloquent\Relations\MorphMany;
|
||||||
|
use Illuminate\Database\Eloquent\Relations\MorphOne;
|
||||||
|
use Illuminate\Database\Eloquent\Relations\MorphTo;
|
||||||
|
use Illuminate\Database\Eloquent\Relations\MorphToMany;
|
||||||
|
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
*
|
||||||
|
* @property int $id
|
||||||
|
* @property-read Simple $relationBelongsTo
|
||||||
|
* @property-read AnotherModel $relationBelongsToInAnotherNamespace
|
||||||
|
* @property-read \Illuminate\Database\Eloquent\Collection<int, Simple> $relationBelongsToMany
|
||||||
|
* @property-read int|null $relation_belongs_to_many_count
|
||||||
|
* @property-read \Illuminate\Database\Eloquent\Collection<int, Simple> $relationBelongsToManyWithSub
|
||||||
|
* @property-read int|null $relation_belongs_to_many_with_sub_count
|
||||||
|
* @property-read \Illuminate\Database\Eloquent\Collection<int, Simple> $relationBelongsToManyWithSubAnother
|
||||||
|
* @property-read int|null $relation_belongs_to_many_with_sub_another_count
|
||||||
|
* @property-read AnotherModel $relationBelongsToSameNameAsColumn
|
||||||
|
* @property-read \Illuminate\Database\Eloquent\Collection<int, Simple> $relationHasMany
|
||||||
|
* @property-read int|null $relation_has_many_count
|
||||||
|
* @property-read Simple|null $relationHasOne
|
||||||
|
* @property-read Simple $relationHasOneWithDefault
|
||||||
|
* @property-read \Illuminate\Database\Eloquent\Collection<int, Simple> $relationMorphMany
|
||||||
|
* @property-read int|null $relation_morph_many_count
|
||||||
|
* @property-read Simple|null $relationMorphOne
|
||||||
|
* @property-read Model|\Eloquent $relationMorphTo
|
||||||
|
* @property-read \Illuminate\Database\Eloquent\Collection<int, Simple> $relationMorphedByMany
|
||||||
|
* @property-read int|null $relation_morphed_by_many_count
|
||||||
|
* @property-read \Illuminate\Database\Eloquent\Collection<int, Simple> $relationSampleRelationType
|
||||||
|
* @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
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple newModelQuery()
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple newQuery()
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple query()
|
||||||
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple whereId($value)
|
||||||
|
* @mixin \Eloquent
|
||||||
|
*/
|
||||||
|
class Simple extends Model
|
||||||
|
{
|
||||||
|
use HasTestRelations;
|
||||||
|
|
||||||
|
// Regular relations
|
||||||
|
public function relationHasMany(): HasMany
|
||||||
|
{
|
||||||
|
return $this->hasMany(Simple::class);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function relationHasOne(): HasOne
|
||||||
|
{
|
||||||
|
return $this->hasOne(Simple::class);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function relationHasOneWithDefault(): HasOne
|
||||||
|
{
|
||||||
|
return $this->hasOne(Simple::class)->withDefault();
|
||||||
|
}
|
||||||
|
|
||||||
|
public function relationBelongsTo(): BelongsTo
|
||||||
|
{
|
||||||
|
return $this->belongsTo(Simple::class);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function relationBelongsToMany(): BelongsToMany
|
||||||
|
{
|
||||||
|
return $this->belongsToMany(Simple::class);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function relationBelongsToManyWithSub(): BelongsToMany
|
||||||
|
{
|
||||||
|
return $this->belongsToMany(Simple::class)->where('foo', 'bar');
|
||||||
|
}
|
||||||
|
|
||||||
|
public function relationBelongsToManyWithSubAnother(): BelongsToMany
|
||||||
|
{
|
||||||
|
return $this->relationBelongsToManyWithSub()->where('foo', 'bar');
|
||||||
|
}
|
||||||
|
|
||||||
|
public function relationMorphTo(): MorphTo
|
||||||
|
{
|
||||||
|
return $this->morphTo();
|
||||||
|
}
|
||||||
|
|
||||||
|
public function relationMorphOne(): MorphOne
|
||||||
|
{
|
||||||
|
return $this->morphOne(Simple::class, 'relationMorphTo');
|
||||||
|
}
|
||||||
|
|
||||||
|
public function relationMorphMany(): MorphMany
|
||||||
|
{
|
||||||
|
return $this->morphMany(Simple::class, 'relationMorphTo');
|
||||||
|
}
|
||||||
|
|
||||||
|
public function relationMorphedByMany(): MorphToMany
|
||||||
|
{
|
||||||
|
return $this->morphedByMany(Simple::class, 'foo');
|
||||||
|
}
|
||||||
|
|
||||||
|
// Custom relations
|
||||||
|
|
||||||
|
public function relationBelongsToInAnotherNamespace(): BelongsTo
|
||||||
|
{
|
||||||
|
return $this->belongsTo(AnotherModel::class);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function relationBelongsToSameNameAsColumn(): BelongsTo
|
||||||
|
{
|
||||||
|
return $this->belongsTo(AnotherModel::class, __FUNCTION__);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function relationSampleToManyRelationType()
|
||||||
|
{
|
||||||
|
return $this->testToOneRelation(Simple::class);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function relationSampleRelationType()
|
||||||
|
{
|
||||||
|
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);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -19,9 +19,9 @@ use Illuminate\Database\Eloquent\Model;
|
|||||||
* @property bool $cast_to_bool
|
* @property bool $cast_to_bool
|
||||||
* @property bool $cast_to_boolean
|
* @property bool $cast_to_boolean
|
||||||
* @property object $cast_to_object
|
* @property object $cast_to_object
|
||||||
* @property array $cast_to_array
|
* @property array<array-key, mixed> $cast_to_array
|
||||||
* @property array $cast_to_json
|
* @property array<array-key, mixed> $cast_to_json
|
||||||
* @property \Illuminate\Support\Collection $cast_to_collection
|
* @property \Illuminate\Support\Collection<array-key, mixed> $cast_to_collection
|
||||||
* @property \Illuminate\Support\Carbon $cast_to_date
|
* @property \Illuminate\Support\Carbon $cast_to_date
|
||||||
* @property \Illuminate\Support\Carbon $cast_to_datetime
|
* @property \Illuminate\Support\Carbon $cast_to_datetime
|
||||||
* @property \Illuminate\Support\Carbon $cast_to_date_serialization
|
* @property \Illuminate\Support\Carbon $cast_to_date_serialization
|
||||||
@@ -34,9 +34,9 @@ use Illuminate\Database\Eloquent\Model;
|
|||||||
* @property \Carbon\CarbonImmutable $cast_to_immutable_datetime_serialization
|
* @property \Carbon\CarbonImmutable $cast_to_immutable_datetime_serialization
|
||||||
* @property int $cast_to_timestamp
|
* @property int $cast_to_timestamp
|
||||||
* @property mixed $cast_to_encrypted
|
* @property mixed $cast_to_encrypted
|
||||||
* @property array $cast_to_encrypted_array
|
* @property array<array-key, mixed> $cast_to_encrypted_array
|
||||||
* @property \Illuminate\Support\Collection $cast_to_encrypted_collection
|
* @property \Illuminate\Support\Collection<array-key, mixed> $cast_to_encrypted_collection
|
||||||
* @property array $cast_to_encrypted_json
|
* @property array<array-key, mixed> $cast_to_encrypted_json
|
||||||
* @property object $cast_to_encrypted_object
|
* @property object $cast_to_encrypted_object
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|SimpleCast newModelQuery()
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|SimpleCast newModelQuery()
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|SimpleCast newQuery()
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|SimpleCast newQuery()
|
||||||
|
|||||||
+4
-4
@@ -55,7 +55,7 @@ class MacroTest extends TestCase
|
|||||||
{
|
{
|
||||||
$phpdoc = (new MacroMock())->getPhpDoc(
|
$phpdoc = (new MacroMock())->getPhpDoc(
|
||||||
new ReflectionFunction(
|
new ReflectionFunction(
|
||||||
function (int $a = null): int {
|
function (?int $a = null): int {
|
||||||
return 0;
|
return 0;
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
@@ -79,7 +79,7 @@ class MacroTest extends TestCase
|
|||||||
/**
|
/**
|
||||||
* Test docblock.
|
* Test docblock.
|
||||||
*/
|
*/
|
||||||
function (int $a = null): int {
|
function (?int $a = null): int {
|
||||||
return 0;
|
return 0;
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
@@ -103,7 +103,7 @@ class MacroTest extends TestCase
|
|||||||
/**
|
/**
|
||||||
* Test docblock.
|
* Test docblock.
|
||||||
*/
|
*/
|
||||||
function (int $a = null) {
|
function (?int $a = null) {
|
||||||
return 0;
|
return 0;
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
@@ -274,7 +274,7 @@ class MacroMock extends Macro
|
|||||||
// no need to call parent
|
// no need to call parent
|
||||||
}
|
}
|
||||||
|
|
||||||
public function getPhpDoc(ReflectionFunctionAbstract $method, ReflectionClass $class = null): DocBlock
|
public function getPhpDoc(ReflectionFunctionAbstract $method, ?ReflectionClass $class = null): DocBlock
|
||||||
{
|
{
|
||||||
return (new Macro($method, '', $class ?? $method->getClosureScopeClass()))->phpdoc;
|
return (new Macro($method, '', $class ?? $method->getClosureScopeClass()))->phpdoc;
|
||||||
}
|
}
|
||||||
|
|||||||
+68
-4
@@ -5,7 +5,8 @@ declare(strict_types=1);
|
|||||||
namespace Barryvdh\LaravelIdeHelper\Tests;
|
namespace Barryvdh\LaravelIdeHelper\Tests;
|
||||||
|
|
||||||
use Barryvdh\LaravelIdeHelper\Method;
|
use Barryvdh\LaravelIdeHelper\Method;
|
||||||
use Illuminate\Database\Eloquent\Builder;
|
use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
|
||||||
|
use Illuminate\Database\Query\Builder as QueryBuilder;
|
||||||
use PHPUnit\Framework\TestCase;
|
use PHPUnit\Framework\TestCase;
|
||||||
|
|
||||||
class MethodTest extends TestCase
|
class MethodTest extends TestCase
|
||||||
@@ -54,11 +55,11 @@ DOC;
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Test the output of a class
|
* Test the output of Illuminate\Database\Eloquent\Builder
|
||||||
*/
|
*/
|
||||||
public function testEloquentBuilderOutput()
|
public function testEloquentBuilderOutput()
|
||||||
{
|
{
|
||||||
$reflectionClass = new \ReflectionClass(Builder::class);
|
$reflectionClass = new \ReflectionClass(EloquentBuilder::class);
|
||||||
$reflectionMethod = $reflectionClass->getMethod('upsert');
|
$reflectionMethod = $reflectionClass->getMethod('upsert');
|
||||||
|
|
||||||
$method = new Method($reflectionMethod, 'Builder', $reflectionClass);
|
$method = new Method($reflectionMethod, 'Builder', $reflectionClass);
|
||||||
@@ -76,12 +77,75 @@ DOC;
|
|||||||
DOC;
|
DOC;
|
||||||
$this->assertSame($output, $method->getDocComment(''));
|
$this->assertSame($output, $method->getDocComment(''));
|
||||||
$this->assertSame('upsert', $method->getName());
|
$this->assertSame('upsert', $method->getName());
|
||||||
$this->assertSame('\\' . Builder::class, $method->getDeclaringClass());
|
$this->assertSame('\\' . EloquentBuilder::class, $method->getDeclaringClass());
|
||||||
$this->assertSame('$values, $uniqueBy, $update', $method->getParams(true));
|
$this->assertSame('$values, $uniqueBy, $update', $method->getParams(true));
|
||||||
$this->assertSame(['$values', '$uniqueBy', '$update'], $method->getParams(false));
|
$this->assertSame(['$values', '$uniqueBy', '$update'], $method->getParams(false));
|
||||||
$this->assertSame('$values, $uniqueBy, $update = null', $method->getParamsWithDefault(true));
|
$this->assertSame('$values, $uniqueBy, $update = null', $method->getParamsWithDefault(true));
|
||||||
$this->assertSame(['$values', '$uniqueBy', '$update = null'], $method->getParamsWithDefault(false));
|
$this->assertSame(['$values', '$uniqueBy', '$update = null'], $method->getParamsWithDefault(false));
|
||||||
$this->assertTrue($method->shouldReturn());
|
$this->assertTrue($method->shouldReturn());
|
||||||
|
$this->assertSame('int', rtrim($method->getReturnTag()->getType()));
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Test normalized return type of Illuminate\Database\Eloquent\Builder
|
||||||
|
*/
|
||||||
|
public function testEloquentBuilderNormalizedReturnType()
|
||||||
|
{
|
||||||
|
$reflectionClass = new \ReflectionClass(EloquentBuilder::class);
|
||||||
|
$reflectionMethod = $reflectionClass->getMethod('where');
|
||||||
|
|
||||||
|
$method = new Method($reflectionMethod, 'Builder', $reflectionClass, null, [], [], ['$this' => '\\' . EloquentBuilder::class . '<static>']);
|
||||||
|
|
||||||
|
$output = <<<'DOC'
|
||||||
|
/**
|
||||||
|
* Add a basic where clause to the query.
|
||||||
|
*
|
||||||
|
* @param (\Closure(static): mixed)|string|array|\Illuminate\Contracts\Database\Query\Expression $column
|
||||||
|
* @param mixed $operator
|
||||||
|
* @param mixed $value
|
||||||
|
* @param string $boolean
|
||||||
|
* @return \Illuminate\Database\Eloquent\Builder<static>
|
||||||
|
* @static
|
||||||
|
*/
|
||||||
|
DOC;
|
||||||
|
$this->assertSame($output, $method->getDocComment(''));
|
||||||
|
$this->assertSame('where', $method->getName());
|
||||||
|
$this->assertSame('\\' . EloquentBuilder::class, $method->getDeclaringClass());
|
||||||
|
$this->assertSame(['$column', '$operator', '$value', '$boolean'], $method->getParams(false));
|
||||||
|
$this->assertSame(['$column', '$operator = null', '$value = null', "\$boolean = 'and'"], $method->getParamsWithDefault(false));
|
||||||
|
$this->assertTrue($method->shouldReturn());
|
||||||
|
$this->assertSame('\Illuminate\Database\Eloquent\Builder<static>', rtrim($method->getReturnTag()->getType()));
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Test normalized return type of Illuminate\Database\Query\Builder
|
||||||
|
*/
|
||||||
|
public function testQueryBuilderNormalizedReturnType()
|
||||||
|
{
|
||||||
|
$reflectionClass = new \ReflectionClass(QueryBuilder::class);
|
||||||
|
$reflectionMethod = $reflectionClass->getMethod('whereNull');
|
||||||
|
|
||||||
|
$method = new Method($reflectionMethod, 'Builder', $reflectionClass, null, [], [], ['$this' => '\\' . EloquentBuilder::class . '<static>']);
|
||||||
|
|
||||||
|
$output = <<<'DOC'
|
||||||
|
/**
|
||||||
|
* Add a "where null" clause to the query.
|
||||||
|
*
|
||||||
|
* @param string|array|\Illuminate\Contracts\Database\Query\Expression $columns
|
||||||
|
* @param string $boolean
|
||||||
|
* @param bool $not
|
||||||
|
* @return \Illuminate\Database\Eloquent\Builder<static>
|
||||||
|
* @static
|
||||||
|
*/
|
||||||
|
DOC;
|
||||||
|
|
||||||
|
$this->assertSame($output, $method->getDocComment(''));
|
||||||
|
$this->assertSame('whereNull', $method->getName());
|
||||||
|
$this->assertSame('\\' . QueryBuilder::class, $method->getDeclaringClass());
|
||||||
|
$this->assertSame(['$columns', '$boolean', '$not'], $method->getParams(false));
|
||||||
|
$this->assertSame(['$columns', "\$boolean = 'and'", '$not = false'], $method->getParamsWithDefault(false));
|
||||||
|
$this->assertTrue($method->shouldReturn());
|
||||||
|
$this->assertSame('\Illuminate\Database\Eloquent\Builder<static>', rtrim($method->getReturnTag()->getType()));
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|||||||
+1
-7
@@ -57,13 +57,7 @@ abstract class TestCase extends BaseTestCase
|
|||||||
|
|
||||||
protected function mockFilesystem()
|
protected function mockFilesystem()
|
||||||
{
|
{
|
||||||
$mockFilesystem = Mockery::mock(Filesystem::class);
|
$mockFilesystem = Mockery::mock(Filesystem::class)->makePartial();
|
||||||
|
|
||||||
$mockFilesystem
|
|
||||||
->shouldReceive('get')
|
|
||||||
->andReturnUsing(function ($file) {
|
|
||||||
return file_get_contents($file);
|
|
||||||
});
|
|
||||||
|
|
||||||
$mockFilesystem
|
$mockFilesystem
|
||||||
->shouldReceive('put')
|
->shouldReceive('put')
|
||||||
|
|||||||
Reference in New Issue
Block a user