mirror of
https://github.com/barryvdh/laravel-ide-helper.git
synced 2026-08-18 01:57:13 +00:00
Compare commits
61
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
3d1998428e | ||
|
|
ef890b87ce | ||
|
|
232d7acf6f | ||
|
|
cff244b9b5 | ||
|
|
4dfc08a854 | ||
|
|
6c4ba2ad38 | ||
|
|
1815a6140a | ||
|
|
7c469e4073 | ||
|
|
ae0a06d406 | ||
|
|
e0b2f86326 | ||
|
|
cdefaeed42 | ||
|
|
c775aec1bb | ||
|
|
0fa96e572d | ||
|
|
8eec4f1ff5 | ||
|
|
d567978ebe | ||
|
|
09623f216c | ||
|
|
3d4e37798e | ||
|
|
713a4758f9 | ||
|
|
8d441ec99f | ||
|
|
dba153f1e0 | ||
|
|
40485e7350 | ||
|
|
ead24b10f6 | ||
|
|
187ce9beeb | ||
|
|
6b43ac616d | ||
|
|
980a87e250 | ||
|
|
299a81b9bb | ||
|
|
06c1fab9b5 | ||
|
|
271682a2a6 | ||
|
|
bb1caed698 | ||
|
|
55268cd47a | ||
|
|
088968c3fc | ||
|
|
655e057626 | ||
|
|
c8d85a0d34 | ||
|
|
4c656cc71d | ||
|
|
0fe9774dfb | ||
|
|
030f6f1f35 | ||
|
|
154300fb06 | ||
|
|
05d9c3cd65 | ||
|
|
beda399e7e | ||
|
|
0bbca8f5e2 | ||
|
|
f8381565ad | ||
|
|
cffcd07e98 | ||
|
|
9c6380da4a | ||
|
|
e509790805 | ||
|
|
791ba555f4 | ||
|
|
c324438731 | ||
|
|
4e4da0825a | ||
|
|
66ea6aa57b | ||
|
|
2a41415f01 | ||
|
|
a7fc73e8e4 | ||
|
|
f343efa140 | ||
|
|
0fa0403e57 | ||
|
|
97e3b5eaa0 | ||
|
|
99554aef3c | ||
|
|
0b2eeb4627 | ||
|
|
4ad74ba241 | ||
|
|
347483be03 | ||
|
|
14fdb572bb | ||
|
|
c33eacdefc | ||
|
|
a25b947851 | ||
|
|
59eb26742b |
@@ -20,7 +20,7 @@ jobs:
|
|||||||
fail-fast: false
|
fail-fast: false
|
||||||
matrix:
|
matrix:
|
||||||
php: [8.4, 8.3, 8.2]
|
php: [8.4, 8.3, 8.2]
|
||||||
laravel: [^11.15]
|
laravel: [11.x, 12.x]
|
||||||
|
|
||||||
name: P${{ matrix.php }} - Laravel${{ matrix.laravel }}
|
name: P${{ matrix.php }} - Laravel${{ matrix.laravel }}
|
||||||
steps:
|
steps:
|
||||||
|
|||||||
@@ -20,13 +20,18 @@ jobs:
|
|||||||
strategy:
|
strategy:
|
||||||
fail-fast: false
|
fail-fast: false
|
||||||
matrix:
|
matrix:
|
||||||
os: [ubuntu-22.04, windows-2019]
|
os: [ubuntu-latest]
|
||||||
php: [8.4, 8.3, 8.2]
|
php: [8.4, 8.3, 8.2]
|
||||||
laravel: [^11.15]
|
laravel: [~11.15, 12.x]
|
||||||
stability: [prefer-lowest, prefer-stable]
|
stability: [prefer-lowest, prefer-stable]
|
||||||
|
include:
|
||||||
|
- os: windows-latest
|
||||||
|
php: 8.3
|
||||||
|
laravel: 12.x
|
||||||
|
stability: prefer-stable
|
||||||
steps:
|
steps:
|
||||||
- name: Set git to use LF
|
- name: Set git to use LF
|
||||||
if: ${{ matrix.os == 'windows-2019' }}
|
if: ${{ matrix.os == 'windows-latest' }}
|
||||||
run: |
|
run: |
|
||||||
git config --global core.autocrlf false
|
git config --global core.autocrlf false
|
||||||
git config --global core.eol lf
|
git config --global core.eol lf
|
||||||
|
|||||||
+132
-1
@@ -1,5 +1,130 @@
|
|||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
|
## v3.5.5 - 2025-02-21
|
||||||
|
|
||||||
|
### What's Changed
|
||||||
|
|
||||||
|
* Fix for incorrect config item types in meta file by @eldair in https://github.com/barryvdh/laravel-ide-helper/pull/1662
|
||||||
|
* Prevent generation of incorrect property annotation by @skyler544 in https://github.com/barryvdh/laravel-ide-helper/pull/1665
|
||||||
|
* Fix MorphTo Model Doc Generation by @yparitcher in https://github.com/barryvdh/laravel-ide-helper/pull/1668
|
||||||
|
* Laravel 12 support by @jonnott in https://github.com/barryvdh/laravel-ide-helper/pull/1672
|
||||||
|
|
||||||
|
### New Contributors
|
||||||
|
|
||||||
|
* @eldair made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1662
|
||||||
|
* @skyler544 made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1665
|
||||||
|
* @yparitcher made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1668
|
||||||
|
* @jonnott made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1672
|
||||||
|
|
||||||
|
**Full Changelog**: https://github.com/barryvdh/laravel-ide-helper/compare/v3.5.4...v3.5.5
|
||||||
|
|
||||||
|
## v3.5.4 - 2025-01-14
|
||||||
|
|
||||||
|
### What's Changed
|
||||||
|
|
||||||
|
* Convert auth() helper to use Auth facade by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1656
|
||||||
|
* Check if returnType from docblock is not null by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1658
|
||||||
|
|
||||||
|
**Full Changelog**: https://github.com/barryvdh/laravel-ide-helper/compare/v3.5.3...v3.5.4
|
||||||
|
|
||||||
|
## v3.5.3 - 2025-01-08
|
||||||
|
|
||||||
|
### What's Changed
|
||||||
|
|
||||||
|
* Catch meta, tweak auth by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1654
|
||||||
|
* Check if macro is valid by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1655
|
||||||
|
* feat: use generics of return type to determine resulting models by @Bloemendaal in https://github.com/barryvdh/laravel-ide-helper/pull/1653
|
||||||
|
|
||||||
|
### New Contributors
|
||||||
|
|
||||||
|
* @Bloemendaal made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1653
|
||||||
|
|
||||||
|
**Full Changelog**: https://github.com/barryvdh/laravel-ide-helper/compare/v3.5.2...v3.5.3
|
||||||
|
|
||||||
|
## v3.5.2 - 2025-01-06
|
||||||
|
|
||||||
|
### Fixes
|
||||||
|
|
||||||
|
Fix empty/anonymous closure in meta command.
|
||||||
|
|
||||||
|
**Full Changelog**: https://github.com/barryvdh/laravel-ide-helper/compare/v3.5.1...v3.5.2
|
||||||
|
|
||||||
|
## v3.5.1 - 2025-01-06
|
||||||
|
|
||||||
|
### What's Changed
|
||||||
|
|
||||||
|
* Remove duplicate config, fix ->can() by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1650
|
||||||
|
|
||||||
|
**Full Changelog**: https://github.com/barryvdh/laravel-ide-helper/compare/v3.5.0...v3.5.1
|
||||||
|
|
||||||
|
## v3.5.0 - 2025-01-06
|
||||||
|
|
||||||
|
### What's Changed
|
||||||
|
|
||||||
|
* Add phpstorm meta argument hints by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1640
|
||||||
|
* Add meta override for user return types by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1642
|
||||||
|
* Use forked ContextFactory by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1643
|
||||||
|
* Remove php parser by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1644
|
||||||
|
* Also add eloquent template tags from base class by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1645
|
||||||
|
* Add more metadata by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1646
|
||||||
|
* Fixed generating PHPDoc for methods with class templates by @chack1172 in https://github.com/barryvdh/laravel-ide-helper/pull/1647
|
||||||
|
* Feat guess macro types by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1648
|
||||||
|
* Allow adding custom Macroable classes. by @mathieutu in https://github.com/barryvdh/laravel-ide-helper/pull/1629
|
||||||
|
* Add special `dev` to composer keywords by @jnoordsij in https://github.com/barryvdh/laravel-ide-helper/pull/1649
|
||||||
|
|
||||||
|
### New Contributors
|
||||||
|
|
||||||
|
* @chack1172 made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1647
|
||||||
|
* @mathieutu made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1629
|
||||||
|
* @jnoordsij made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1649
|
||||||
|
|
||||||
|
**Full Changelog**: https://github.com/barryvdh/laravel-ide-helper/compare/v3.4.0...v3.5.0
|
||||||
|
|
||||||
|
## v3.4.0 - 2024-12-29
|
||||||
|
|
||||||
|
### What's Changed
|
||||||
|
|
||||||
|
* fix: add @template TModel of static for Eloquent by @imzyf in https://github.com/barryvdh/laravel-ide-helper/pull/1631
|
||||||
|
* Add templates to Eloquent by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1634
|
||||||
|
* Update testsuite for Generator, simplify service provider and mock by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1635
|
||||||
|
* Add option for only eloquent by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1636
|
||||||
|
* Add weak generics for array type objects by @LauJosefsen in https://github.com/barryvdh/laravel-ide-helper/pull/1621
|
||||||
|
* Make all "note" in README apply quote style by @hms5232 in https://github.com/barryvdh/laravel-ide-helper/pull/1590
|
||||||
|
* Update README.md by @Mtillmann in https://github.com/barryvdh/laravel-ide-helper/pull/1587
|
||||||
|
* Rename view var by @barryvdh and @pb30 in https://github.com/barryvdh/laravel-ide-helper/pull/1637 and https://github.com/barryvdh/laravel-ide-helper/pull/1563
|
||||||
|
* Format IDE helper by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1638
|
||||||
|
* Add TLDR section, update options by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1639
|
||||||
|
|
||||||
|
### New Contributors
|
||||||
|
|
||||||
|
* @imzyf made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1631
|
||||||
|
* @LauJosefsen made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1621
|
||||||
|
* @hms5232 made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1590
|
||||||
|
* @Mtillmann made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1587
|
||||||
|
* @pb30 made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1563
|
||||||
|
|
||||||
|
**Full Changelog**: https://github.com/barryvdh/laravel-ide-helper/compare/v3.3.0...v3.4.0
|
||||||
|
|
||||||
|
## v3.3.0 - 2024-12-18
|
||||||
|
|
||||||
|
### What's Changed
|
||||||
|
|
||||||
|
* Feature: Add Config Option to Enforce Nullable Relationships by @jeramyhing in https://github.com/barryvdh/laravel-ide-helper/pull/1580
|
||||||
|
* Improve replacement of return type for methods from Query\Builder by @pjio in https://github.com/barryvdh/laravel-ide-helper/pull/1575
|
||||||
|
* Update CHANGELOG.md, fix typo(s) by @NicholasWilsonDEV in https://github.com/barryvdh/laravel-ide-helper/pull/1613
|
||||||
|
* 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
|
||||||
|
|
||||||
|
* @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
|
## v3.2.2 - 2024-10-29
|
||||||
|
|
||||||
### What’s Changed
|
### What’s Changed
|
||||||
@@ -35,13 +160,19 @@
|
|||||||
|
|
||||||
### 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)
|
|
||||||
|
|
||||||
|
- 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)
|
||||||
|
|
||||||
|
|
||||||
## 3.1.0 - 2024-07-12
|
## 3.1.0 - 2024-07-12
|
||||||
|
|
||||||
|
|||||||
@@ -11,7 +11,7 @@
|
|||||||
This package generates helper files that enable your IDE to provide accurate autocompletion.
|
This package generates helper files that enable your IDE to provide accurate autocompletion.
|
||||||
Generation is done based on the files in your project, so they are always up-to-date.
|
Generation is done based on the files in your project, so they are always up-to-date.
|
||||||
|
|
||||||
The 3.x branch supports Laravel 10 and 11. For older version, use the 2.x releases.
|
The 3.x branch supports Laravel 10 and later. For older version, use the 2.x releases.
|
||||||
|
|
||||||
- [Installation](#installation)
|
- [Installation](#installation)
|
||||||
- [Usage](#usage)
|
- [Usage](#usage)
|
||||||
@@ -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).
|
||||||
|
|
||||||
|
|||||||
+14
-14
@@ -11,7 +11,8 @@
|
|||||||
"netbeans",
|
"netbeans",
|
||||||
"sublime",
|
"sublime",
|
||||||
"codeintel",
|
"codeintel",
|
||||||
"phpdoc"
|
"phpdoc",
|
||||||
|
"dev"
|
||||||
],
|
],
|
||||||
"authors": [
|
"authors": [
|
||||||
{
|
{
|
||||||
@@ -22,25 +23,24 @@
|
|||||||
"require": {
|
"require": {
|
||||||
"php": "^8.2",
|
"php": "^8.2",
|
||||||
"ext-json": "*",
|
"ext-json": "*",
|
||||||
"barryvdh/reflection-docblock": "^2.1.2",
|
"barryvdh/reflection-docblock": "^2.3",
|
||||||
"composer/class-map-generator": "^1.0",
|
"composer/class-map-generator": "^1.0",
|
||||||
"illuminate/console": "^11.15",
|
"illuminate/console": "^11.15 || ^12",
|
||||||
"illuminate/database": "^11.15",
|
"illuminate/database": "^11.15 || ^12",
|
||||||
"illuminate/filesystem": "^11.15",
|
"illuminate/filesystem": "^11.15 || ^12",
|
||||||
"illuminate/support": "^11.15",
|
"illuminate/support": "^11.15 || ^12"
|
||||||
"nikic/php-parser": "^4.18 || ^5",
|
|
||||||
"phpdocumentor/type-resolver": "^1.1.0"
|
|
||||||
},
|
},
|
||||||
"require-dev": {
|
"require-dev": {
|
||||||
"ext-pdo_sqlite": "*",
|
"ext-pdo_sqlite": "*",
|
||||||
"friendsofphp/php-cs-fixer": "^3",
|
"friendsofphp/php-cs-fixer": "^3",
|
||||||
"illuminate/config": "^11.15",
|
"illuminate/config": "^11.15 || ^12",
|
||||||
"illuminate/view": "^11.15",
|
"illuminate/view": "^11.15 || ^12",
|
||||||
"mockery/mockery": "^1.4",
|
"mockery/mockery": "^1.4",
|
||||||
"orchestra/testbench": "^9.2",
|
"orchestra/testbench": "^9.2 || ^10",
|
||||||
"phpunit/phpunit": "^10.5",
|
"phpunit/phpunit": "^10.5 || ^11.5.3",
|
||||||
"spatie/phpunit-snapshot-assertions": "^4 || ^5",
|
"spatie/phpunit-snapshot-assertions": "^4 || ^5",
|
||||||
"vimeo/psalm": "^5.4"
|
"vimeo/psalm": "^5.4",
|
||||||
|
"vlucas/phpdotenv": "^5"
|
||||||
},
|
},
|
||||||
"suggest": {
|
"suggest": {
|
||||||
"illuminate/events": "Required for automatic helper generation (^6|^7|^8|^9|^10|^11)."
|
"illuminate/events": "Required for automatic helper generation (^6|^7|^8|^9|^10|^11)."
|
||||||
@@ -65,7 +65,7 @@
|
|||||||
},
|
},
|
||||||
"extra": {
|
"extra": {
|
||||||
"branch-alias": {
|
"branch-alias": {
|
||||||
"dev-master": "3.2-dev"
|
"dev-master": "3.5-dev"
|
||||||
},
|
},
|
||||||
"laravel": {
|
"laravel": {
|
||||||
"providers": [
|
"providers": [
|
||||||
|
|||||||
@@ -123,6 +123,7 @@ return [
|
|||||||
|
|
||||||
'helper_files' => [
|
'helper_files' => [
|
||||||
base_path() . '/vendor/laravel/framework/src/Illuminate/Support/helpers.php',
|
base_path() . '/vendor/laravel/framework/src/Illuminate/Support/helpers.php',
|
||||||
|
base_path() . '/vendor/laravel/framework/src/Illuminate/Foundation/helpers.php',
|
||||||
],
|
],
|
||||||
|
|
||||||
/*
|
/*
|
||||||
@@ -273,6 +274,20 @@ return [
|
|||||||
*/
|
*/
|
||||||
'use_generics_annotations' => true,
|
'use_generics_annotations' => true,
|
||||||
|
|
||||||
|
/*
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
| Default return types for macros
|
||||||
|
|--------------------------------------------------------------------------
|
||||||
|
|
|
||||||
|
| Define default return types for macros without explicit return types.
|
||||||
|
| e.g. `\Illuminate\Database\Query\Builder::class => 'static'`,
|
||||||
|
| `\Illuminate\Support\Str::class => 'string'`
|
||||||
|
|
|
||||||
|
*/
|
||||||
|
'macro_default_return_types' => [
|
||||||
|
Illuminate\Http\Client\Factory::class => Illuminate\Http\Client\PendingRequest::class,
|
||||||
|
],
|
||||||
|
|
||||||
/*
|
/*
|
||||||
|--------------------------------------------------------------------------
|
|--------------------------------------------------------------------------
|
||||||
| Additional relation types
|
| Additional relation types
|
||||||
|
|||||||
@@ -0,0 +1,21 @@
|
|||||||
|
The MIT License (MIT)
|
||||||
|
|
||||||
|
Copyright (c) Taylor Otwell
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in
|
||||||
|
all copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||||
|
THE SOFTWARE.
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
The templates here are based on the official VS Code extension by Laravel https://github.com/laravel/vs-code-extension
|
||||||
|
|
||||||
|
Modifications:
|
||||||
|
- return instead of echo
|
||||||
|
- do not serialize to JSON
|
||||||
@@ -0,0 +1,43 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
return collect(Illuminate\Support\Facades\Gate::abilities())
|
||||||
|
->map(function ($policy, $key) {
|
||||||
|
$reflection = new ReflectionFunction($policy);
|
||||||
|
|
||||||
|
$policyClass = null;
|
||||||
|
|
||||||
|
$closureThis = $reflection->getClosureThis();
|
||||||
|
if ($closureThis && get_class($closureThis) === Illuminate\Auth\Access\Gate::class) {
|
||||||
|
$vars = $reflection->getClosureUsedVariables();
|
||||||
|
|
||||||
|
if (isset($vars['callback'])) {
|
||||||
|
[$policyClass, $method] = explode('@', $vars['callback']);
|
||||||
|
|
||||||
|
$reflection = new ReflectionMethod($policyClass, $method);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return [
|
||||||
|
'key' => $key,
|
||||||
|
'uri' => $reflection->getFileName(),
|
||||||
|
'policy_class' => $policyClass,
|
||||||
|
'lineNumber' => $reflection->getStartLine(),
|
||||||
|
];
|
||||||
|
})
|
||||||
|
->merge(
|
||||||
|
collect(Illuminate\Support\Facades\Gate::policies())->flatMap(function ($policy, $model) {
|
||||||
|
$methods = (new ReflectionClass($policy))->getMethods();
|
||||||
|
|
||||||
|
return collect($methods)->map(function (ReflectionMethod $method) use ($policy) {
|
||||||
|
return [
|
||||||
|
'key' => $method->getName(),
|
||||||
|
'uri' => $method->getFileName(),
|
||||||
|
'policy_class' => $policy,
|
||||||
|
'lineNumber' => $method->getStartLine(),
|
||||||
|
];
|
||||||
|
})->filter(function ($ability) {
|
||||||
|
return !in_array($ability['key'], ['allow', 'deny']);
|
||||||
|
});
|
||||||
|
}),
|
||||||
|
)
|
||||||
|
->values()
|
||||||
|
->groupBy('key');
|
||||||
@@ -0,0 +1,131 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
$local = collect(glob(config_path('/*.php')))
|
||||||
|
->merge(glob(config_path('**/*.php')))
|
||||||
|
->map(fn ($path) => [
|
||||||
|
(string) Illuminate\Support\Str::of($path)
|
||||||
|
->replace([config_path('/'), '.php'], '')
|
||||||
|
->replace('/', '.'),
|
||||||
|
$path,
|
||||||
|
]);
|
||||||
|
|
||||||
|
$vendor = collect(glob(base_path('vendor/**/**/config/*.php')))->map(fn (
|
||||||
|
$path
|
||||||
|
) => [
|
||||||
|
(string) Illuminate\Support\Str::of($path)
|
||||||
|
->afterLast('/config/')
|
||||||
|
->replace('.php', '')
|
||||||
|
->replace('/', '.'),
|
||||||
|
$path,
|
||||||
|
]);
|
||||||
|
|
||||||
|
$configPaths = $local
|
||||||
|
->merge($vendor)
|
||||||
|
->groupBy(0)
|
||||||
|
->map(fn ($items) => $items->pluck(1));
|
||||||
|
|
||||||
|
$cachedContents = [];
|
||||||
|
$cachedParsed = [];
|
||||||
|
|
||||||
|
function vsCodeGetConfigValue($value, $key, $configPaths)
|
||||||
|
{
|
||||||
|
$parts = explode('.', $key);
|
||||||
|
$toFind = $key;
|
||||||
|
$found = null;
|
||||||
|
|
||||||
|
while (count($parts) > 0) {
|
||||||
|
array_pop($parts);
|
||||||
|
$toFind = implode('.', $parts);
|
||||||
|
|
||||||
|
if ($configPaths->has($toFind)) {
|
||||||
|
$found = $toFind;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($found === null) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
$file = null;
|
||||||
|
$line = null;
|
||||||
|
|
||||||
|
if ($found === $key) {
|
||||||
|
$file = $configPaths->get($found)[0];
|
||||||
|
} else {
|
||||||
|
foreach ($configPaths->get($found) as $path) {
|
||||||
|
$cachedContents[$path] ??= file_get_contents($path);
|
||||||
|
$cachedParsed[$path] ??= token_get_all($cachedContents[$path]);
|
||||||
|
|
||||||
|
$keysToFind = Illuminate\Support\Str::of($key)
|
||||||
|
->replaceFirst($found, '')
|
||||||
|
->ltrim('.')
|
||||||
|
->explode('.');
|
||||||
|
|
||||||
|
if (is_numeric($keysToFind->last())) {
|
||||||
|
$index = $keysToFind->pop();
|
||||||
|
|
||||||
|
if ($index !== '0') {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
$key = collect(explode('.', $key));
|
||||||
|
$key->pop();
|
||||||
|
$key = $key->implode('.');
|
||||||
|
$value = [];
|
||||||
|
}
|
||||||
|
|
||||||
|
$nextKey = $keysToFind->shift();
|
||||||
|
$expectedDepth = 1;
|
||||||
|
|
||||||
|
$depth = 0;
|
||||||
|
|
||||||
|
foreach ($cachedParsed[$path] as $token) {
|
||||||
|
if ($token === '[') {
|
||||||
|
$depth++;
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($token === ']') {
|
||||||
|
$depth--;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!is_array($token)) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
$str = trim($token[1], '"\'');
|
||||||
|
|
||||||
|
if (
|
||||||
|
$str === $nextKey &&
|
||||||
|
$depth === $expectedDepth &&
|
||||||
|
$token[0] === T_CONSTANT_ENCAPSED_STRING
|
||||||
|
) {
|
||||||
|
$nextKey = $keysToFind->shift();
|
||||||
|
$expectedDepth++;
|
||||||
|
|
||||||
|
if ($nextKey === null) {
|
||||||
|
$file = $path;
|
||||||
|
$line = $token[2];
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($file) {
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return [
|
||||||
|
'name' => $key,
|
||||||
|
'value' => $value,
|
||||||
|
'file' => $file === null ? null : str_replace(base_path('/'), '', $file),
|
||||||
|
'line' => $line,
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
return collect(Illuminate\Support\Arr::dot(config()->all()))
|
||||||
|
->map(fn ($value, $key) => vsCodeGetConfigValue($value, $key, $configPaths))
|
||||||
|
->filter()
|
||||||
|
->values();
|
||||||
@@ -0,0 +1,64 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
return collect(app("Illuminate\Contracts\Http\Kernel")->getMiddlewareGroups())
|
||||||
|
->merge(app("Illuminate\Contracts\Http\Kernel")->getRouteMiddleware())
|
||||||
|
->map(function ($middleware, $key) {
|
||||||
|
$result = [
|
||||||
|
'class' => null,
|
||||||
|
'uri' => null,
|
||||||
|
'startLine' => null,
|
||||||
|
'parameters' => null,
|
||||||
|
'groups' => [],
|
||||||
|
];
|
||||||
|
|
||||||
|
if (is_array($middleware)) {
|
||||||
|
$result['groups'] = collect($middleware)->map(function ($m) {
|
||||||
|
if (!class_exists($m)) {
|
||||||
|
return [
|
||||||
|
'class' => $m,
|
||||||
|
'uri' => null,
|
||||||
|
'startLine' => null,
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
$reflected = new ReflectionClass($m);
|
||||||
|
$reflectedMethod = $reflected->getMethod('handle');
|
||||||
|
|
||||||
|
return [
|
||||||
|
'class' => $m,
|
||||||
|
'uri' => $reflected->getFileName(),
|
||||||
|
'startLine' =>
|
||||||
|
$reflectedMethod->getFileName() === $reflected->getFileName()
|
||||||
|
? $reflectedMethod->getStartLine()
|
||||||
|
: null,
|
||||||
|
];
|
||||||
|
})->all();
|
||||||
|
|
||||||
|
return $result;
|
||||||
|
}
|
||||||
|
|
||||||
|
$reflected = new ReflectionClass($middleware);
|
||||||
|
$reflectedMethod = $reflected->getMethod('handle');
|
||||||
|
|
||||||
|
$result = array_merge($result, [
|
||||||
|
'class' => $middleware,
|
||||||
|
'uri' => $reflected->getFileName(),
|
||||||
|
'startLine' => $reflectedMethod->getStartLine(),
|
||||||
|
]);
|
||||||
|
|
||||||
|
$parameters = collect($reflectedMethod->getParameters())
|
||||||
|
->filter(function ($rc) {
|
||||||
|
return $rc->getName() !== 'request' && $rc->getName() !== 'next';
|
||||||
|
})
|
||||||
|
->map(function ($rc) {
|
||||||
|
return $rc->getName() . ($rc->isVariadic() ? '...' : '');
|
||||||
|
});
|
||||||
|
|
||||||
|
if ($parameters->isEmpty()) {
|
||||||
|
return $result;
|
||||||
|
}
|
||||||
|
|
||||||
|
return array_merge($result, [
|
||||||
|
'parameters' => $parameters->implode(','),
|
||||||
|
]);
|
||||||
|
});
|
||||||
@@ -0,0 +1,46 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
function vsCodeGetRouterReflection(Illuminate\Routing\Route $route)
|
||||||
|
{
|
||||||
|
if ($route->getActionName() === 'Closure') {
|
||||||
|
return new ReflectionFunction($route->getAction()['uses']);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!str_contains($route->getActionName(), '@')) {
|
||||||
|
return new ReflectionClass($route->getActionName());
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
return new ReflectionMethod($route->getControllerClass(), $route->getActionMethod());
|
||||||
|
} catch (Throwable $e) {
|
||||||
|
$namespace = app(Illuminate\Routing\UrlGenerator::class)->getRootControllerNamespace()
|
||||||
|
?? (app()->getNamespace() . 'Http\Controllers');
|
||||||
|
|
||||||
|
return new ReflectionMethod(
|
||||||
|
$namespace . '\\' . ltrim($route->getControllerClass(), '\\'),
|
||||||
|
$route->getActionMethod(),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return collect(app('router')->getRoutes()->getRoutes())
|
||||||
|
->map(function (Illuminate\Routing\Route $route) {
|
||||||
|
try {
|
||||||
|
$reflection = vsCodeGetRouterReflection($route);
|
||||||
|
} catch (Throwable $e) {
|
||||||
|
$reflection = null;
|
||||||
|
}
|
||||||
|
|
||||||
|
return [
|
||||||
|
'method' => collect($route->methods())->filter(function ($method) {
|
||||||
|
return $method !== 'HEAD';
|
||||||
|
})->implode('|'),
|
||||||
|
'uri' => $route->uri(),
|
||||||
|
'name' => $route->getName(),
|
||||||
|
'action' => $route->getActionName(),
|
||||||
|
'parameters' => $route->parameterNames(),
|
||||||
|
'filename' => $reflection ? $reflection->getFileName() : null,
|
||||||
|
'line' => $reflection ? $reflection->getStartLine() : null,
|
||||||
|
];
|
||||||
|
})
|
||||||
|
;
|
||||||
@@ -0,0 +1,161 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
function vsCodeGetTranslationsFromFile(Symfony\Component\Finder\SplFileInfo $file, $path, $namespace)
|
||||||
|
{
|
||||||
|
if ($file->getExtension() !== 'php') {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
$filePath = $file->getRealPath();
|
||||||
|
|
||||||
|
$relativePath = trim(str_replace($path, '', $file->getPath()), DIRECTORY_SEPARATOR);
|
||||||
|
$lang = explode(DIRECTORY_SEPARATOR, $relativePath)[0] ?? null;
|
||||||
|
|
||||||
|
if (!$lang) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
$keyPath = str_replace($path . DIRECTORY_SEPARATOR . $lang . DIRECTORY_SEPARATOR, '', $filePath);
|
||||||
|
$keyWithSlashes = str_replace('.php', '', $keyPath);
|
||||||
|
$baseKey = str_replace(DIRECTORY_SEPARATOR, '.', $keyWithSlashes);
|
||||||
|
|
||||||
|
if ($namespace) {
|
||||||
|
$baseKey = "{$namespace}::{$baseKey}";
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
$translations = require $filePath;
|
||||||
|
} catch (Throwable $e) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!is_array($translations)) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
$fileLines = Illuminate\Support\Facades\File::lines($filePath);
|
||||||
|
$lines = [];
|
||||||
|
$inComment = false;
|
||||||
|
|
||||||
|
foreach ($fileLines as $index => $line) {
|
||||||
|
$trimmed = trim($line);
|
||||||
|
if (str_starts_with($trimmed, '/*')) {
|
||||||
|
$inComment = true;
|
||||||
|
}
|
||||||
|
if ($inComment) {
|
||||||
|
if (str_ends_with($trimmed, '*/')) {
|
||||||
|
$inComment = false;
|
||||||
|
}
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
if (str_starts_with($trimmed, '//')) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
$lines[] = [$index + 1, $trimmed];
|
||||||
|
}
|
||||||
|
|
||||||
|
return [
|
||||||
|
'k' => $baseKey,
|
||||||
|
'la' => $lang,
|
||||||
|
'vs' => collect(Illuminate\Support\Arr::dot($translations))
|
||||||
|
->map(
|
||||||
|
fn ($value, $dotKey) => vsCodeTranslationValue(
|
||||||
|
$dotKey,
|
||||||
|
$value,
|
||||||
|
str_replace(base_path(DIRECTORY_SEPARATOR), '', $filePath),
|
||||||
|
$lines
|
||||||
|
)
|
||||||
|
)
|
||||||
|
->filter(),
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
function vsCodeTranslationValue($key, $value, $file, $lines): ?array
|
||||||
|
{
|
||||||
|
if (is_array($value)) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
$lineNumber = 1;
|
||||||
|
$keys = explode('.', $key);
|
||||||
|
$currentKey = array_shift($keys);
|
||||||
|
|
||||||
|
foreach ($lines as $line) {
|
||||||
|
if (
|
||||||
|
strpos($line[1], '"' . $currentKey . '"') !== false ||
|
||||||
|
strpos($line[1], "'" . $currentKey . "'") !== false
|
||||||
|
) {
|
||||||
|
$lineNumber = $line[0];
|
||||||
|
$currentKey = array_shift($keys);
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($currentKey === null) {
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return [
|
||||||
|
'v' => $value,
|
||||||
|
'p' => $file,
|
||||||
|
'li' => $lineNumber,
|
||||||
|
'pa' => preg_match_all("/\:([A-Za-z0-9_]+)/", $value, $matches)
|
||||||
|
? $matches[1]
|
||||||
|
: [],
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
function vscodeCollectTranslations(string $path, ?string $namespace = null)
|
||||||
|
{
|
||||||
|
$realPath = realpath($path);
|
||||||
|
|
||||||
|
if (!is_dir($realPath)) {
|
||||||
|
return collect();
|
||||||
|
}
|
||||||
|
|
||||||
|
return collect(Illuminate\Support\Facades\File::allFiles($realPath))
|
||||||
|
->map(fn ($file) => vsCodeGetTranslationsFromFile($file, $path, $namespace))
|
||||||
|
->filter();
|
||||||
|
}
|
||||||
|
|
||||||
|
$loader = app('translator')->getLoader();
|
||||||
|
$namespaces = $loader->namespaces();
|
||||||
|
|
||||||
|
$reflection = new ReflectionClass($loader);
|
||||||
|
$property = $reflection->hasProperty('paths')
|
||||||
|
? $reflection->getProperty('paths')
|
||||||
|
: $reflection->getProperty('path');
|
||||||
|
$property->setAccessible(true);
|
||||||
|
|
||||||
|
$paths = Illuminate\Support\Arr::wrap($property->getValue($loader));
|
||||||
|
|
||||||
|
$default = collect($paths)->flatMap(
|
||||||
|
fn ($path) => vscodeCollectTranslations($path)
|
||||||
|
);
|
||||||
|
|
||||||
|
$namespaced = collect($namespaces)->flatMap(
|
||||||
|
fn ($path, $namespace) => vscodeCollectTranslations($path, $namespace)
|
||||||
|
);
|
||||||
|
|
||||||
|
$final = [];
|
||||||
|
|
||||||
|
foreach ($default->merge($namespaced) as $value) {
|
||||||
|
if (!isset($value['vs']) || !is_iterable($value['vs'])) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
foreach ($value['vs'] as $key => $v) {
|
||||||
|
$dotKey = "{$value['k']}.{$key}";
|
||||||
|
|
||||||
|
if (!isset($final[$dotKey])) {
|
||||||
|
$final[$dotKey] = [];
|
||||||
|
}
|
||||||
|
|
||||||
|
$final[$dotKey][$value['la']] = $v;
|
||||||
|
|
||||||
|
if ($value['la'] === Illuminate\Support\Facades\App::currentLocale()) {
|
||||||
|
$final[$dotKey]['default'] = $v;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return collect($final);
|
||||||
@@ -0,0 +1,61 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
function vsCodeFindBladeFiles($path)
|
||||||
|
{
|
||||||
|
$paths = [];
|
||||||
|
|
||||||
|
if (!is_dir($path)) {
|
||||||
|
return $paths;
|
||||||
|
}
|
||||||
|
|
||||||
|
foreach (
|
||||||
|
Symfony\Component\Finder\Finder::create()
|
||||||
|
->files()
|
||||||
|
->name('*.blade.php')
|
||||||
|
->in($path) as $file
|
||||||
|
) {
|
||||||
|
$paths[] = [
|
||||||
|
'path' => str_replace(base_path(DIRECTORY_SEPARATOR), '', $file->getRealPath()),
|
||||||
|
'isVendor' => str_contains($file->getRealPath(), base_path('vendor')),
|
||||||
|
'key' => Illuminate\Support\Str::of($file->getRealPath())
|
||||||
|
->replace(realpath($path), '')
|
||||||
|
->replace('.blade.php', '')
|
||||||
|
->ltrim(DIRECTORY_SEPARATOR)
|
||||||
|
->replace(DIRECTORY_SEPARATOR, '.'),
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
return $paths;
|
||||||
|
}
|
||||||
|
$paths = collect(
|
||||||
|
app('view')
|
||||||
|
->getFinder()
|
||||||
|
->getPaths()
|
||||||
|
)->flatMap(function ($path) {
|
||||||
|
return vsCodeFindBladeFiles($path);
|
||||||
|
});
|
||||||
|
|
||||||
|
$hints = collect(
|
||||||
|
app('view')
|
||||||
|
->getFinder()
|
||||||
|
->getHints()
|
||||||
|
)->flatMap(function ($paths, $key) {
|
||||||
|
return collect($paths)->flatMap(function ($path) use ($key) {
|
||||||
|
return collect(vsCodeFindBladeFiles($path))->map(function ($value) use (
|
||||||
|
$key
|
||||||
|
) {
|
||||||
|
return array_merge($value, ['key' => "{$key}::{$value['key']}"]);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
[$local, $vendor] = $paths
|
||||||
|
->merge($hints)
|
||||||
|
->values()
|
||||||
|
->partition(function ($v) {
|
||||||
|
return !$v['isVendor'];
|
||||||
|
});
|
||||||
|
|
||||||
|
return $local
|
||||||
|
->sortBy('key', SORT_NATURAL)
|
||||||
|
->merge($vendor->sortBy('key', SORT_NATURAL));
|
||||||
+38
-31
@@ -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() ?><?php if ($alias->shouldExtendParentClass()): ?> extends <?= $alias->getParentClass() ?><?php endif; ?> {
|
||||||
<?= $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,29 +50,33 @@ 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; ?>
|
||||||
|
|
||||||
<?php foreach($real_time_facades as $name): ?>
|
<?php foreach ($real_time_facades as $name): ?>
|
||||||
<?php $nested = explode('\\', str_replace('\\' . class_basename($name), '', $name)); ?>
|
<?php $nested = explode('\\', str_replace('\\' . class_basename($name), '', $name)); ?>
|
||||||
namespace <?php echo implode('\\', $nested); ?> {
|
namespace <?php echo implode('\\', $nested); ?> {
|
||||||
/**
|
/**
|
||||||
|
|||||||
@@ -21,6 +21,20 @@ namespace PHPSTORM_META {
|
|||||||
]));
|
]));
|
||||||
<?php endforeach; ?>
|
<?php endforeach; ?>
|
||||||
|
|
||||||
|
<?php foreach ($userMethods as $method) : ?>
|
||||||
|
override(<?= $method ?>, map([
|
||||||
|
'' => \<?= $userModel ?>::class,
|
||||||
|
]));
|
||||||
|
<?php endforeach; ?>
|
||||||
|
|
||||||
|
<?php foreach ($configMethods as $method) : ?>
|
||||||
|
override(<?= $method ?>, map([
|
||||||
|
<?php foreach ($configValues as $name => $value) : ?>
|
||||||
|
'<?= $name ?>' => '<?= $value ?>',
|
||||||
|
<?php endforeach; ?>
|
||||||
|
]));
|
||||||
|
<?php endforeach; ?>
|
||||||
|
|
||||||
<?php if (count($factories)) : ?>
|
<?php if (count($factories)) : ?>
|
||||||
override(\factory(0), map([
|
override(\factory(0), map([
|
||||||
'' => '@FactoryBuilder',
|
'' => '@FactoryBuilder',
|
||||||
@@ -65,4 +79,31 @@ namespace PHPSTORM_META {
|
|||||||
override(\tap(0), type(0));
|
override(\tap(0), type(0));
|
||||||
override(\optional(0), type(0));
|
override(\optional(0), type(0));
|
||||||
|
|
||||||
|
<?php if (isset($expectedArgumentSets)): ?>
|
||||||
|
<?php foreach ($expectedArgumentSets as $name => $argumentsList) : ?>
|
||||||
|
registerArgumentsSet('<?= $name ?>', <?php foreach ($argumentsList as $i => $arg) : ?><?php if ($i % 5 == 0) {
|
||||||
|
echo "\n";
|
||||||
|
} ?><?= var_export($arg, true); ?>,<?php endforeach; ?>);
|
||||||
|
<?php endforeach; ?>
|
||||||
|
<?php endif ?>
|
||||||
|
|
||||||
|
<?php if (isset($expectedArguments)) : ?>
|
||||||
|
<?php foreach ($expectedArguments as $arguments) : ?>
|
||||||
|
<?php
|
||||||
|
$classes = isset($arguments['class']) ? (array) $arguments['class'] : [null];
|
||||||
|
$index = $arguments['index'] ?? 0;
|
||||||
|
$argumentSet = $arguments['argumentSet'];
|
||||||
|
$functions = [];
|
||||||
|
foreach ($classes as $class) {
|
||||||
|
foreach ((array) $arguments['method'] as $method) {
|
||||||
|
$functions[] = '\\' . ($class ? ltrim($class, '\\') . '::' : '') . $method . '()';
|
||||||
|
}
|
||||||
|
}
|
||||||
|
?>
|
||||||
|
<?php foreach ($functions as $function) : ?>
|
||||||
|
expectedArguments(<?= $function ?>, <?= $index ?>, argumentsSet('<?= $argumentSet ?>'));
|
||||||
|
<?php endforeach; ?>
|
||||||
|
<?php endforeach; ?>
|
||||||
|
<?php endif; ?>
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|||||||
+118
-6
@@ -13,13 +13,16 @@ namespace Barryvdh\LaravelIdeHelper;
|
|||||||
|
|
||||||
use Barryvdh\Reflection\DocBlock;
|
use Barryvdh\Reflection\DocBlock;
|
||||||
use Barryvdh\Reflection\DocBlock\Context;
|
use Barryvdh\Reflection\DocBlock\Context;
|
||||||
|
use Barryvdh\Reflection\DocBlock\ContextFactory;
|
||||||
use Barryvdh\Reflection\DocBlock\Serializer as DocBlockSerializer;
|
use Barryvdh\Reflection\DocBlock\Serializer as DocBlockSerializer;
|
||||||
use Barryvdh\Reflection\DocBlock\Tag\MethodTag;
|
use Barryvdh\Reflection\DocBlock\Tag\MethodTag;
|
||||||
|
use Barryvdh\Reflection\DocBlock\Tag\TemplateTag;
|
||||||
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\Database\Query\Builder as QueryBuilder;
|
||||||
use Illuminate\Support\Facades\Facade;
|
use Illuminate\Support\Facades\Facade;
|
||||||
|
use Illuminate\Support\Traits\Macroable;
|
||||||
use ReflectionClass;
|
use ReflectionClass;
|
||||||
use Throwable;
|
use Throwable;
|
||||||
|
|
||||||
@@ -34,6 +37,7 @@ class Alias
|
|||||||
protected $classType = 'class';
|
protected $classType = 'class';
|
||||||
protected $short;
|
protected $short;
|
||||||
protected $namespace = '__root';
|
protected $namespace = '__root';
|
||||||
|
protected $parentClass;
|
||||||
protected $root = null;
|
protected $root = null;
|
||||||
protected $classes = [];
|
protected $classes = [];
|
||||||
protected $methods = [];
|
protected $methods = [];
|
||||||
@@ -47,6 +51,9 @@ class Alias
|
|||||||
/** @var ConfigRepository */
|
/** @var ConfigRepository */
|
||||||
protected $config;
|
protected $config;
|
||||||
|
|
||||||
|
/** @var string[] */
|
||||||
|
protected $templateNames;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param ConfigRepository $config
|
* @param ConfigRepository $config
|
||||||
* @param string $alias
|
* @param string $alias
|
||||||
@@ -79,9 +86,15 @@ class Alias
|
|||||||
$this->detectNamespace();
|
$this->detectNamespace();
|
||||||
$this->detectClassType();
|
$this->detectClassType();
|
||||||
$this->detectExtendsNamespace();
|
$this->detectExtendsNamespace();
|
||||||
|
$this->detectParentClass();
|
||||||
|
|
||||||
if (!empty($this->namespace)) {
|
if (!empty($this->namespace)) {
|
||||||
$this->classAliases = (new UsesResolver())->loadFromClass($this->root);
|
try {
|
||||||
|
$this->classAliases = (new ContextFactory())->createFromReflector(new ReflectionClass($this->root))->getNamespaceAliases();
|
||||||
|
} 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));
|
||||||
@@ -158,6 +171,25 @@ class Alias
|
|||||||
return $this->extendsNamespace;
|
return $this->extendsNamespace;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the parent class of the class which this alias extends
|
||||||
|
*
|
||||||
|
* @return null|string
|
||||||
|
*/
|
||||||
|
public function getParentClass()
|
||||||
|
{
|
||||||
|
return $this->parentClass;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Check if this class should extend the parent class
|
||||||
|
*/
|
||||||
|
public function shouldExtendParentClass()
|
||||||
|
{
|
||||||
|
return $this->parentClass
|
||||||
|
&& $this->getExtendsNamespace() !== '\\Illuminate\\Support\\Facades';
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the Alias by which this class is called
|
* Get the Alias by which this class is called
|
||||||
*
|
*
|
||||||
@@ -255,6 +287,18 @@ class Alias
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Detect the parent class
|
||||||
|
*/
|
||||||
|
protected function detectParentClass()
|
||||||
|
{
|
||||||
|
$reflection = new ReflectionClass($this->root);
|
||||||
|
|
||||||
|
$parentClass = $reflection->getParentClass();
|
||||||
|
|
||||||
|
$this->parentClass = $parentClass ? '\\' . $parentClass->getName() : null;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Detect the class type
|
* Detect the class type
|
||||||
*/
|
*/
|
||||||
@@ -341,7 +385,8 @@ class Alias
|
|||||||
$magic,
|
$magic,
|
||||||
$this->interfaces,
|
$this->interfaces,
|
||||||
$this->classAliases,
|
$this->classAliases,
|
||||||
$this->getReturnTypeNormalizers($class)
|
$this->getReturnTypeNormalizers($class),
|
||||||
|
$this->getTemplateNames()
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
$this->usedMethods[] = $magic;
|
$this->usedMethods[] = $magic;
|
||||||
@@ -373,7 +418,8 @@ class Alias
|
|||||||
$method->name,
|
$method->name,
|
||||||
$this->interfaces,
|
$this->interfaces,
|
||||||
$this->classAliases,
|
$this->classAliases,
|
||||||
$this->getReturnTypeNormalizers($reflection)
|
$this->getReturnTypeNormalizers($reflection),
|
||||||
|
$this->getTemplateNames(),
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
$this->usedMethods[] = $method->name;
|
$this->usedMethods[] = $method->name;
|
||||||
@@ -383,15 +429,20 @@ class Alias
|
|||||||
|
|
||||||
// Check if the class is macroable
|
// Check if the class is macroable
|
||||||
// (Eloquent\Builder is also macroable but doesn't use Macroable trait)
|
// (Eloquent\Builder is also macroable but doesn't use Macroable trait)
|
||||||
$traits = collect($reflection->getTraitNames());
|
if ($class === EloquentBuilder::class || in_array(Macroable::class, $reflection->getTraitNames())) {
|
||||||
if ($traits->contains('Illuminate\Support\Traits\Macroable') || $class === EloquentBuilder::class) {
|
|
||||||
$properties = $reflection->getStaticProperties();
|
$properties = $reflection->getStaticProperties();
|
||||||
$macros = isset($properties['macros']) ? $properties['macros'] : [];
|
$macros = isset($properties['macros']) ? $properties['macros'] : [];
|
||||||
foreach ($macros as $macro_name => $macro_func) {
|
foreach ($macros as $macro_name => $macro_func) {
|
||||||
if (!in_array($macro_name, $this->usedMethods)) {
|
if (!in_array($macro_name, $this->usedMethods)) {
|
||||||
|
try {
|
||||||
|
$method = $this->getMacroFunction($macro_func);
|
||||||
|
} catch (Throwable $e) {
|
||||||
|
// Invalid method, skip
|
||||||
|
continue;
|
||||||
|
}
|
||||||
// Add macros
|
// Add macros
|
||||||
$this->methods[] = new Macro(
|
$this->methods[] = new Macro(
|
||||||
$this->getMacroFunction($macro_func),
|
$method,
|
||||||
$this->alias,
|
$this->alias,
|
||||||
$reflection,
|
$reflection,
|
||||||
$macro_name,
|
$macro_name,
|
||||||
@@ -468,6 +519,67 @@ class Alias
|
|||||||
return $serializer->getDocComment($this->phpdoc);
|
return $serializer->getDocComment($this->phpdoc);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param $prefix
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public function getPhpDocTemplates($prefix = "\t\t")
|
||||||
|
{
|
||||||
|
$templateDoc = new DocBlock('');
|
||||||
|
$serializer = new DocBlockSerializer(1, $prefix);
|
||||||
|
|
||||||
|
foreach ($this->getTemplateNames() as $templateName) {
|
||||||
|
$template = new TemplateTag('template', $templateName);
|
||||||
|
$template->setBound('static');
|
||||||
|
$template->setDocBlock($templateDoc);
|
||||||
|
$templateDoc->appendTag($template);
|
||||||
|
}
|
||||||
|
|
||||||
|
return $serializer->getDocComment($templateDoc);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return string[]
|
||||||
|
*/
|
||||||
|
public function getTemplateNames()
|
||||||
|
{
|
||||||
|
if (!isset($this->templateNames)) {
|
||||||
|
$this->detectTemplateNames();
|
||||||
|
}
|
||||||
|
return $this->templateNames;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return void
|
||||||
|
* @throws \ReflectionException
|
||||||
|
*/
|
||||||
|
protected function detectTemplateNames()
|
||||||
|
{
|
||||||
|
$templateNames = [];
|
||||||
|
foreach ($this->classes as $class) {
|
||||||
|
$reflection = new ReflectionClass($class);
|
||||||
|
$traits = collect($reflection->getTraitNames());
|
||||||
|
|
||||||
|
$phpdoc = new DocBlock($reflection);
|
||||||
|
$templates = $phpdoc->getTagsByName('template');
|
||||||
|
/** @var TemplateTag $template */
|
||||||
|
foreach ($templates as $template) {
|
||||||
|
$templateNames[] = $template->getTemplateName();
|
||||||
|
}
|
||||||
|
|
||||||
|
foreach ($traits as $trait) {
|
||||||
|
$phpdoc = new DocBlock(new ReflectionClass($trait));
|
||||||
|
$templates = $phpdoc->getTagsByName('template');
|
||||||
|
|
||||||
|
/** @var TemplateTag $template */
|
||||||
|
foreach ($templates as $template) {
|
||||||
|
$templateNames[] = $template->getTemplateName();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
$this->templateNames = $templateNames;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 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'],
|
||||||
];
|
];
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
+216
-24
@@ -12,7 +12,13 @@
|
|||||||
namespace Barryvdh\LaravelIdeHelper\Console;
|
namespace Barryvdh\LaravelIdeHelper\Console;
|
||||||
|
|
||||||
use Barryvdh\LaravelIdeHelper\Factories;
|
use Barryvdh\LaravelIdeHelper\Factories;
|
||||||
|
use Dotenv\Parser\Entry;
|
||||||
|
use Dotenv\Parser\Parser;
|
||||||
use Illuminate\Console\Command;
|
use Illuminate\Console\Command;
|
||||||
|
use Illuminate\Contracts\Config\Repository;
|
||||||
|
use Illuminate\Contracts\View\Factory;
|
||||||
|
use Illuminate\Filesystem\Filesystem;
|
||||||
|
use Illuminate\Support\Collection;
|
||||||
use RuntimeException;
|
use 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,34 +47,54 @@ 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 = [
|
||||||
'new \Illuminate\Contracts\Container\Container',
|
'new \Illuminate\Contracts\Container\Container',
|
||||||
'\Illuminate\Container\Container::makeWith(0)',
|
'\Illuminate\Container\Container::makeWith(0)',
|
||||||
'\Illuminate\Contracts\Container\Container::get(0)',
|
'\Illuminate\Contracts\Container\Container::get(0)',
|
||||||
'\Illuminate\Contracts\Container\Container::make(0)',
|
'\Illuminate\Contracts\Container\Container::make(0)',
|
||||||
'\Illuminate\Contracts\Container\Container::makeWith(0)',
|
'\Illuminate\Contracts\Container\Container::makeWith(0)',
|
||||||
'\App::get(0)',
|
'\App::get(0)',
|
||||||
'\App::make(0)',
|
'\App::make(0)',
|
||||||
'\App::makeWith(0)',
|
'\App::makeWith(0)',
|
||||||
'\app(0)',
|
'\app(0)',
|
||||||
'\resolve(0)',
|
'\resolve(0)',
|
||||||
'\Psr\Container\ContainerInterface::get(0)',
|
'\Psr\Container\ContainerInterface::get(0)',
|
||||||
];
|
];
|
||||||
|
|
||||||
|
protected $configMethods = [
|
||||||
|
'\config()',
|
||||||
|
'\Illuminate\Config\Repository::get()',
|
||||||
|
'\Illuminate\Support\Facades\Config::get()',
|
||||||
|
];
|
||||||
|
|
||||||
|
protected $userMethods = [
|
||||||
|
'\auth()->user()',
|
||||||
|
'\Illuminate\Contracts\Auth\Guard::user()',
|
||||||
|
'\Illuminate\Support\Facades\Auth::user()',
|
||||||
|
'\request()->user()',
|
||||||
|
'\Illuminate\Http\Request::user()',
|
||||||
|
'\Illuminate\Support\Facades\Request::user()',
|
||||||
|
];
|
||||||
|
|
||||||
|
protected $templateCache = [];
|
||||||
|
|
||||||
/**
|
/**
|
||||||
*
|
*
|
||||||
* @param \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;
|
||||||
@@ -102,7 +128,7 @@ class MetaCommand extends Command
|
|||||||
}
|
}
|
||||||
|
|
||||||
$reflectionClass = new \ReflectionClass($concrete);
|
$reflectionClass = new \ReflectionClass($concrete);
|
||||||
if (is_object($concrete) && !$reflectionClass->isAnonymous()) {
|
if (is_object($concrete) && !$reflectionClass->isAnonymous() && $abstract !== get_class($concrete)) {
|
||||||
$bindings[$abstract] = get_class($concrete);
|
$bindings[$abstract] = get_class($concrete);
|
||||||
}
|
}
|
||||||
} catch (\Throwable $e) {
|
} catch (\Throwable $e) {
|
||||||
@@ -114,10 +140,22 @@ class MetaCommand extends Command
|
|||||||
|
|
||||||
$this->unregisterClassAutoloadExceptions($ourAutoloader);
|
$this->unregisterClassAutoloadExceptions($ourAutoloader);
|
||||||
|
|
||||||
$content = $this->view->make('meta', [
|
$configValues = $this->loadTemplate('configs')->pluck('value', 'name')->map(function ($value, $key) {
|
||||||
'bindings' => $bindings,
|
return gettype($value);
|
||||||
'methods' => $this->methods,
|
});
|
||||||
'factories' => $factories,
|
|
||||||
|
$defaultUserModel = $this->config->get('auth.providers.users.model', $this->config->get('auth.model', 'App\User'));
|
||||||
|
|
||||||
|
$content = $this->view->make('ide-helper::meta', [
|
||||||
|
'bindings' => $bindings,
|
||||||
|
'methods' => $this->methods,
|
||||||
|
'factories' => $factories,
|
||||||
|
'configMethods' => $this->configMethods,
|
||||||
|
'configValues' => $configValues,
|
||||||
|
'expectedArgumentSets' => $this->getExpectedArgumentSets(),
|
||||||
|
'expectedArguments' => $this->getExpectedArguments(),
|
||||||
|
'userModel' => $defaultUserModel,
|
||||||
|
'userMethods' => $this->userMethods,
|
||||||
])->render();
|
])->render();
|
||||||
|
|
||||||
$filename = $this->option('filename');
|
$filename = $this->option('filename');
|
||||||
@@ -154,13 +192,152 @@ class MetaCommand extends Command
|
|||||||
*/
|
*/
|
||||||
protected function registerClassAutoloadExceptions(): callable
|
protected function registerClassAutoloadExceptions(): callable
|
||||||
{
|
{
|
||||||
$autoloader = function ($class) {
|
$aliases = array_filter([...$this->getAbstracts(), 'config'], fn ($abstract) => !str_contains($abstract, '\\'));
|
||||||
|
|
||||||
|
$autoloader = function ($class) use ($aliases) {
|
||||||
|
// ignore aliases as they're meant to be resolved elsewhere
|
||||||
|
if (in_array($class, $aliases, true)) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
throw new \ReflectionException("Class '$class' not found.");
|
throw new \ReflectionException("Class '$class' not found.");
|
||||||
};
|
};
|
||||||
|
|
||||||
spl_autoload_register($autoloader);
|
spl_autoload_register($autoloader);
|
||||||
|
|
||||||
return $autoloader;
|
return $autoloader;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
protected function getExpectedArgumentSets()
|
||||||
|
{
|
||||||
|
return [
|
||||||
|
'auth' => $this->loadTemplate('auth')->keys()->filter()->toArray(),
|
||||||
|
'configs' => $this->loadTemplate('configs')->pluck('name')->filter()->toArray(),
|
||||||
|
'middleware' => $this->loadTemplate('middleware')->keys()->filter()->toArray(),
|
||||||
|
'routes' => $this->loadTemplate('routes')->pluck('name')->filter()->toArray(),
|
||||||
|
'views' => $this->loadTemplate('views')->pluck('key')->filter()->map(function ($value) {
|
||||||
|
return (string) $value;
|
||||||
|
})->toArray(),
|
||||||
|
'translations' => $this->loadTemplate('translations')->filter()->keys()->toArray(),
|
||||||
|
'env' => $this->getEnv(),
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
protected function getExpectedArguments()
|
||||||
|
{
|
||||||
|
return [
|
||||||
|
[
|
||||||
|
'class' => '\Illuminate\Support\Facades\Gate',
|
||||||
|
'method' => [
|
||||||
|
'has',
|
||||||
|
'allows',
|
||||||
|
'denies',
|
||||||
|
'check',
|
||||||
|
'any',
|
||||||
|
'none',
|
||||||
|
'authorize',
|
||||||
|
'inspect',
|
||||||
|
],
|
||||||
|
'argumentSet' => 'auth',
|
||||||
|
],
|
||||||
|
[
|
||||||
|
'class' => ['\Illuminate\Support\Facades\Route', '\Illuminate\Support\Facades\Auth', 'Illuminate\Foundation\Auth\Access\Authorizable'],
|
||||||
|
'method' => ['can', 'cannot', 'cant'],
|
||||||
|
'argumentSet' => 'auth',
|
||||||
|
],
|
||||||
|
[
|
||||||
|
'class' => ['Illuminate\Contracts\Auth\Access\Authorizable'],
|
||||||
|
'method' => ['can'],
|
||||||
|
'argumentSet' => 'auth',
|
||||||
|
],
|
||||||
|
[
|
||||||
|
'class' => ['\Illuminate\Config\Repository', '\Illuminate\Support\Facades\Config'],
|
||||||
|
'method' => [
|
||||||
|
// 'get', // config() and Config::Get() are added with return type hints already
|
||||||
|
'getMany',
|
||||||
|
'set',
|
||||||
|
'string',
|
||||||
|
'integer',
|
||||||
|
'boolean',
|
||||||
|
'float',
|
||||||
|
'array',
|
||||||
|
'prepend',
|
||||||
|
'push',
|
||||||
|
],
|
||||||
|
'argumentSet' => 'configs',
|
||||||
|
],
|
||||||
|
[
|
||||||
|
'class' => ['\Illuminate\Support\Facades\Route', '\Illuminate\Routing\Router'],
|
||||||
|
'method' => ['middleware', 'withoutMiddleware'],
|
||||||
|
'argumentSet' => 'middleware',
|
||||||
|
],
|
||||||
|
[
|
||||||
|
'method' => ['route', 'to_route', 'signedRoute'],
|
||||||
|
'argumentSet' => 'routes',
|
||||||
|
],
|
||||||
|
[
|
||||||
|
'class' => [
|
||||||
|
'\Illuminate\Support\Facades\Redirect',
|
||||||
|
'\Illuminate\Support\Facades\URL',
|
||||||
|
'\Illuminate\Routing\Redirector',
|
||||||
|
'\Illuminate\Routing\UrlGenerator',
|
||||||
|
],
|
||||||
|
'method' => ['route', 'signedRoute', 'temporarySignedRoute'],
|
||||||
|
'argumentSet' => 'routes',
|
||||||
|
],
|
||||||
|
[
|
||||||
|
'method' => 'view',
|
||||||
|
'argumentSet' => 'views',
|
||||||
|
],
|
||||||
|
[
|
||||||
|
'class' => ['\Illuminate\Support\Facades\View', '\Illuminate\View\Factory'],
|
||||||
|
'method' => 'make',
|
||||||
|
'argumentSet' => 'views',
|
||||||
|
],
|
||||||
|
[
|
||||||
|
'method' => ['__', 'trans'],
|
||||||
|
'argumentSet' => 'translations',
|
||||||
|
],
|
||||||
|
[
|
||||||
|
'class' => ['\Illuminate\Contracts\Translation\Translator'],
|
||||||
|
'method' => ['get'],
|
||||||
|
'argumentSet' => 'translations',
|
||||||
|
],
|
||||||
|
[
|
||||||
|
'method' => 'env',
|
||||||
|
'argumentSet' => 'env',
|
||||||
|
],
|
||||||
|
[
|
||||||
|
'class' => '\Illuminate\Support\Env',
|
||||||
|
'method' => 'get',
|
||||||
|
'argumentSet' => 'env',
|
||||||
|
],
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return Collection
|
||||||
|
*/
|
||||||
|
protected function loadTemplate($name)
|
||||||
|
{
|
||||||
|
if (!isset($this->templateCache[$name])) {
|
||||||
|
$file = __DIR__ . '/../../php-templates/' . basename($name) . '.php';
|
||||||
|
try {
|
||||||
|
$value = $this->files->requireOnce($file) ?: [];
|
||||||
|
} catch (\Throwable $e) {
|
||||||
|
$value = [];
|
||||||
|
$this->warn('Cannot load template for ' . $name . ': ' . $e->getMessage());
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!$value instanceof Collection) {
|
||||||
|
$value = collect($value);
|
||||||
|
}
|
||||||
|
$this->templateCache[$name] = $value;
|
||||||
|
}
|
||||||
|
|
||||||
|
return $this->templateCache[$name];
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the console command options.
|
* Get the console command options.
|
||||||
*
|
*
|
||||||
@@ -175,6 +352,21 @@ class MetaCommand extends Command
|
|||||||
];
|
];
|
||||||
}
|
}
|
||||||
|
|
||||||
|
protected function getEnv()
|
||||||
|
{
|
||||||
|
$envPath = base_path('.env');
|
||||||
|
if (!file_exists($envPath)) {
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
|
||||||
|
$parser = new Parser();
|
||||||
|
$entries = $parser->parse(file_get_contents($envPath));
|
||||||
|
|
||||||
|
return collect($entries)->map(function (Entry $entry) {
|
||||||
|
return $entry->getName();
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Remove our custom autoloader that we pushed onto the autoload stack
|
* Remove our custom autoloader that we pushed onto the autoload stack
|
||||||
*
|
*
|
||||||
|
|||||||
@@ -12,13 +12,16 @@
|
|||||||
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;
|
||||||
|
use Barryvdh\Reflection\DocBlock\ContextFactory;
|
||||||
use Barryvdh\Reflection\DocBlock\Serializer as DocBlockSerializer;
|
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,7 +49,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 phpDocumentor\Reflection\Types\ContextFactory;
|
use Illuminate\View\Factory as ViewFactory;
|
||||||
use ReflectionClass;
|
use ReflectionClass;
|
||||||
use ReflectionNamedType;
|
use ReflectionNamedType;
|
||||||
use ReflectionObject;
|
use ReflectionObject;
|
||||||
@@ -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 = '\Illuminate\Database\Eloquent\Casts\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
|
||||||
@@ -438,7 +475,11 @@ class ModelsCommand extends Command
|
|||||||
}
|
}
|
||||||
|
|
||||||
if (Str::startsWith($type, AsCollection::class)) {
|
if (Str::startsWith($type, AsCollection::class)) {
|
||||||
$realType = $this->getTypeInModel($model, $params[0] ?? null) ?? '\Illuminate\Support\Collection';
|
$realType = $this->getTypeInModel($model, $params[0] ?? null) ?: '\Illuminate\Support\Collection';
|
||||||
|
$relatedModel = $this->getTypeInModel($model, $params[1] ?? null);
|
||||||
|
if ($relatedModel) {
|
||||||
|
$realType = $this->getCollectionTypeHint($realType, $relatedModel);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
if (Str::startsWith($type, AsEnumCollection::class)) {
|
if (Str::startsWith($type, AsEnumCollection::class)) {
|
||||||
@@ -591,6 +632,10 @@ class ModelsCommand extends Command
|
|||||||
)
|
)
|
||||||
);
|
);
|
||||||
});
|
});
|
||||||
|
// https://github.com/barryvdh/laravel-ide-helper/issues/1664
|
||||||
|
$reflections = array_filter($reflections, function (\ReflectionMethod $methodReflection) {
|
||||||
|
return !($methodReflection->getName() === 'getUseFactoryAttribute');
|
||||||
|
});
|
||||||
sort($reflections);
|
sort($reflections);
|
||||||
foreach ($reflections as $reflection) {
|
foreach ($reflections as $reflection) {
|
||||||
$type = $this->getReturnTypeFromReflection($reflection);
|
$type = $this->getReturnTypeFromReflection($reflection);
|
||||||
@@ -628,9 +673,11 @@ class ModelsCommand extends Command
|
|||||||
$comment = $this->getCommentFromDocBlock($reflection);
|
$comment = $this->getCommentFromDocBlock($reflection);
|
||||||
$this->setProperty($name, null, null, true, $comment);
|
$this->setProperty($name, null, null, true, $comment);
|
||||||
}
|
}
|
||||||
} elseif (Str::startsWith($method, 'scope') && $method !== 'scopeQuery' && $method !== 'scope' && $method !== 'scopes') {
|
} elseif (!empty($reflection->getAttributes('Illuminate\Database\Eloquent\Attributes\Scope')) || (Str::startsWith($method, 'scope') && $method !== 'scopeQuery' && $method !== 'scope' && $method !== 'scopes')) {
|
||||||
|
$scopeUsingAttribute = !empty($reflection->getAttributes('Illuminate\Database\Eloquent\Attributes\Scope'));
|
||||||
|
|
||||||
//Magic scope<name>Attribute
|
//Magic scope<name>Attribute
|
||||||
$name = Str::camel(substr($method, 5));
|
$name = $scopeUsingAttribute ? $method : Str::camel(substr($method, 5));
|
||||||
if (!empty($name)) {
|
if (!empty($name)) {
|
||||||
$comment = $this->getCommentFromDocBlock($reflection);
|
$comment = $this->getCommentFromDocBlock($reflection);
|
||||||
$args = $this->getParameters($reflection);
|
$args = $this->getParameters($reflection);
|
||||||
@@ -782,10 +829,16 @@ class ModelsCommand extends Command
|
|||||||
$relation === 'morphTo'
|
$relation === 'morphTo'
|
||||||
)
|
)
|
||||||
) {
|
) {
|
||||||
|
$matches = [];
|
||||||
|
$returnType = $this->getReturnTypeFromDocBlock($reflection);
|
||||||
|
if ($returnType !== null) {
|
||||||
|
preg_match('/MorphTo<(?:contravariant\s+)?(.+?)(?:,|>)/i', $returnType, $matches);
|
||||||
|
}
|
||||||
|
|
||||||
// Model isn't specified because relation is polymorphic
|
// Model isn't specified because relation is polymorphic
|
||||||
$this->setProperty(
|
$this->setProperty(
|
||||||
$method,
|
$method,
|
||||||
$this->getClassNameInDestinationFile($model, Model::class) . '|\Eloquent',
|
$matches[1] ?? $this->getClassNameInDestinationFile($model, Model::class) . '|\Eloquent',
|
||||||
true,
|
true,
|
||||||
null,
|
null,
|
||||||
$comment,
|
$comment,
|
||||||
@@ -1137,7 +1190,7 @@ class ModelsCommand extends Command
|
|||||||
$default = '[]';
|
$default = '[]';
|
||||||
} elseif (is_null($default)) {
|
} elseif (is_null($default)) {
|
||||||
$default = 'null';
|
$default = 'null';
|
||||||
} elseif (is_int($default)) {
|
} elseif (is_int($default) || is_float($default)) {
|
||||||
//$default = $default;
|
//$default = $default;
|
||||||
} elseif ($default instanceof \UnitEnum) {
|
} elseif ($default instanceof \UnitEnum) {
|
||||||
$default = '\\' . get_class($default) . '::' . $default->name;
|
$default = '\\' . get_class($default) . '::' . $default->name;
|
||||||
@@ -1358,7 +1411,7 @@ class ModelsCommand extends Command
|
|||||||
if (in_array('Illuminate\\Database\\Eloquent\\SoftDeletes', $traits)) {
|
if (in_array('Illuminate\\Database\\Eloquent\\SoftDeletes', $traits)) {
|
||||||
$modelName = $this->getClassNameInDestinationFile($model, get_class($model));
|
$modelName = $this->getClassNameInDestinationFile($model, get_class($model));
|
||||||
$builder = $this->getClassNameInDestinationFile($model, \Illuminate\Database\Eloquent\Builder::class);
|
$builder = $this->getClassNameInDestinationFile($model, \Illuminate\Database\Eloquent\Builder::class);
|
||||||
$this->setMethod('withTrashed', $builder . '<static>|' . $modelName, []);
|
$this->setMethod('withTrashed', $builder . '<static>|' . $modelName, ['bool $withTrashed = true']);
|
||||||
$this->setMethod('withoutTrashed', $builder . '<static>|' . $modelName, []);
|
$this->setMethod('withoutTrashed', $builder . '<static>|' . $modelName, []);
|
||||||
$this->setMethod('onlyTrashed', $builder . '<static>|' . $modelName, []);
|
$this->setMethod('onlyTrashed', $builder . '<static>|' . $modelName, []);
|
||||||
}
|
}
|
||||||
@@ -1534,7 +1587,9 @@ class ModelsCommand extends Command
|
|||||||
*/
|
*/
|
||||||
protected function getUsedClassNames(ReflectionClass $reflection): array
|
protected function getUsedClassNames(ReflectionClass $reflection): array
|
||||||
{
|
{
|
||||||
$namespaceAliases = array_flip((new ContextFactory())->createFromReflector($reflection)->getNamespaceAliases());
|
$namespaceAliases = array_flip(array_map(function ($alias) {
|
||||||
|
return ltrim($alias, '\\');
|
||||||
|
}, (new ContextFactory())->createFromReflector($reflection)->getNamespaceAliases()));
|
||||||
$namespaceAliases[$reflection->getName()] = $reflection->getShortName();
|
$namespaceAliases[$reflection->getName()] = $reflection->getShortName();
|
||||||
|
|
||||||
return $namespaceAliases;
|
return $namespaceAliases;
|
||||||
|
|||||||
+67
-30
@@ -11,15 +11,12 @@
|
|||||||
|
|
||||||
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;
|
||||||
use Illuminate\Support\Str;
|
use Illuminate\Support\Str;
|
||||||
use Illuminate\Support\Traits\Macroable;
|
use Illuminate\Support\Traits\Macroable;
|
||||||
use PhpParser\Lexer\Emulative;
|
|
||||||
use PhpParser\Node\Stmt\Class_;
|
|
||||||
use PhpParser\Node\Stmt\Namespace_;
|
|
||||||
use PhpParser\Parser\Php7;
|
|
||||||
use ReflectionClass;
|
use ReflectionClass;
|
||||||
use Symfony\Component\Console\Output\OutputInterface;
|
use Symfony\Component\Console\Output\OutputInterface;
|
||||||
|
|
||||||
@@ -60,9 +57,13 @@ class Generator
|
|||||||
// Find the drivers to add to the extra/interfaces
|
// Find the drivers to add to the extra/interfaces
|
||||||
$this->detectDrivers();
|
$this->detectDrivers();
|
||||||
|
|
||||||
$this->extra = array_merge($this->extra, $this->config->get('ide-helper.extra'), []);
|
$this->extra = array_merge($this->extra, $this->config->get('ide-helper.extra', []));
|
||||||
$this->magic = array_merge($this->magic, $this->config->get('ide-helper.magic'), []);
|
$this->magic = array_merge($this->magic, $this->config->get('ide-helper.magic', []));
|
||||||
$this->interfaces = array_merge($this->interfaces, $this->config->get('ide-helper.interfaces'), []);
|
$this->interfaces = array_merge($this->interfaces, $this->config->get('ide-helper.interfaces', []));
|
||||||
|
Macro::setDefaultReturnTypes($this->config->get('ide-helper.macro_default_return_types', [
|
||||||
|
\Illuminate\Http\Client\Factory::class => \Illuminate\Http\Client\PendingRequest::class,
|
||||||
|
]));
|
||||||
|
|
||||||
// Make all interface classes absolute
|
// Make all interface classes absolute
|
||||||
foreach ($this->interfaces as &$interface) {
|
foreach ($this->interfaces as &$interface) {
|
||||||
$interface = '\\' . ltrim($interface, '\\');
|
$interface = '\\' . ltrim($interface, '\\');
|
||||||
@@ -78,17 +79,60 @@ class Generator
|
|||||||
public function generate()
|
public function generate()
|
||||||
{
|
{
|
||||||
$app = app();
|
$app = app();
|
||||||
return $this->view->make('helper')
|
return $this->view->make('ide-helper::helper')
|
||||||
->with('namespaces_by_extends_ns', $this->getAliasesByExtendsNamespace())
|
->with('namespaces_by_extends_ns', $this->getAliasesByExtendsNamespace())
|
||||||
->with('namespaces_by_alias_ns', $this->getAliasesByAliasNamespace())
|
->with('namespaces_by_alias_ns', $this->getAliasesByAliasNamespace())
|
||||||
->with('real_time_facades', $this->getRealTimeFacades())
|
->with('real_time_facades', $this->getRealTimeFacades())
|
||||||
->with('helpers', $this->helpers)
|
->with('helpers', $this->detectHelpers())
|
||||||
->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('ide-helper::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 detectHelpers()
|
||||||
|
{
|
||||||
|
$helpers = $this->helpers;
|
||||||
|
|
||||||
|
$replacements = [
|
||||||
|
'($guard is null ? \Illuminate\Contracts\Auth\Factory : \Illuminate\Contracts\Auth\StatefulGuard)' => '\\Auth',
|
||||||
|
];
|
||||||
|
foreach ($replacements as $search => $replace) {
|
||||||
|
$helpers = Str::replace(
|
||||||
|
"@return {$search}",
|
||||||
|
"@return $replace|$search",
|
||||||
|
$helpers
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
return $helpers;
|
||||||
|
}
|
||||||
|
|
||||||
protected function detectDrivers()
|
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'));
|
||||||
@@ -187,8 +231,10 @@ class Generator
|
|||||||
foreach ($realTimeFacadeFiles as $file) {
|
foreach ($realTimeFacadeFiles as $file) {
|
||||||
try {
|
try {
|
||||||
$name = $this->getFullyQualifiedClassNameInFile($file);
|
$name = $this->getFullyQualifiedClassNameInFile($file);
|
||||||
$facades[$name] = $name;
|
if ($name) {
|
||||||
} catch (\Exception $e) {
|
$facades[$name] = $name;
|
||||||
|
}
|
||||||
|
} catch (\Throwable $e) {
|
||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -200,26 +246,17 @@ class Generator
|
|||||||
{
|
{
|
||||||
$contents = file_get_contents($path);
|
$contents = file_get_contents($path);
|
||||||
|
|
||||||
$parsers = new Php7(new Emulative());
|
// Match namespace
|
||||||
|
preg_match('/namespace\s+([^;]+);/', $contents, $namespaceMatch);
|
||||||
|
$namespace = isset($namespaceMatch[1]) ? $namespaceMatch[1] : '';
|
||||||
|
|
||||||
$parsed = collect($parsers->parse($contents) ?: []);
|
// Match class name
|
||||||
|
preg_match('/class\s+([a-zA-Z0-9_]+)/', $contents, $classMatch);
|
||||||
|
$className = isset($classMatch[1]) ? $classMatch[1] : '';
|
||||||
|
|
||||||
$namespace = $parsed->first(function ($node) {
|
// Combine namespace and class name
|
||||||
return $node instanceof Namespace_;
|
if ($namespace && $className) {
|
||||||
});
|
return $namespace . '\\' . $className;
|
||||||
|
|
||||||
if ($namespace) {
|
|
||||||
$name = $namespace->name->toString();
|
|
||||||
|
|
||||||
$class = collect($namespace->stmts)->first(function ($node) {
|
|
||||||
return $node instanceof Class_;
|
|
||||||
});
|
|
||||||
|
|
||||||
if ($class) {
|
|
||||||
$name .= '\\' . $class->name->toString();
|
|
||||||
}
|
|
||||||
|
|
||||||
return $name;
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -20,10 +20,6 @@ use Illuminate\Console\Events\CommandFinished;
|
|||||||
use Illuminate\Contracts\Support\DeferrableProvider;
|
use Illuminate\Contracts\Support\DeferrableProvider;
|
||||||
use Illuminate\Database\Events\MigrationsEnded;
|
use Illuminate\Database\Events\MigrationsEnded;
|
||||||
use Illuminate\Support\ServiceProvider;
|
use Illuminate\Support\ServiceProvider;
|
||||||
use Illuminate\View\Engines\EngineResolver;
|
|
||||||
use Illuminate\View\Engines\PhpEngine;
|
|
||||||
use Illuminate\View\Factory;
|
|
||||||
use Illuminate\View\FileViewFinder;
|
|
||||||
|
|
||||||
class IdeHelperServiceProvider extends ServiceProvider implements DeferrableProvider
|
class IdeHelperServiceProvider extends ServiceProvider implements DeferrableProvider
|
||||||
{
|
{
|
||||||
@@ -64,41 +60,14 @@ 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(
|
|
||||||
'command.ide-helper.generate',
|
|
||||||
function ($app) use ($localViewFactory) {
|
|
||||||
return new GeneratorCommand($app['config'], $app['files'], $localViewFactory);
|
|
||||||
}
|
|
||||||
);
|
|
||||||
|
|
||||||
$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,22 +78,11 @@ 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,
|
||||||
* @return Factory
|
EloquentCommand::class,
|
||||||
*/
|
];
|
||||||
private function createLocalViewFactory()
|
|
||||||
{
|
|
||||||
$resolver = new EngineResolver();
|
|
||||||
$resolver->register('php', function () {
|
|
||||||
return new PhpEngine($this->app['files']);
|
|
||||||
});
|
|
||||||
$finder = new FileViewFinder($this->app['files'], [__DIR__ . '/../resources/views']);
|
|
||||||
$factory = new Factory($resolver, $finder, $this->app['events']);
|
|
||||||
$factory->addExtension('php', 'php');
|
|
||||||
|
|
||||||
return $factory;
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -9,6 +9,8 @@ use Illuminate\Support\Collection;
|
|||||||
|
|
||||||
class Macro extends Method
|
class Macro extends Method
|
||||||
{
|
{
|
||||||
|
protected static $macroDefaults = [];
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Macro constructor.
|
* Macro constructor.
|
||||||
*
|
*
|
||||||
@@ -32,6 +34,10 @@ class Macro extends Method
|
|||||||
parent::__construct($method, $alias, $class, $methodName, $interfaces, $classAliases, $returnTypeNormalizers);
|
parent::__construct($method, $alias, $class, $methodName, $interfaces, $classAliases, $returnTypeNormalizers);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public static function setDefaultReturnTypes(array $map = [])
|
||||||
|
{
|
||||||
|
static::$macroDefaults = array_merge(static::$macroDefaults, $map);
|
||||||
|
}
|
||||||
/**
|
/**
|
||||||
* @param \ReflectionFunctionAbstract $method
|
* @param \ReflectionFunctionAbstract $method
|
||||||
*/
|
*/
|
||||||
@@ -77,6 +83,12 @@ class Macro extends Method
|
|||||||
|
|
||||||
$this->phpdoc->appendTag(Tag::createInstance("@return {$type}"));
|
$this->phpdoc->appendTag(Tag::createInstance("@return {$type}"));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
$class = ltrim($this->declaringClassName, '\\');
|
||||||
|
if (!$this->phpdoc->hasTag('return') && isset(static::$macroDefaults[$class])) {
|
||||||
|
$type = static::$macroDefaults[$class];
|
||||||
|
$this->phpdoc->appendTag(Tag::createInstance("@return {$type}"));
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
protected function concatReflectionTypes(?\ReflectionType $type): string
|
protected function concatReflectionTypes(?\ReflectionType $type): string
|
||||||
|
|||||||
+8
-3
@@ -39,6 +39,9 @@ class Method
|
|||||||
protected $classAliases;
|
protected $classAliases;
|
||||||
protected $returnTypeNormalizers;
|
protected $returnTypeNormalizers;
|
||||||
|
|
||||||
|
/** @var string[] */
|
||||||
|
protected $templateNames = [];
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param \ReflectionMethod|\ReflectionFunctionAbstract $method
|
* @param \ReflectionMethod|\ReflectionFunctionAbstract $method
|
||||||
* @param string $alias
|
* @param string $alias
|
||||||
@@ -47,8 +50,9 @@ class Method
|
|||||||
* @param array $interfaces
|
* @param array $interfaces
|
||||||
* @param array $classAliases
|
* @param array $classAliases
|
||||||
* @param array $returnTypeNormalizers
|
* @param array $returnTypeNormalizers
|
||||||
|
* @param string[] $templateNames
|
||||||
*/
|
*/
|
||||||
public function __construct($method, $alias, $class, $methodName = null, $interfaces = [], array $classAliases = [], array $returnTypeNormalizers = [])
|
public function __construct($method, $alias, $class, $methodName = null, $interfaces = [], array $classAliases = [], array $returnTypeNormalizers = [], array $templateNames = [])
|
||||||
{
|
{
|
||||||
$this->method = $method;
|
$this->method = $method;
|
||||||
$this->interfaces = $interfaces;
|
$this->interfaces = $interfaces;
|
||||||
@@ -56,6 +60,7 @@ class Method
|
|||||||
$this->returnTypeNormalizers = $returnTypeNormalizers;
|
$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->templateNames = $templateNames;
|
||||||
$this->initClassDefinedProperties($method, $class);
|
$this->initClassDefinedProperties($method, $class);
|
||||||
|
|
||||||
//Reference the 'real' function in the declaring class
|
//Reference the 'real' function in the declaring class
|
||||||
@@ -84,7 +89,7 @@ class Method
|
|||||||
*/
|
*/
|
||||||
protected function initPhpDoc($method)
|
protected function initPhpDoc($method)
|
||||||
{
|
{
|
||||||
$this->phpdoc = new DocBlock($method, new Context($this->namespace, $this->classAliases));
|
$this->phpdoc = new DocBlock($method, new Context($this->namespace, $this->classAliases, generics: $this->templateNames));
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -386,7 +391,7 @@ class Method
|
|||||||
}
|
}
|
||||||
if ($method) {
|
if ($method) {
|
||||||
$namespace = $method->getDeclaringClass()->getNamespaceName();
|
$namespace = $method->getDeclaringClass()->getNamespaceName();
|
||||||
$phpdoc = new DocBlock($method, new Context($namespace, $this->classAliases));
|
$phpdoc = new DocBlock($method, new Context($namespace, $this->classAliases, generics: $this->templateNames));
|
||||||
|
|
||||||
if (strpos($phpdoc->getText(), '{@inheritdoc}') !== false) {
|
if (strpos($phpdoc->getText(), '{@inheritdoc}') !== false) {
|
||||||
//Not at the end yet, try another parent/interface..
|
//Not at the end yet, try another parent/interface..
|
||||||
|
|||||||
@@ -1,124 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Laravel IDE Helper Generator
|
|
||||||
*
|
|
||||||
* @author Barry vd. Heuvel <barryvdh@gmail.com>
|
|
||||||
* @copyright 2014 Barry vd. Heuvel / Fruitcake Studio (http://www.fruitcakestudio.nl)
|
|
||||||
* @license http://www.opensource.org/licenses/mit-license.php MIT
|
|
||||||
* @link https://github.com/barryvdh/laravel-ide-helper
|
|
||||||
*/
|
|
||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper;
|
|
||||||
|
|
||||||
use PhpParser\Node\Stmt\GroupUse;
|
|
||||||
use PhpParser\Node\Stmt\Namespace_;
|
|
||||||
use PhpParser\Node\Stmt\Use_;
|
|
||||||
use PhpParser\Node\Stmt\UseUse;
|
|
||||||
use PhpParser\ParserFactory;
|
|
||||||
|
|
||||||
class UsesResolver
|
|
||||||
{
|
|
||||||
/**
|
|
||||||
* @param string $classFQN
|
|
||||||
* @return array
|
|
||||||
*/
|
|
||||||
public function loadFromClass(string $classFQN): array
|
|
||||||
{
|
|
||||||
return $this->loadFromFile(
|
|
||||||
$classFQN,
|
|
||||||
(new \ReflectionClass($classFQN))->getFileName()
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @param string $classFQN
|
|
||||||
* @param string $filename
|
|
||||||
* @return array
|
|
||||||
*/
|
|
||||||
public function loadFromFile(string $classFQN, string $filename): array
|
|
||||||
{
|
|
||||||
return $this->loadFromCode(
|
|
||||||
$classFQN,
|
|
||||||
file_get_contents(
|
|
||||||
$filename
|
|
||||||
)
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @param string $classFQN
|
|
||||||
* @param string $code
|
|
||||||
* @return array
|
|
||||||
*/
|
|
||||||
public function loadFromCode(string $classFQN, string $code): array
|
|
||||||
{
|
|
||||||
$classFQN = ltrim($classFQN, '\\');
|
|
||||||
|
|
||||||
$namespace = rtrim(
|
|
||||||
preg_replace(
|
|
||||||
'/([^\\\\]+)$/',
|
|
||||||
'',
|
|
||||||
$classFQN
|
|
||||||
),
|
|
||||||
'\\'
|
|
||||||
);
|
|
||||||
|
|
||||||
$parser = (new ParserFactory())->createForHostVersion();
|
|
||||||
$namespaceData = null;
|
|
||||||
|
|
||||||
foreach ($parser->parse($code) as $node) {
|
|
||||||
if ($node instanceof Namespace_ && $node->name->toCodeString() === $namespace) {
|
|
||||||
$namespaceData = $node;
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if ($namespaceData === null) {
|
|
||||||
return [];
|
|
||||||
}
|
|
||||||
|
|
||||||
/** @var Namespace_ $namespaceData */
|
|
||||||
|
|
||||||
$aliases = [];
|
|
||||||
|
|
||||||
foreach ($namespaceData->stmts as $stmt) {
|
|
||||||
if ($stmt instanceof Use_) {
|
|
||||||
if ($stmt->type !== Use_::TYPE_NORMAL) {
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
|
|
||||||
foreach ($stmt->uses as $use) {
|
|
||||||
/** @var UseUse $use */
|
|
||||||
|
|
||||||
$alias = $use->alias ?
|
|
||||||
$use->alias->name :
|
|
||||||
self::classBasename($use->name->toCodeString());
|
|
||||||
|
|
||||||
$aliases[$alias] = '\\' . $use->name->toCodeString();
|
|
||||||
}
|
|
||||||
} elseif ($stmt instanceof GroupUse) {
|
|
||||||
foreach ($stmt->uses as $use) {
|
|
||||||
/** @var UseUse $use */
|
|
||||||
|
|
||||||
$alias = $use->alias ?
|
|
||||||
$use->alias->name :
|
|
||||||
self::classBasename($use->name->toCodeString());
|
|
||||||
|
|
||||||
$aliases[$alias] = '\\' . $stmt->prefix->toCodeString() . '\\' . $use->name->toCodeString();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return $aliases;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @param string $classFQN
|
|
||||||
* @return string
|
|
||||||
*/
|
|
||||||
protected static function classBasename(string $classFQN): string
|
|
||||||
{
|
|
||||||
return preg_replace('/^.*\\\\([^\\\\]+)$/', '$1', $classFQN);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -66,6 +66,21 @@ class AliasTest extends TestCase
|
|||||||
$this->assertNotNull($this->getAliasMacro($alias, EloquentBuilder::class, $macro));
|
$this->assertNotNull($this->getAliasMacro($alias, EloquentBuilder::class, $macro));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @covers ::detectTemplateNames
|
||||||
|
*/
|
||||||
|
public function testTemplateNamesAreDetected(): void
|
||||||
|
{
|
||||||
|
// Mock
|
||||||
|
$alias = new AliasMock();
|
||||||
|
|
||||||
|
// Prepare
|
||||||
|
$alias->setClasses([EloquentBuilder::class]);
|
||||||
|
|
||||||
|
// Test
|
||||||
|
$this->assertSame(['TModel', 'TValue'], $alias->getTemplateNames());
|
||||||
|
}
|
||||||
|
|
||||||
protected function getAliasMacro(Alias $alias, string $class, string $method): ?Macro
|
protected function getAliasMacro(Alias $alias, string $class, string $method): ?Macro
|
||||||
{
|
{
|
||||||
return Arr::first(
|
return Arr::first(
|
||||||
@@ -82,6 +97,7 @@ class AliasTest extends TestCase
|
|||||||
/**
|
/**
|
||||||
* @internal
|
* @internal
|
||||||
* @noinspection PhpMultipleClassesDeclarationsInOneFile
|
* @noinspection PhpMultipleClassesDeclarationsInOneFile
|
||||||
|
* @template TValue
|
||||||
*/
|
*/
|
||||||
class AliasMock extends Alias
|
class AliasMock extends Alias
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -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,46 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\GeneratorCommand\GenerateIdeHelper;
|
||||||
|
|
||||||
|
use Barryvdh\LaravelIdeHelper\Console\GeneratorCommand;
|
||||||
|
use Barryvdh\LaravelIdeHelper\Tests\Console\GeneratorCommand\AbstractGeneratorCommand;
|
||||||
|
use Illuminate\Support\Arr;
|
||||||
|
use Illuminate\Support\Facades\DB;
|
||||||
|
|
||||||
|
class Test extends AbstractGeneratorCommand
|
||||||
|
{
|
||||||
|
public function testGenerator(): void
|
||||||
|
{
|
||||||
|
Arr::macro('arr_custom_macro', function () {
|
||||||
|
});
|
||||||
|
DB::macro('db_custom_macro', function () {
|
||||||
|
});
|
||||||
|
$this->app['config']->set('ide-helper.macro_default_return_types', [Arr::class => 'Custom_Fake_Class']);
|
||||||
|
|
||||||
|
$command = $this->app->make(GeneratorCommand::class);
|
||||||
|
|
||||||
|
$tester = $this->runCommand($command);
|
||||||
|
|
||||||
|
$this->assertSame(0, $tester->getStatusCode());
|
||||||
|
|
||||||
|
$this->assertStringContainsString('A new helper file was written to _ide_helper.php', $tester->getDisplay());
|
||||||
|
$this->assertStringContainsString('public static function configure($basePath = null)', $this->mockFilesystemOutput);
|
||||||
|
$this->assertStringContainsString('* @return \Custom_Fake_Class', $this->mockFilesystemOutput);
|
||||||
|
$this->assertStringContainsString('public static function arr_custom_macro()', $this->mockFilesystemOutput);
|
||||||
|
$this->assertStringContainsString('public static function db_custom_macro()', $this->mockFilesystemOutput);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testFilename(): void
|
||||||
|
{
|
||||||
|
$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,17 +12,22 @@ 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')
|
||||||
->andReturnUsing(function ($__path, $__data) {
|
->andReturnUsing(function ($__path, $__data = []) {
|
||||||
return (static function () use ($__path, $__data) {
|
return (static function () use ($__path, $__data) {
|
||||||
extract($__data, EXTR_SKIP);
|
extract($__data, EXTR_SKIP);
|
||||||
|
|
||||||
@@ -49,15 +54,13 @@ 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')
|
||||||
->andReturnUsing(function ($__path, $__data) {
|
->andReturnUsing(function ($__path, $__data = []) {
|
||||||
return (static function () use ($__path, $__data) {
|
return (static function () use ($__path, $__data) {
|
||||||
extract($__data, EXTR_SKIP);
|
extract($__data, EXTR_SKIP);
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,21 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts\Collections;
|
||||||
|
|
||||||
|
use Illuminate\Contracts\Support\Arrayable;
|
||||||
|
use JsonSerializable;
|
||||||
|
|
||||||
|
class AdvancedCastMap implements Arrayable, JsonSerializable
|
||||||
|
{
|
||||||
|
public function toArray(): array
|
||||||
|
{
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
|
||||||
|
public function jsonSerialize(): array
|
||||||
|
{
|
||||||
|
return $this->toArray();
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -5,6 +5,7 @@ declare(strict_types=1);
|
|||||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts\Models;
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts\Models;
|
||||||
|
|
||||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts\Collections\AdvancedCastCollection;
|
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts\Collections\AdvancedCastCollection;
|
||||||
|
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts\Collections\AdvancedCastMap;
|
||||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts\Enums\AdvancedCastEnum;
|
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts\Enums\AdvancedCastEnum;
|
||||||
use Illuminate\Database\Eloquent\Casts\AsArrayObject;
|
use Illuminate\Database\Eloquent\Casts\AsArrayObject;
|
||||||
use Illuminate\Database\Eloquent\Casts\AsCollection;
|
use Illuminate\Database\Eloquent\Casts\AsCollection;
|
||||||
@@ -29,7 +30,9 @@ class AdvancedCast extends Model
|
|||||||
'cast_to_encrypted_json' => 'encrypted:json',
|
'cast_to_encrypted_json' => 'encrypted:json',
|
||||||
'cast_to_encrypted_object' => 'encrypted:object',
|
'cast_to_encrypted_object' => 'encrypted:object',
|
||||||
'cast_to_as_collection' => AsCollection::class,
|
'cast_to_as_collection' => AsCollection::class,
|
||||||
|
'cast_to_as_collection_of' => AsCollection::class . ':,' . AdvancedCastMap::class, // since 12.10
|
||||||
'cast_to_as_collection_using' => AsCollection::using(AdvancedCastCollection::class),
|
'cast_to_as_collection_using' => AsCollection::using(AdvancedCastCollection::class),
|
||||||
|
'cast_to_as_collection_using_and_map' => AsCollection::class . ':' . AdvancedCastCollection::class . ',' . AdvancedCastMap::class, // since 12.10
|
||||||
'cast_to_as_enum_collection' => AsEnumCollection::class,
|
'cast_to_as_enum_collection' => AsEnumCollection::class,
|
||||||
'cast_to_as_enum_collection_of' => AsEnumCollection::of(AdvancedCastEnum::class),
|
'cast_to_as_enum_collection_of' => AsEnumCollection::of(AdvancedCastEnum::class),
|
||||||
'cast_to_as_array_object' => AsArrayObject::class,
|
'cast_to_as_array_object' => AsArrayObject::class,
|
||||||
|
|||||||
@@ -5,6 +5,7 @@ declare(strict_types=1);
|
|||||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts\Models;
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts\Models;
|
||||||
|
|
||||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts\Collections\AdvancedCastCollection;
|
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts\Collections\AdvancedCastCollection;
|
||||||
|
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts\Collections\AdvancedCastMap;
|
||||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts\Enums\AdvancedCastEnum;
|
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts\Enums\AdvancedCastEnum;
|
||||||
use Illuminate\Database\Eloquent\Casts\AsArrayObject;
|
use Illuminate\Database\Eloquent\Casts\AsArrayObject;
|
||||||
use Illuminate\Database\Eloquent\Casts\AsCollection;
|
use Illuminate\Database\Eloquent\Casts\AsCollection;
|
||||||
@@ -22,14 +23,16 @@ 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 \Illuminate\Database\Eloquent\Casts\ArrayObject<array-key, mixed> $cast_to_as_array_object
|
||||||
|
* @property \Illuminate\Support\Collection<int, AdvancedCastMap> $cast_to_as_collection_of
|
||||||
* @property AdvancedCastCollection $cast_to_as_collection_using
|
* @property AdvancedCastCollection $cast_to_as_collection_using
|
||||||
|
* @property AdvancedCastCollection<int, AdvancedCastMap> $cast_to_as_collection_using_and_map
|
||||||
* @property \Illuminate\Support\Collection<int, AdvancedCastEnum> $cast_to_as_enum_collection_of
|
* @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()
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|AdvancedCast newQuery()
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|AdvancedCast newQuery()
|
||||||
@@ -69,7 +72,9 @@ class AdvancedCast extends Model
|
|||||||
'cast_to_encrypted_json' => 'encrypted:json',
|
'cast_to_encrypted_json' => 'encrypted:json',
|
||||||
'cast_to_encrypted_object' => 'encrypted:object',
|
'cast_to_encrypted_object' => 'encrypted:object',
|
||||||
'cast_to_as_collection' => AsCollection::class,
|
'cast_to_as_collection' => AsCollection::class,
|
||||||
|
'cast_to_as_collection_of' => AsCollection::class . ':,' . AdvancedCastMap::class, // since 12.10
|
||||||
'cast_to_as_collection_using' => AsCollection::using(AdvancedCastCollection::class),
|
'cast_to_as_collection_using' => AsCollection::using(AdvancedCastCollection::class),
|
||||||
|
'cast_to_as_collection_using_and_map' => AsCollection::class . ':' . AdvancedCastCollection::class . ',' . AdvancedCastMap::class, // since 12.10
|
||||||
'cast_to_as_enum_collection' => AsEnumCollection::class,
|
'cast_to_as_enum_collection' => AsEnumCollection::class,
|
||||||
'cast_to_as_enum_collection_of' => AsEnumCollection::of(AdvancedCastEnum::class),
|
'cast_to_as_enum_collection_of' => AsEnumCollection::of(AdvancedCastEnum::class),
|
||||||
'cast_to_as_array_object' => AsArrayObject::class,
|
'cast_to_as_array_object' => AsArrayObject::class,
|
||||||
|
|||||||
@@ -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
|
||||||
|
{
|
||||||
|
}
|
||||||
@@ -0,0 +1,251 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpDocWithTypedScopeParameter\Models;
|
||||||
|
|
||||||
|
use Illuminate\Database\Eloquent\Builder;
|
||||||
|
use Illuminate\Database\Eloquent\Model;
|
||||||
|
|
||||||
|
class Comment extends Model
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* @comment Scope with required boolean parameter
|
||||||
|
*/
|
||||||
|
protected function scopeTyped01(Builder $query, bool $value)
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope with optional boolean parameter and default true
|
||||||
|
*/
|
||||||
|
protected function scopeTyped02(Builder $query, bool $value = true)
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope with optional boolean parameter and default false
|
||||||
|
*/
|
||||||
|
protected function scopeTyped03(Builder $query, bool $value = false)
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope with required string parameter
|
||||||
|
*/
|
||||||
|
protected function scopeTyped04(Builder $query, string $value)
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope with optional string parameter and default value
|
||||||
|
*/
|
||||||
|
protected function scopeTyped05(Builder $query, string $value = 'dummy123')
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope with required integer parameter
|
||||||
|
*/
|
||||||
|
protected function scopeTyped06(Builder $query, int $value)
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope with optional integer parameter and default positive value
|
||||||
|
*/
|
||||||
|
protected function scopeTyped07(Builder $query, int $value = 123)
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope with optional integer parameter and default negative value
|
||||||
|
*/
|
||||||
|
protected function scopeTyped08(Builder $query, int $value = -123)
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope with required float parameter
|
||||||
|
*/
|
||||||
|
protected function scopeTyped09(Builder $query, float $value)
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope with optional float parameter and default positive integer value
|
||||||
|
*/
|
||||||
|
protected function scopeTyped10(Builder $query, float $value = 123)
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope with optional float parameter and default negative integer value
|
||||||
|
*/
|
||||||
|
protected function scopeTyped11(Builder $query, float $value = -123)
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope with optional float parameter and default positive float value
|
||||||
|
*/
|
||||||
|
protected function scopeTyped12(Builder $query, float $value = 1.23)
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope with optional float parameter and default negative float value
|
||||||
|
*/
|
||||||
|
protected function scopeTyped13(Builder $query, float $value = -1.23)
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope with required nullable boolean parameter
|
||||||
|
*/
|
||||||
|
protected function scopeTyped14(Builder $query, ?bool $value)
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope with optional nullable boolean parameter and default true
|
||||||
|
*/
|
||||||
|
protected function scopeTyped15(Builder $query, ?bool $value = true)
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope with optional nullable boolean parameter and default false
|
||||||
|
*/
|
||||||
|
protected function scopeTyped16(Builder $query, ?bool $value = false)
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope with optional nullable boolean parameter and default null
|
||||||
|
*/
|
||||||
|
protected function scopeTyped17(Builder $query, ?bool $value = null)
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope with required nullable string parameter
|
||||||
|
*/
|
||||||
|
protected function scopeTyped18(Builder $query, ?string $value)
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope with optional nullable string parameter and default value
|
||||||
|
*/
|
||||||
|
protected function scopeTyped19(Builder $query, ?string $value = 'dummy123')
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope with optional nullable string parameter and default null
|
||||||
|
*/
|
||||||
|
protected function scopeTyped20(Builder $query, ?string $value = null)
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope with required nullable integer parameter
|
||||||
|
*/
|
||||||
|
protected function scopeTyped21(Builder $query, ?int $value)
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope with optional nullable integer parameter and default positive value
|
||||||
|
*/
|
||||||
|
protected function scopeTyped22(Builder $query, ?int $value = 123)
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope with optional nullable integer parameter and default negative value
|
||||||
|
*/
|
||||||
|
protected function scopeTyped23(Builder $query, ?int $value = -123)
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope with optional nullable integer parameter and default null
|
||||||
|
*/
|
||||||
|
protected function scopeTyped24(Builder $query, ?int $value = null)
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope with required float nullable parameter
|
||||||
|
*/
|
||||||
|
protected function scopeTyped25(Builder $query, ?float $value)
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope with optional nullable float parameter and default positive integer value
|
||||||
|
*/
|
||||||
|
protected function scopeTyped26(Builder $query, ?float $value = 123)
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope with optional nullable float parameter and default negative integer value
|
||||||
|
*/
|
||||||
|
protected function scopeTyped27(Builder $query, ?float $value = -123)
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope with optional float parameter and default positive float value
|
||||||
|
*/
|
||||||
|
protected function scopeTyped28(Builder $query, ?float $value = 1.23)
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope with optional float parameter and default negative float value
|
||||||
|
*/
|
||||||
|
protected function scopeTyped29(Builder $query, ?float $value = -1.23)
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope with optional float parameter and default null
|
||||||
|
*/
|
||||||
|
protected function scopeTyped30(Builder $query, ?float $value = null)
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,24 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpDocWithTypedScopeParameter;
|
||||||
|
|
||||||
|
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
|
||||||
|
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AbstractModelsCommand;
|
||||||
|
|
||||||
|
class Test extends AbstractModelsCommand
|
||||||
|
{
|
||||||
|
public function test(): void
|
||||||
|
{
|
||||||
|
$command = $this->app->make(ModelsCommand::class);
|
||||||
|
|
||||||
|
$tester = $this->runCommand($command, [
|
||||||
|
'--write' => true,
|
||||||
|
]);
|
||||||
|
|
||||||
|
$this->assertSame(0, $tester->getStatusCode());
|
||||||
|
$this->assertStringContainsString('Written new phpDocBlock to', $tester->getDisplay());
|
||||||
|
$this->assertMatchesMockedSnapshot();
|
||||||
|
}
|
||||||
|
}
|
||||||
+289
@@ -0,0 +1,289 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpDocWithTypedScopeParameter\Models;
|
||||||
|
|
||||||
|
use Illuminate\Database\Eloquent\Builder;
|
||||||
|
use Illuminate\Database\Eloquent\Model;
|
||||||
|
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
*
|
||||||
|
* @method static Builder<static>|Comment newModelQuery()
|
||||||
|
* @method static Builder<static>|Comment newQuery()
|
||||||
|
* @method static Builder<static>|Comment query()
|
||||||
|
* @method static Builder<static>|Comment typed01(bool $value) Scope with required boolean parameter
|
||||||
|
* @method static Builder<static>|Comment typed02(bool $value = true) Scope with optional boolean parameter and default true
|
||||||
|
* @method static Builder<static>|Comment typed03(bool $value = false) Scope with optional boolean parameter and default false
|
||||||
|
* @method static Builder<static>|Comment typed04(string $value) Scope with required string parameter
|
||||||
|
* @method static Builder<static>|Comment typed05(string $value = 'dummy123') Scope with optional string parameter and default value
|
||||||
|
* @method static Builder<static>|Comment typed06(int $value) Scope with required integer parameter
|
||||||
|
* @method static Builder<static>|Comment typed07(int $value = 123) Scope with optional integer parameter and default positive value
|
||||||
|
* @method static Builder<static>|Comment typed08(int $value = -123) Scope with optional integer parameter and default negative value
|
||||||
|
* @method static Builder<static>|Comment typed09(float $value) Scope with required float parameter
|
||||||
|
* @method static Builder<static>|Comment typed10(float $value = 123) Scope with optional float parameter and default positive integer value
|
||||||
|
* @method static Builder<static>|Comment typed11(float $value = -123) Scope with optional float parameter and default negative integer value
|
||||||
|
* @method static Builder<static>|Comment typed12(float $value = 1.23) Scope with optional float parameter and default positive float value
|
||||||
|
* @method static Builder<static>|Comment typed13(float $value = -1.23) Scope with optional float parameter and default negative float value
|
||||||
|
* @method static Builder<static>|Comment typed14(?bool $value) Scope with required nullable boolean parameter
|
||||||
|
* @method static Builder<static>|Comment typed15(?bool $value = true) Scope with optional nullable boolean parameter and default true
|
||||||
|
* @method static Builder<static>|Comment typed16(?bool $value = false) Scope with optional nullable boolean parameter and default false
|
||||||
|
* @method static Builder<static>|Comment typed17(?bool $value = null) Scope with optional nullable boolean parameter and default null
|
||||||
|
* @method static Builder<static>|Comment typed18(?string $value) Scope with required nullable string parameter
|
||||||
|
* @method static Builder<static>|Comment typed19(?string $value = 'dummy123') Scope with optional nullable string parameter and default value
|
||||||
|
* @method static Builder<static>|Comment typed20(?string $value = null) Scope with optional nullable string parameter and default null
|
||||||
|
* @method static Builder<static>|Comment typed21(?int $value) Scope with required nullable integer parameter
|
||||||
|
* @method static Builder<static>|Comment typed22(?int $value = 123) Scope with optional nullable integer parameter and default positive value
|
||||||
|
* @method static Builder<static>|Comment typed23(?int $value = -123) Scope with optional nullable integer parameter and default negative value
|
||||||
|
* @method static Builder<static>|Comment typed24(?int $value = null) Scope with optional nullable integer parameter and default null
|
||||||
|
* @method static Builder<static>|Comment typed25(?float $value) Scope with required float nullable parameter
|
||||||
|
* @method static Builder<static>|Comment typed26(?float $value = 123) Scope with optional nullable float parameter and default positive integer value
|
||||||
|
* @method static Builder<static>|Comment typed27(?float $value = -123) Scope with optional nullable float parameter and default negative integer value
|
||||||
|
* @method static Builder<static>|Comment typed28(?float $value = 1.23) Scope with optional float parameter and default positive float value
|
||||||
|
* @method static Builder<static>|Comment typed29(?float $value = -1.23) Scope with optional float parameter and default negative float value
|
||||||
|
* @method static Builder<static>|Comment typed30(?float $value = null) Scope with optional float parameter and default null
|
||||||
|
* @mixin \Eloquent
|
||||||
|
*/
|
||||||
|
class Comment extends Model
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* @comment Scope with required boolean parameter
|
||||||
|
*/
|
||||||
|
protected function scopeTyped01(Builder $query, bool $value)
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope with optional boolean parameter and default true
|
||||||
|
*/
|
||||||
|
protected function scopeTyped02(Builder $query, bool $value = true)
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope with optional boolean parameter and default false
|
||||||
|
*/
|
||||||
|
protected function scopeTyped03(Builder $query, bool $value = false)
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope with required string parameter
|
||||||
|
*/
|
||||||
|
protected function scopeTyped04(Builder $query, string $value)
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope with optional string parameter and default value
|
||||||
|
*/
|
||||||
|
protected function scopeTyped05(Builder $query, string $value = 'dummy123')
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope with required integer parameter
|
||||||
|
*/
|
||||||
|
protected function scopeTyped06(Builder $query, int $value)
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope with optional integer parameter and default positive value
|
||||||
|
*/
|
||||||
|
protected function scopeTyped07(Builder $query, int $value = 123)
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope with optional integer parameter and default negative value
|
||||||
|
*/
|
||||||
|
protected function scopeTyped08(Builder $query, int $value = -123)
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope with required float parameter
|
||||||
|
*/
|
||||||
|
protected function scopeTyped09(Builder $query, float $value)
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope with optional float parameter and default positive integer value
|
||||||
|
*/
|
||||||
|
protected function scopeTyped10(Builder $query, float $value = 123)
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope with optional float parameter and default negative integer value
|
||||||
|
*/
|
||||||
|
protected function scopeTyped11(Builder $query, float $value = -123)
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope with optional float parameter and default positive float value
|
||||||
|
*/
|
||||||
|
protected function scopeTyped12(Builder $query, float $value = 1.23)
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope with optional float parameter and default negative float value
|
||||||
|
*/
|
||||||
|
protected function scopeTyped13(Builder $query, float $value = -1.23)
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope with required nullable boolean parameter
|
||||||
|
*/
|
||||||
|
protected function scopeTyped14(Builder $query, ?bool $value)
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope with optional nullable boolean parameter and default true
|
||||||
|
*/
|
||||||
|
protected function scopeTyped15(Builder $query, ?bool $value = true)
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope with optional nullable boolean parameter and default false
|
||||||
|
*/
|
||||||
|
protected function scopeTyped16(Builder $query, ?bool $value = false)
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope with optional nullable boolean parameter and default null
|
||||||
|
*/
|
||||||
|
protected function scopeTyped17(Builder $query, ?bool $value = null)
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope with required nullable string parameter
|
||||||
|
*/
|
||||||
|
protected function scopeTyped18(Builder $query, ?string $value)
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope with optional nullable string parameter and default value
|
||||||
|
*/
|
||||||
|
protected function scopeTyped19(Builder $query, ?string $value = 'dummy123')
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope with optional nullable string parameter and default null
|
||||||
|
*/
|
||||||
|
protected function scopeTyped20(Builder $query, ?string $value = null)
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope with required nullable integer parameter
|
||||||
|
*/
|
||||||
|
protected function scopeTyped21(Builder $query, ?int $value)
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope with optional nullable integer parameter and default positive value
|
||||||
|
*/
|
||||||
|
protected function scopeTyped22(Builder $query, ?int $value = 123)
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope with optional nullable integer parameter and default negative value
|
||||||
|
*/
|
||||||
|
protected function scopeTyped23(Builder $query, ?int $value = -123)
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope with optional nullable integer parameter and default null
|
||||||
|
*/
|
||||||
|
protected function scopeTyped24(Builder $query, ?int $value = null)
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope with required float nullable parameter
|
||||||
|
*/
|
||||||
|
protected function scopeTyped25(Builder $query, ?float $value)
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope with optional nullable float parameter and default positive integer value
|
||||||
|
*/
|
||||||
|
protected function scopeTyped26(Builder $query, ?float $value = 123)
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope with optional nullable float parameter and default negative integer value
|
||||||
|
*/
|
||||||
|
protected function scopeTyped27(Builder $query, ?float $value = -123)
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope with optional float parameter and default positive float value
|
||||||
|
*/
|
||||||
|
protected function scopeTyped28(Builder $query, ?float $value = 1.23)
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope with optional float parameter and default negative float value
|
||||||
|
*/
|
||||||
|
protected function scopeTyped29(Builder $query, ?float $value = -1.23)
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope with optional float parameter and default null
|
||||||
|
*/
|
||||||
|
protected function scopeTyped30(Builder $query, ?float $value = null)
|
||||||
|
{
|
||||||
|
$query->where('type', $value);
|
||||||
|
}
|
||||||
|
}
|
||||||
+1
-1
@@ -160,7 +160,7 @@ use Illuminate\Database\Eloquent\SoftDeletes;
|
|||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post whereUuidNullable($value)
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post whereUuidNullable($value)
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post whereYearNotNullable($value)
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post whereYearNotNullable($value)
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post whereYearNullable($value)
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post whereYearNullable($value)
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post withTrashed()
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post withTrashed(bool $withTrashed = true)
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post withoutTrashed()
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post withoutTrashed()
|
||||||
* @mixin \Eloquent
|
* @mixin \Eloquent
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -166,7 +166,7 @@ use Illuminate\Support\Carbon;
|
|||||||
* @method static EloquentBuilder<static>|Post whereUuidNullable($value)
|
* @method static EloquentBuilder<static>|Post whereUuidNullable($value)
|
||||||
* @method static EloquentBuilder<static>|Post whereYearNotNullable($value)
|
* @method static EloquentBuilder<static>|Post whereYearNotNullable($value)
|
||||||
* @method static EloquentBuilder<static>|Post whereYearNullable($value)
|
* @method static EloquentBuilder<static>|Post whereYearNullable($value)
|
||||||
* @method static EloquentBuilder<static>|Post withTrashed()
|
* @method static EloquentBuilder<static>|Post withTrashed(bool $withTrashed = true)
|
||||||
* @method static EloquentBuilder<static>|Post withoutTrashed()
|
* @method static EloquentBuilder<static>|Post withoutTrashed()
|
||||||
* @mixin Eloquent
|
* @mixin Eloquent
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -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'))
|
||||||
|
|||||||
@@ -0,0 +1,33 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\QueryScopes\Models;
|
||||||
|
|
||||||
|
use Illuminate\Database\Eloquent\Attributes\Scope;
|
||||||
|
use Illuminate\Database\Eloquent\Builder;
|
||||||
|
use Illuminate\Database\Eloquent\Model;
|
||||||
|
|
||||||
|
class Comment extends Model
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* @comment Scope using the 'Scope' attribute
|
||||||
|
* @param Builder $query
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
#[Scope]
|
||||||
|
protected function local(Builder $query): void
|
||||||
|
{
|
||||||
|
$query->where('ip_address', '127.0.0.1');
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope using the 'scope' prefix
|
||||||
|
* @param Builder $query
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
protected function scopeSystem(Builder $query): void
|
||||||
|
{
|
||||||
|
$query->where('system', true);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -4,6 +4,49 @@ declare(strict_types=1);
|
|||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\QueryScopes\Models;
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\QueryScopes\Models;
|
||||||
|
|
||||||
|
use Illuminate\Database\Eloquent\Attributes\Scope;
|
||||||
|
use Illuminate\Database\Eloquent\Builder;
|
||||||
|
use Illuminate\Database\Eloquent\Model;
|
||||||
|
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
*
|
||||||
|
* @method static Builder<static>|Comment local() Scope using the 'Scope' attribute
|
||||||
|
* @method static Builder<static>|Comment newModelQuery()
|
||||||
|
* @method static Builder<static>|Comment newQuery()
|
||||||
|
* @method static Builder<static>|Comment query()
|
||||||
|
* @method static Builder<static>|Comment system() Scope using the 'scope' prefix
|
||||||
|
* @mixin \Eloquent
|
||||||
|
*/
|
||||||
|
class Comment extends Model
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* @comment Scope using the 'Scope' attribute
|
||||||
|
* @param Builder $query
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
#[Scope]
|
||||||
|
protected function local(Builder $query): void
|
||||||
|
{
|
||||||
|
$query->where('ip_address', '127.0.0.1');
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @comment Scope using the 'scope' prefix
|
||||||
|
* @param Builder $query
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
protected function scopeSystem(Builder $query): void
|
||||||
|
{
|
||||||
|
$query->where('system', true);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\QueryScopes\Models;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
*
|
*
|
||||||
*
|
*
|
||||||
|
|||||||
@@ -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()
|
||||||
|
|||||||
@@ -16,7 +16,7 @@ use Illuminate\Database\Eloquent\SoftDeletes;
|
|||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple onlyTrashed()
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple onlyTrashed()
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple query()
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple query()
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple whereId($value)
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple whereId($value)
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple withTrashed()
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple withTrashed(bool $withTrashed = true)
|
||||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple withoutTrashed()
|
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple withoutTrashed()
|
||||||
* @mixin \Eloquent
|
* @mixin \Eloquent
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -193,6 +193,29 @@ DOC;
|
|||||||
$this->assertSame([], $method->getParamsWithDefault(false));
|
$this->assertSame([], $method->getParamsWithDefault(false));
|
||||||
$this->assertTrue($method->shouldReturn());
|
$this->assertTrue($method->shouldReturn());
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public function testEloquentBuilderWithTemplates()
|
||||||
|
{
|
||||||
|
$reflectionClass = new \ReflectionClass(EloquentBuilder::class);
|
||||||
|
$reflectionMethod = $reflectionClass->getMethod('firstOr');
|
||||||
|
|
||||||
|
$method = new Method($reflectionMethod, 'Builder', $reflectionClass, null, [], [], [], ['TModel']);
|
||||||
|
|
||||||
|
$output = <<<'DOC'
|
||||||
|
/**
|
||||||
|
* Execute the query and get the first result or call a callback.
|
||||||
|
*
|
||||||
|
* @template TValue
|
||||||
|
* @param (\Closure(): TValue)|list<string> $columns
|
||||||
|
* @param (\Closure(): TValue)|null $callback
|
||||||
|
* @return TModel|TValue
|
||||||
|
* @static
|
||||||
|
*/
|
||||||
|
DOC;
|
||||||
|
$this->assertSame($output, $method->getDocComment(''));
|
||||||
|
$this->assertSame('firstOr', $method->getName());
|
||||||
|
$this->assertSame('\\' . EloquentBuilder::class, $method->getDeclaringClass());
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
class ExampleClass
|
class ExampleClass
|
||||||
|
|||||||
+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')
|
||||||
|
|||||||
@@ -1,56 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
declare(strict_types=1);
|
|
||||||
|
|
||||||
namespace Barryvdh\LaravelIdeHelper\Tests;
|
|
||||||
|
|
||||||
use Barryvdh\LaravelIdeHelper\UsesResolver;
|
|
||||||
use PHPUnit\Framework\TestCase;
|
|
||||||
|
|
||||||
class UsesResolverTest extends TestCase
|
|
||||||
{
|
|
||||||
/**
|
|
||||||
* Test that we can correctly load uses from supplied code
|
|
||||||
*/
|
|
||||||
public function testLoadFromCode()
|
|
||||||
{
|
|
||||||
$usesResolver = new UsesResolver();
|
|
||||||
|
|
||||||
$code = <<<'DOC'
|
|
||||||
<?php
|
|
||||||
namespace Barryvdh\LaravelIdeHelper\Tests;
|
|
||||||
|
|
||||||
use Barryvdh\LaravelIdeHelper\UsesResolver as MyUsesResolver;
|
|
||||||
use PHPUnit\Framework\TestCase;
|
|
||||||
|
|
||||||
class UsesResolverTest extends TestCase
|
|
||||||
{
|
|
||||||
//
|
|
||||||
}
|
|
||||||
DOC;
|
|
||||||
|
|
||||||
$this->assertEquals(
|
|
||||||
$usesResolver->loadFromCode('Barryvdh\\LaravelIdeHelper\\Tests\\UsesResolverTest', $code),
|
|
||||||
[
|
|
||||||
'MyUsesResolver' => '\\Barryvdh\\LaravelIdeHelper\\UsesResolver',
|
|
||||||
'TestCase' => '\\PHPUnit\Framework\TestCase',
|
|
||||||
]
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Test that we can correctly load uses from a class
|
|
||||||
*/
|
|
||||||
public function testLoadFromClass()
|
|
||||||
{
|
|
||||||
$usesResolver = new UsesResolver();
|
|
||||||
|
|
||||||
$this->assertEquals(
|
|
||||||
$usesResolver->loadFromClass(self::class),
|
|
||||||
[
|
|
||||||
'UsesResolver' => '\\Barryvdh\\LaravelIdeHelper\\UsesResolver',
|
|
||||||
'TestCase' => '\\PHPUnit\Framework\TestCase',
|
|
||||||
]
|
|
||||||
);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
Reference in New Issue
Block a user