mirror of
https://github.com/barryvdh/laravel-ide-helper.git
synced 2026-08-18 18:13:11 +00:00
Compare commits
45
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
b106f7ee85 | ||
|
|
d61d20357e | ||
|
|
e9283c40a2 | ||
|
|
12a0d7d54c | ||
|
|
9ef25f60e7 | ||
|
|
8dff6bb5ff | ||
|
|
53854ea7d9 | ||
|
|
1fa84a3b65 | ||
|
|
5e973967a7 | ||
|
|
8d00250cba | ||
|
|
877f5ed0a7 | ||
|
|
fafe264b3c | ||
|
|
108f6269c1 | ||
|
|
c488262f97 | ||
|
|
83e3f39b39 | ||
|
|
31979ed485 | ||
|
|
6d96f0bd1a | ||
|
|
cff244b9b5 | ||
|
|
4dfc08a854 | ||
|
|
6c4ba2ad38 | ||
|
|
1815a6140a | ||
|
|
7c469e4073 | ||
|
|
ae0a06d406 | ||
|
|
e0b2f86326 | ||
|
|
cdefaeed42 | ||
|
|
c775aec1bb | ||
|
|
0fa96e572d | ||
|
|
8eec4f1ff5 | ||
|
|
d567978ebe | ||
|
|
09623f216c | ||
|
|
3d4e37798e | ||
|
|
713a4758f9 | ||
|
|
8d441ec99f | ||
|
|
dba153f1e0 | ||
|
|
40485e7350 | ||
|
|
ead24b10f6 | ||
|
|
187ce9beeb | ||
|
|
6b43ac616d | ||
|
|
980a87e250 | ||
|
|
299a81b9bb | ||
|
|
06c1fab9b5 | ||
|
|
271682a2a6 | ||
|
|
bb1caed698 | ||
|
|
55268cd47a | ||
|
|
088968c3fc |
+1
-3
@@ -6,9 +6,7 @@
|
||||
/.gitattributes export-ignore
|
||||
/.github export-ignore
|
||||
/.gitignore export-ignore
|
||||
/.php-cs-fixer.cache export-ignore
|
||||
/.php-cs-fixer.php export-ignore
|
||||
/.php-cs-fixer.tests.cache export-ignore
|
||||
/.php-cs-fixer* export-ignore
|
||||
/phpunit.xml.dist export-ignore
|
||||
/psalm-baseline.xml export-ignore
|
||||
/psalm.xml export-ignore
|
||||
|
||||
@@ -12,7 +12,7 @@ jobs:
|
||||
runs-on: ubuntu-22.04
|
||||
steps:
|
||||
- name: Git checkout
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/checkout@v6
|
||||
|
||||
- name: Validate Composer configuration
|
||||
run: composer validate --strict
|
||||
@@ -23,6 +23,6 @@ jobs:
|
||||
composer global require ergebnis/composer-normalize
|
||||
composer normalize
|
||||
|
||||
- uses: stefanzweifel/git-auto-commit-action@v5
|
||||
- uses: stefanzweifel/git-auto-commit-action@v7
|
||||
with:
|
||||
commit_message: normalize composer.json
|
||||
|
||||
@@ -13,7 +13,7 @@ jobs:
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/checkout@v6
|
||||
|
||||
- name: Setup PHP
|
||||
uses: shivammathur/setup-php@v2
|
||||
@@ -27,7 +27,7 @@ jobs:
|
||||
- run: composer fix-style
|
||||
continue-on-error: true
|
||||
|
||||
- uses: stefanzweifel/git-auto-commit-action@v5
|
||||
- uses: stefanzweifel/git-auto-commit-action@v7
|
||||
with:
|
||||
commit_message: composer fix-style
|
||||
commit_author: laravel-ide-helper <[email protected]>
|
||||
|
||||
@@ -20,12 +20,12 @@ jobs:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
php: [8.4, 8.3, 8.2]
|
||||
laravel: [^11.15]
|
||||
laravel: [11.x, 12.x]
|
||||
|
||||
name: P${{ matrix.php }} - Laravel${{ matrix.laravel }}
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/checkout@v6
|
||||
with:
|
||||
path: src
|
||||
|
||||
|
||||
@@ -12,7 +12,7 @@ jobs:
|
||||
runs-on: ubuntu-22.04
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: actions/checkout@v6
|
||||
|
||||
- name: Setup PHP
|
||||
uses: shivammathur/setup-php@v2
|
||||
|
||||
@@ -20,19 +20,24 @@ jobs:
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
os: [ubuntu-22.04, windows-2019]
|
||||
php: [8.4, 8.3, 8.2]
|
||||
laravel: [^11.15]
|
||||
os: [ubuntu-latest]
|
||||
php: [8.5, 8.4, 8.3, 8.2]
|
||||
laravel: [~11.15, 12.x]
|
||||
stability: [prefer-lowest, prefer-stable]
|
||||
include:
|
||||
- os: windows-latest
|
||||
php: 8.3
|
||||
laravel: 12.x
|
||||
stability: prefer-stable
|
||||
steps:
|
||||
- name: Set git to use LF
|
||||
if: ${{ matrix.os == 'windows-2019' }}
|
||||
if: ${{ matrix.os == 'windows-latest' }}
|
||||
run: |
|
||||
git config --global core.autocrlf false
|
||||
git config --global core.eol lf
|
||||
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/checkout@v6
|
||||
|
||||
- name: Setup PHP
|
||||
uses: shivammathur/setup-php@v2
|
||||
|
||||
@@ -16,7 +16,7 @@ jobs:
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
uses: actions/checkout@v6
|
||||
with:
|
||||
ref: ${{ github.event.release.target_commitish }}
|
||||
|
||||
@@ -27,7 +27,7 @@ jobs:
|
||||
release-notes: ${{ github.event.release.body }}
|
||||
|
||||
- name: Commit updated CHANGELOG
|
||||
uses: stefanzweifel/git-auto-commit-action@v5
|
||||
uses: stefanzweifel/git-auto-commit-action@v7
|
||||
with:
|
||||
branch: ${{ github.event.release.target_commitish }}
|
||||
commit_message: Update CHANGELOG
|
||||
|
||||
@@ -1,5 +1,86 @@
|
||||
# Changelog
|
||||
|
||||
## v3.6.0 - 2025-07-18
|
||||
|
||||
### What's Changed
|
||||
|
||||
* fix: Change AsArrayObject cast to be Laravel's ArrayObject by @wsamoht in https://github.com/barryvdh/laravel-ide-helper/pull/1675
|
||||
* Add extends declaration for Macroable classes to fix missing inherited methods by @KentarouTakeda in https://github.com/barryvdh/laravel-ide-helper/pull/1674
|
||||
* fix(meta): ignore aliases in the autoloader (Fixes #1671) by @pataar in https://github.com/barryvdh/laravel-ide-helper/pull/1686
|
||||
* feat(ModelsCommand): add support for the new Scope attribute by @pataar in https://github.com/barryvdh/laravel-ide-helper/pull/1694
|
||||
* fix type change for scope default float parameter by @nivseb in https://github.com/barryvdh/laravel-ide-helper/pull/1697
|
||||
* Revert #1629 - *Allow adding custom Macroable classes* by @erikn69 in https://github.com/barryvdh/laravel-ide-helper/pull/1707
|
||||
* Configurable macro return type defaults by @erikn69 in https://github.com/barryvdh/laravel-ide-helper/pull/1711
|
||||
* docs(readme): add Laravel 12 support information by @SantosVilanculos in https://github.com/barryvdh/laravel-ide-helper/pull/1717
|
||||
* Add multi-level directory support for translation files by @RosiersRobin in https://github.com/barryvdh/laravel-ide-helper/pull/1718
|
||||
* Support `AsCollection::of($map)`, `AsCollection::using($class, $map)` by @erikn69 in https://github.com/barryvdh/laravel-ide-helper/pull/1714
|
||||
* fix: Fixed wrong doc for SoftDeletes `withTrashed` method by @eldair in https://github.com/barryvdh/laravel-ide-helper/pull/1688
|
||||
* Support other OS on tests by @erikn69 in https://github.com/barryvdh/laravel-ide-helper/pull/1715
|
||||
* Fix tests on windows by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1720
|
||||
* Bump stefanzweifel/git-auto-commit-action from 5 to 6 in the deps group by @dependabot[bot] in https://github.com/barryvdh/laravel-ide-helper/pull/1719
|
||||
* Update .gitattributes - avoid all `.php-cs-fixer` files on vendor by @erikn69 in https://github.com/barryvdh/laravel-ide-helper/pull/1708
|
||||
* fix(ModelsCommand): use 'string' as realType for 'encrypted' casts by @pataar in https://github.com/barryvdh/laravel-ide-helper/pull/1698
|
||||
* Trim strings and bump reflection docblock by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1721
|
||||
* Add magic *_exists properties by @erikn69 in https://github.com/barryvdh/laravel-ide-helper/pull/1712
|
||||
|
||||
### New Contributors
|
||||
|
||||
* @wsamoht made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1675
|
||||
* @nivseb made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1697
|
||||
* @SantosVilanculos made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1717
|
||||
* @RosiersRobin made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1718
|
||||
|
||||
**Full Changelog**: https://github.com/barryvdh/laravel-ide-helper/compare/v3.5.5...v3.6.0
|
||||
|
||||
## v3.5.5 - 2025-02-21
|
||||
|
||||
### What's Changed
|
||||
|
||||
* Fix for incorrect config item types in meta file by @eldair in https://github.com/barryvdh/laravel-ide-helper/pull/1662
|
||||
* Prevent generation of incorrect property annotation by @skyler544 in https://github.com/barryvdh/laravel-ide-helper/pull/1665
|
||||
* Fix MorphTo Model Doc Generation by @yparitcher in https://github.com/barryvdh/laravel-ide-helper/pull/1668
|
||||
* Laravel 12 support by @jonnott in https://github.com/barryvdh/laravel-ide-helper/pull/1672
|
||||
|
||||
### New Contributors
|
||||
|
||||
* @eldair made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1662
|
||||
* @skyler544 made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1665
|
||||
* @yparitcher made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1668
|
||||
* @jonnott made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1672
|
||||
|
||||
**Full Changelog**: https://github.com/barryvdh/laravel-ide-helper/compare/v3.5.4...v3.5.5
|
||||
|
||||
## v3.5.4 - 2025-01-14
|
||||
|
||||
### What's Changed
|
||||
|
||||
* Convert auth() helper to use Auth facade by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1656
|
||||
* Check if returnType from docblock is not null by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1658
|
||||
|
||||
**Full Changelog**: https://github.com/barryvdh/laravel-ide-helper/compare/v3.5.3...v3.5.4
|
||||
|
||||
## v3.5.3 - 2025-01-08
|
||||
|
||||
### What's Changed
|
||||
|
||||
* Catch meta, tweak auth by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1654
|
||||
* Check if macro is valid by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1655
|
||||
* feat: use generics of return type to determine resulting models by @Bloemendaal in https://github.com/barryvdh/laravel-ide-helper/pull/1653
|
||||
|
||||
### New Contributors
|
||||
|
||||
* @Bloemendaal made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1653
|
||||
|
||||
**Full Changelog**: https://github.com/barryvdh/laravel-ide-helper/compare/v3.5.2...v3.5.3
|
||||
|
||||
## v3.5.2 - 2025-01-06
|
||||
|
||||
### Fixes
|
||||
|
||||
Fix empty/anonymous closure in meta command.
|
||||
|
||||
**Full Changelog**: https://github.com/barryvdh/laravel-ide-helper/compare/v3.5.1...v3.5.2
|
||||
|
||||
## v3.5.1 - 2025-01-06
|
||||
|
||||
### What's Changed
|
||||
|
||||
@@ -11,7 +11,7 @@
|
||||
This package generates helper files that enable your IDE to provide accurate autocompletion.
|
||||
Generation is done based on the files in your project, so they are always up-to-date.
|
||||
|
||||
The 3.x branch supports Laravel 10 and 11. For older version, use the 2.x releases.
|
||||
The 3.x branch supports Laravel 10 and later. For older version, use the 2.x releases.
|
||||
|
||||
- [Installation](#installation)
|
||||
- [Usage](#usage)
|
||||
@@ -51,7 +51,7 @@ php artisan ide-helper:models -RW
|
||||
|
||||
If you don't want the full _ide_helper.php file, you can run add `--write-eloquent-helper` to the model command to generate small version, which is required for the `@mixin \Eloquent` to be able to add the QueryBuilder methods.
|
||||
|
||||
If you don't want to add all the phpdocs to your Models directly, you can use `--nowrite` to create a seperate file. The `--write-mixin` option can be used to only add a `@mixin` to your models, but add the generated phpdocs in a seperate file. This avoids having the results marked as duplicate.
|
||||
If you don't want to add all the phpdocs to your Models directly, you can use `--nowrite` to create a separate file. The `--write-mixin` option can be used to only add a `@mixin` to your models, but add the generated phpdocs in a separate file. This avoids having the results marked as duplicate.
|
||||
|
||||
|
||||
_Check out [this Laracasts video](https://laracasts.com/series/how-to-be-awesome-in-phpstorm/episodes/15) for a quick introduction/explanation!_
|
||||
@@ -115,8 +115,6 @@ Str::macro('concat', function(string $str1, string $str2) : string {
|
||||
});
|
||||
```
|
||||
|
||||
You can add any custom Macroable traits to detect in the `macroable_traits` config option.
|
||||
|
||||
### Automatic PHPDocs for models
|
||||
|
||||
If you don't want to write your properties yourself, you can use the command `php artisan ide-helper:models` to generate
|
||||
@@ -212,11 +210,11 @@ Eloquent allows calling `where<Attribute>` on your models, e.g. `Post::whereTitl
|
||||
|
||||
If for some reason it's undesired to have them generated (one for each column), you can disable this via config `write_model_magic_where` and setting it to `false`.
|
||||
|
||||
#### Magic `*_count` properties
|
||||
#### Magic `*_count` and `*_exists` properties
|
||||
|
||||
You may use the [`::withCount`](https://laravel.com/docs/master/eloquent-relationships#counting-related-models) method to count the number results from a relationship without actually loading them. Those results are then placed in attributes following the `<columname>_count` convention.
|
||||
You may use the [`::withCount`](https://laravel.com/docs/master/eloquent-relationships#counting-related-models) and [`::withExists`](https://laravel.com/docs/master/eloquent-relationships#other-aggregate-functions) methods to count the number results from a relationship without actually loading them. Those results are then placed in attributes following the `<columnname>_count` and `<columnname>_exists` convention.
|
||||
|
||||
By default, these attributes are generated in the phpdoc. You can turn them off by setting the config `write_model_relation_count_properties` to `false`.
|
||||
By default, these attributes are generated in the phpdoc. You can turn them off by setting the config `write_model_relation_count_properties` and `write_model_relation_exists_properties` to `false`.
|
||||
|
||||
#### Generics annotations
|
||||
|
||||
|
||||
+9
-9
@@ -23,21 +23,21 @@
|
||||
"require": {
|
||||
"php": "^8.2",
|
||||
"ext-json": "*",
|
||||
"barryvdh/reflection-docblock": "^2.3",
|
||||
"barryvdh/reflection-docblock": "^2.4",
|
||||
"composer/class-map-generator": "^1.0",
|
||||
"illuminate/console": "^11.15",
|
||||
"illuminate/database": "^11.15",
|
||||
"illuminate/filesystem": "^11.15",
|
||||
"illuminate/support": "^11.15"
|
||||
"illuminate/console": "^11.15 || ^12",
|
||||
"illuminate/database": "^11.15 || ^12",
|
||||
"illuminate/filesystem": "^11.15 || ^12",
|
||||
"illuminate/support": "^11.15 || ^12"
|
||||
},
|
||||
"require-dev": {
|
||||
"ext-pdo_sqlite": "*",
|
||||
"friendsofphp/php-cs-fixer": "^3",
|
||||
"illuminate/config": "^11.15",
|
||||
"illuminate/view": "^11.15",
|
||||
"illuminate/config": "^11.15 || ^12",
|
||||
"illuminate/view": "^11.15 || ^12",
|
||||
"mockery/mockery": "^1.4",
|
||||
"orchestra/testbench": "^9.2",
|
||||
"phpunit/phpunit": "^10.5",
|
||||
"orchestra/testbench": "^9.2 || ^10",
|
||||
"phpunit/phpunit": "^10.5 || ^11.5.3",
|
||||
"spatie/phpunit-snapshot-assertions": "^4 || ^5",
|
||||
"vimeo/psalm": "^5.4",
|
||||
"vlucas/phpdotenv": "^5"
|
||||
|
||||
+19
-16
@@ -85,14 +85,16 @@ return [
|
||||
|
||||
/*
|
||||
|--------------------------------------------------------------------------
|
||||
| Write model relation count properties
|
||||
| Write model relation count and exists properties
|
||||
|--------------------------------------------------------------------------
|
||||
|
|
||||
| Set to false to disable writing of relation count properties to model DocBlocks.
|
||||
| Set to false to disable writing of relation count and exists properties
|
||||
| to model DocBlocks.
|
||||
|
|
||||
*/
|
||||
|
||||
'write_model_relation_count_properties' => true,
|
||||
'write_model_relation_exists_properties' => false,
|
||||
|
||||
/*
|
||||
|--------------------------------------------------------------------------
|
||||
@@ -123,6 +125,7 @@ return [
|
||||
|
||||
'helper_files' => [
|
||||
base_path() . '/vendor/laravel/framework/src/Illuminate/Support/helpers.php',
|
||||
base_path() . '/vendor/laravel/framework/src/Illuminate/Foundation/helpers.php',
|
||||
],
|
||||
|
||||
/*
|
||||
@@ -273,6 +276,20 @@ return [
|
||||
*/
|
||||
'use_generics_annotations' => true,
|
||||
|
||||
/*
|
||||
|--------------------------------------------------------------------------
|
||||
| Default return types for macros
|
||||
|--------------------------------------------------------------------------
|
||||
|
|
||||
| Define default return types for macros without explicit return types.
|
||||
| e.g. `\Illuminate\Database\Query\Builder::class => 'static'`,
|
||||
| `\Illuminate\Support\Str::class => 'string'`
|
||||
|
|
||||
*/
|
||||
'macro_default_return_types' => [
|
||||
Illuminate\Http\Client\Factory::class => Illuminate\Http\Client\PendingRequest::class,
|
||||
],
|
||||
|
||||
/*
|
||||
|--------------------------------------------------------------------------
|
||||
| Additional relation types
|
||||
@@ -334,18 +351,4 @@ return [
|
||||
// 'ide-helper:models --nowrite',
|
||||
],
|
||||
|
||||
/*
|
||||
|--------------------------------------------------------------------------
|
||||
| Macroable Traits
|
||||
|--------------------------------------------------------------------------
|
||||
|
|
||||
| Define which traits should be considered capable of adding Macro.
|
||||
| You can add any custom trait that behaves like the original Laravel one.
|
||||
|
|
||||
*/
|
||||
'macroable_traits' => [
|
||||
Filament\Support\Concerns\Macroable::class,
|
||||
Spatie\Macroable\Macroable::class,
|
||||
],
|
||||
|
||||
];
|
||||
|
||||
@@ -72,7 +72,7 @@ function vsCodeGetConfigValue($value, $key, $configPaths)
|
||||
$key = collect(explode('.', $key));
|
||||
$key->pop();
|
||||
$key = $key->implode('.');
|
||||
$value = 'array(...)';
|
||||
$value = [];
|
||||
}
|
||||
|
||||
$nextKey = $keysToFind->shift();
|
||||
|
||||
@@ -1,56 +1,71 @@
|
||||
<?php
|
||||
|
||||
function vsCodeGetTranslationsFromFile($file, $path, $namespace)
|
||||
function vsCodeGetTranslationsFromFile(Symfony\Component\Finder\SplFileInfo $file, $path, $namespace)
|
||||
{
|
||||
$key = pathinfo($file, PATHINFO_FILENAME);
|
||||
|
||||
if ($namespace) {
|
||||
$key = "{$namespace}::{$key}";
|
||||
if ($file->getExtension() !== 'php') {
|
||||
return null;
|
||||
}
|
||||
|
||||
$lang = collect(explode(DIRECTORY_SEPARATOR, str_replace($path, '', $file)))
|
||||
->filter()
|
||||
->first();
|
||||
$filePath = $file->getRealPath();
|
||||
|
||||
$fileLines = Illuminate\Support\Facades\File::lines($file);
|
||||
$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 (substr($trimmed, 0, 2) === '/*') {
|
||||
if (str_starts_with($trimmed, '/*')) {
|
||||
$inComment = true;
|
||||
continue;
|
||||
}
|
||||
|
||||
if ($inComment) {
|
||||
if (substr($trimmed, -2) !== '*/') {
|
||||
continue;
|
||||
if (str_ends_with($trimmed, '*/')) {
|
||||
$inComment = false;
|
||||
}
|
||||
|
||||
$inComment = false;
|
||||
}
|
||||
|
||||
if (substr($trimmed, 0, 2) === '//') {
|
||||
continue;
|
||||
}
|
||||
|
||||
if (str_starts_with($trimmed, '//')) {
|
||||
continue;
|
||||
}
|
||||
$lines[] = [$index + 1, $trimmed];
|
||||
}
|
||||
|
||||
return [
|
||||
'k' => $key,
|
||||
'k' => $baseKey,
|
||||
'la' => $lang,
|
||||
'vs' => collect(Illuminate\Support\Arr::dot((Illuminate\Support\Arr::wrap(__($key, [], $lang)))))
|
||||
->map(
|
||||
fn ($value, $key) => vsCodeTranslationValue(
|
||||
$key,
|
||||
$value,
|
||||
str_replace(base_path(DIRECTORY_SEPARATOR), '', $file),
|
||||
$lines
|
||||
)
|
||||
'vs' => collect(Illuminate\Support\Arr::dot($translations))
|
||||
->map(
|
||||
fn ($value, $dotKey) => vsCodeTranslationValue(
|
||||
$dotKey,
|
||||
$value,
|
||||
str_replace(base_path(DIRECTORY_SEPARATOR), '', $filePath),
|
||||
$lines
|
||||
)
|
||||
)
|
||||
->filter(),
|
||||
];
|
||||
}
|
||||
@@ -63,13 +78,12 @@ function vsCodeTranslationValue($key, $value, $file, $lines): ?array
|
||||
|
||||
$lineNumber = 1;
|
||||
$keys = explode('.', $key);
|
||||
$index = 0;
|
||||
$currentKey = array_shift($keys);
|
||||
|
||||
foreach ($lines as $index => $line) {
|
||||
foreach ($lines as $line) {
|
||||
if (
|
||||
strpos($line[1], '"' . $currentKey . '"', 0) !== false ||
|
||||
strpos($line[1], "'" . $currentKey . "'", 0) !== false
|
||||
strpos($line[1], '"' . $currentKey . '"') !== false ||
|
||||
strpos($line[1], "'" . $currentKey . "'") !== false
|
||||
) {
|
||||
$lineNumber = $line[0];
|
||||
$currentKey = array_shift($keys);
|
||||
@@ -98,9 +112,9 @@ function vscodeCollectTranslations(string $path, ?string $namespace = null)
|
||||
return collect();
|
||||
}
|
||||
|
||||
return collect(Illuminate\Support\Facades\File::allFiles($realPath))->map(
|
||||
fn ($file) => vsCodeGetTranslationsFromFile($file, $path, $namespace)
|
||||
);
|
||||
return collect(Illuminate\Support\Facades\File::allFiles($realPath))
|
||||
->map(fn ($file) => vsCodeGetTranslationsFromFile($file, $path, $namespace))
|
||||
->filter();
|
||||
}
|
||||
|
||||
$loader = app('translator')->getLoader();
|
||||
@@ -110,7 +124,6 @@ $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));
|
||||
|
||||
@@ -125,6 +138,10 @@ $namespaced = collect($namespaces)->flatMap(
|
||||
$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}";
|
||||
|
||||
|
||||
@@ -29,7 +29,7 @@ $s3 = $s1 . $s2;
|
||||
<?php foreach ($namespaces_by_extends_ns as $namespace => $aliases) : ?>
|
||||
namespace <?= $namespace === '__root' ? '' : trim($namespace, '\\') ?> {
|
||||
<?php foreach ($aliases as $alias) : ?>
|
||||
<?php echo trim($alias->getDocComment($s1)) . "\n{$s1}" . $alias->getClassType() ?> <?= $alias->getExtendsClass() ?> {
|
||||
<?php echo trim($alias->getDocComment($s1)) . "\n{$s1}" . $alias->getClassType() ?> <?= $alias->getExtendsClass() ?><?php if ($alias->shouldExtendParentClass()): ?> extends <?= $alias->getParentClass() ?><?php endif; ?> {
|
||||
<?php foreach ($alias->getMethods() as $method) : ?>
|
||||
<?= trim($method->getDocComment($s2)) . "\n{$s2}" ?>public static function <?= $method->getName() ?>(<?= $method->getParamsWithDefault() ?>)
|
||||
{<?php if ($method->getDeclaringClass() !== $method->getRoot()) : ?>
|
||||
@@ -76,7 +76,7 @@ namespace <?= $namespace === '__root' ? '' : trim($namespace, '\\') ?> {
|
||||
|
||||
<?php endforeach; ?>
|
||||
|
||||
<?php foreach($real_time_facades as $name): ?>
|
||||
<?php foreach ($real_time_facades as $name): ?>
|
||||
<?php $nested = explode('\\', str_replace('\\' . class_basename($name), '', $name)); ?>
|
||||
namespace <?php echo implode('\\', $nested); ?> {
|
||||
/**
|
||||
|
||||
@@ -81,7 +81,7 @@ namespace PHPSTORM_META {
|
||||
|
||||
<?php if (isset($expectedArgumentSets)): ?>
|
||||
<?php foreach ($expectedArgumentSets as $name => $argumentsList) : ?>
|
||||
registerArgumentsSet('<?= $name ?>', <?php foreach ($argumentsList as $i => $arg) : ?><?php if($i % 5 == 0) {
|
||||
registerArgumentsSet('<?= $name ?>', <?php foreach ($argumentsList as $i => $arg) : ?><?php if ($i % 5 == 0) {
|
||||
echo "\n";
|
||||
} ?><?= var_export($arg, true); ?>,<?php endforeach; ?>);
|
||||
<?php endforeach; ?>
|
||||
|
||||
+45
-6
@@ -22,6 +22,7 @@ use Illuminate\Config\Repository as ConfigRepository;
|
||||
use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
|
||||
use Illuminate\Database\Query\Builder as QueryBuilder;
|
||||
use Illuminate\Support\Facades\Facade;
|
||||
use Illuminate\Support\Traits\Macroable;
|
||||
use ReflectionClass;
|
||||
use Throwable;
|
||||
|
||||
@@ -36,6 +37,7 @@ class Alias
|
||||
protected $classType = 'class';
|
||||
protected $short;
|
||||
protected $namespace = '__root';
|
||||
protected $parentClass;
|
||||
protected $root = null;
|
||||
protected $classes = [];
|
||||
protected $methods = [];
|
||||
@@ -46,8 +48,6 @@ class Alias
|
||||
protected $phpdoc = null;
|
||||
protected $classAliases = [];
|
||||
|
||||
protected $isMacroable = false;
|
||||
|
||||
/** @var ConfigRepository */
|
||||
protected $config;
|
||||
|
||||
@@ -62,13 +62,12 @@ class Alias
|
||||
* @param array $magicMethods
|
||||
* @param array $interfaces
|
||||
*/
|
||||
public function __construct($config, $alias, $facade, $magicMethods = [], $interfaces = [], $isMacroable = false)
|
||||
public function __construct($config, $alias, $facade, $magicMethods = [], $interfaces = [])
|
||||
{
|
||||
$this->alias = $alias;
|
||||
$this->magicMethods = $magicMethods;
|
||||
$this->interfaces = $interfaces;
|
||||
$this->config = $config;
|
||||
$this->isMacroable = $isMacroable;
|
||||
|
||||
// Make the class absolute
|
||||
$facade = '\\' . ltrim($facade, '\\');
|
||||
@@ -87,6 +86,7 @@ class Alias
|
||||
$this->detectNamespace();
|
||||
$this->detectClassType();
|
||||
$this->detectExtendsNamespace();
|
||||
$this->detectParentClass();
|
||||
|
||||
if (!empty($this->namespace)) {
|
||||
try {
|
||||
@@ -171,6 +171,25 @@ class Alias
|
||||
return $this->extendsNamespace;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the parent class of the class which this alias extends
|
||||
*
|
||||
* @return null|string
|
||||
*/
|
||||
public function getParentClass()
|
||||
{
|
||||
return $this->parentClass;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if this class should extend the parent class
|
||||
*/
|
||||
public function shouldExtendParentClass()
|
||||
{
|
||||
return $this->parentClass
|
||||
&& $this->getExtendsNamespace() !== '\\Illuminate\\Support\\Facades';
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the Alias by which this class is called
|
||||
*
|
||||
@@ -237,6 +256,8 @@ class Alias
|
||||
if ($fake !== $real) {
|
||||
$this->addClass(get_class($fake));
|
||||
}
|
||||
} catch (Throwable $throwable) {
|
||||
// Ignore error
|
||||
} finally {
|
||||
$facade::swap($real);
|
||||
}
|
||||
@@ -268,6 +289,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
|
||||
*/
|
||||
@@ -398,14 +431,20 @@ class Alias
|
||||
|
||||
// Check if the class is macroable
|
||||
// (Eloquent\Builder is also macroable but doesn't use Macroable trait)
|
||||
if ($this->isMacroable || $class === EloquentBuilder::class) {
|
||||
if ($class === EloquentBuilder::class || in_array(Macroable::class, $reflection->getTraitNames())) {
|
||||
$properties = $reflection->getStaticProperties();
|
||||
$macros = isset($properties['macros']) ? $properties['macros'] : [];
|
||||
foreach ($macros as $macro_name => $macro_func) {
|
||||
if (!in_array($macro_name, $this->usedMethods)) {
|
||||
try {
|
||||
$method = $this->getMacroFunction($macro_func);
|
||||
} catch (Throwable $e) {
|
||||
// Invalid method, skip
|
||||
continue;
|
||||
}
|
||||
// Add macros
|
||||
$this->methods[] = new Macro(
|
||||
$this->getMacroFunction($macro_func),
|
||||
$method,
|
||||
$this->alias,
|
||||
$reflection,
|
||||
$macro_name,
|
||||
|
||||
@@ -192,10 +192,19 @@ class MetaCommand extends Command
|
||||
*/
|
||||
protected function registerClassAutoloadExceptions(): callable
|
||||
{
|
||||
$autoloader = function ($class) {
|
||||
$aliases = array_filter([...$this->getAbstracts(), 'config'], fn ($abstract) => !str_contains($abstract, '\\'));
|
||||
|
||||
$autoloader = function ($class) use ($aliases) {
|
||||
// ignore aliases as they're meant to be resolved elsewhere
|
||||
if (in_array($class, $aliases, true)) {
|
||||
return;
|
||||
}
|
||||
|
||||
throw new \ReflectionException("Class '$class' not found.");
|
||||
};
|
||||
|
||||
spl_autoload_register($autoloader);
|
||||
|
||||
return $autoloader;
|
||||
}
|
||||
|
||||
@@ -233,7 +242,12 @@ class MetaCommand extends Command
|
||||
],
|
||||
[
|
||||
'class' => ['\Illuminate\Support\Facades\Route', '\Illuminate\Support\Facades\Auth', 'Illuminate\Foundation\Auth\Access\Authorizable'],
|
||||
'method' => ['can', 'cannot'],
|
||||
'method' => ['can', 'cannot', 'cant'],
|
||||
'argumentSet' => 'auth',
|
||||
],
|
||||
[
|
||||
'class' => ['Illuminate\Contracts\Auth\Access\Authorizable'],
|
||||
'method' => ['can'],
|
||||
'argumentSet' => 'auth',
|
||||
],
|
||||
[
|
||||
@@ -308,7 +322,13 @@ class MetaCommand extends Command
|
||||
{
|
||||
if (!isset($this->templateCache[$name])) {
|
||||
$file = __DIR__ . '/../../php-templates/' . basename($name) . '.php';
|
||||
$value = $this->files->requireOnce($file) ?: [];
|
||||
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);
|
||||
}
|
||||
|
||||
@@ -114,6 +114,7 @@ class ModelsCommand extends Command
|
||||
|
||||
protected $write_model_magic_where;
|
||||
protected $write_model_relation_count_properties;
|
||||
protected $write_model_relation_exists_properties;
|
||||
protected $properties = [];
|
||||
protected $methods = [];
|
||||
protected $write = false;
|
||||
@@ -173,6 +174,8 @@ class ModelsCommand extends Command
|
||||
$this->write_model_external_builder_methods = $this->laravel['config']->get('ide-helper.write_model_external_builder_methods', true);
|
||||
$this->write_model_relation_count_properties =
|
||||
$this->laravel['config']->get('ide-helper.write_model_relation_count_properties', true);
|
||||
$this->write_model_relation_exists_properties =
|
||||
$this->laravel['config']->get('ide-helper.write_model_relation_exists_properties', false);
|
||||
|
||||
$this->write = $this->write_mixin ? true : $this->write;
|
||||
//If filename is default and Write is not specified, ask what to do
|
||||
@@ -410,9 +413,6 @@ class ModelsCommand extends Command
|
||||
$params = [];
|
||||
|
||||
switch ($type) {
|
||||
case 'encrypted':
|
||||
$realType = 'mixed';
|
||||
break;
|
||||
case 'boolean':
|
||||
case 'bool':
|
||||
$realType = 'bool';
|
||||
@@ -420,6 +420,7 @@ class ModelsCommand extends Command
|
||||
case 'decimal':
|
||||
$realType = 'numeric';
|
||||
break;
|
||||
case 'encrypted':
|
||||
case 'string':
|
||||
case 'hashed':
|
||||
$realType = 'string';
|
||||
@@ -453,7 +454,7 @@ class ModelsCommand extends Command
|
||||
$realType = '\Illuminate\Support\Collection<array-key, mixed>';
|
||||
break;
|
||||
case AsArrayObject::class:
|
||||
$realType = '\ArrayObject<array-key, mixed>';
|
||||
$realType = '\Illuminate\Database\Eloquent\Casts\ArrayObject<array-key, mixed>';
|
||||
break;
|
||||
default:
|
||||
// In case of an optional custom cast parameter , only evaluate
|
||||
@@ -475,7 +476,11 @@ class ModelsCommand extends Command
|
||||
}
|
||||
|
||||
if (Str::startsWith($type, AsCollection::class)) {
|
||||
$realType = $this->getTypeInModel($model, $params[0] ?? null) ?? '\Illuminate\Support\Collection';
|
||||
$realType = $this->getTypeInModel($model, $params[0] ?? null) ?: '\Illuminate\Support\Collection';
|
||||
$relatedModel = $this->getTypeInModel($model, $params[1] ?? null);
|
||||
if ($relatedModel) {
|
||||
$realType = $this->getCollectionTypeHint($realType, $relatedModel);
|
||||
}
|
||||
}
|
||||
|
||||
if (Str::startsWith($type, AsEnumCollection::class)) {
|
||||
@@ -579,6 +584,8 @@ class ModelsCommand extends Command
|
||||
'float', 'real', 'float4',
|
||||
'double', 'float8' => 'float',
|
||||
|
||||
'decimal', 'numeric' => 'numeric',
|
||||
|
||||
default => 'string',
|
||||
};
|
||||
}
|
||||
@@ -628,6 +635,10 @@ class ModelsCommand extends Command
|
||||
)
|
||||
);
|
||||
});
|
||||
// https://github.com/barryvdh/laravel-ide-helper/issues/1664
|
||||
$reflections = array_filter($reflections, function (\ReflectionMethod $methodReflection) {
|
||||
return !($methodReflection->getName() === 'getUseFactoryAttribute');
|
||||
});
|
||||
sort($reflections);
|
||||
foreach ($reflections as $reflection) {
|
||||
$type = $this->getReturnTypeFromReflection($reflection);
|
||||
@@ -665,9 +676,11 @@ class ModelsCommand extends Command
|
||||
$comment = $this->getCommentFromDocBlock($reflection);
|
||||
$this->setProperty($name, null, null, true, $comment);
|
||||
}
|
||||
} elseif (Str::startsWith($method, 'scope') && $method !== 'scopeQuery' && $method !== 'scope' && $method !== 'scopes') {
|
||||
} elseif (!empty($reflection->getAttributes('Illuminate\Database\Eloquent\Attributes\Scope')) || (Str::startsWith($method, 'scope') && $method !== 'scopeQuery' && $method !== 'scope' && $method !== 'scopes')) {
|
||||
$scopeUsingAttribute = !empty($reflection->getAttributes('Illuminate\Database\Eloquent\Attributes\Scope'));
|
||||
|
||||
//Magic scope<name>Attribute
|
||||
$name = Str::camel(substr($method, 5));
|
||||
$name = $scopeUsingAttribute ? $method : Str::camel(substr($method, 5));
|
||||
if (!empty($name)) {
|
||||
$comment = $this->getCommentFromDocBlock($reflection);
|
||||
$args = $this->getParameters($reflection);
|
||||
@@ -812,6 +825,15 @@ class ModelsCommand extends Command
|
||||
// What kind of comments should be added to the relation count here?
|
||||
);
|
||||
}
|
||||
if ($this->write_model_relation_exists_properties) {
|
||||
$this->setProperty(
|
||||
Str::snake($method) . '_exists',
|
||||
'bool|null',
|
||||
true,
|
||||
false
|
||||
// What kind of comments should be added to the relation count here?
|
||||
);
|
||||
}
|
||||
} elseif (
|
||||
$relationReturnType === 'morphTo' ||
|
||||
(
|
||||
@@ -819,10 +841,16 @@ class ModelsCommand extends Command
|
||||
$relation === 'morphTo'
|
||||
)
|
||||
) {
|
||||
$matches = [];
|
||||
$returnType = $this->getReturnTypeFromDocBlock($reflection);
|
||||
if ($returnType !== null) {
|
||||
preg_match('/MorphTo<(?:contravariant\s+)?(.+?)(?:,|>)/i', $returnType, $matches);
|
||||
}
|
||||
|
||||
// Model isn't specified because relation is polymorphic
|
||||
$this->setProperty(
|
||||
$method,
|
||||
$this->getClassNameInDestinationFile($model, Model::class) . '|\Eloquent',
|
||||
$matches[1] ?? $this->getClassNameInDestinationFile($model, Model::class) . '|\Eloquent',
|
||||
true,
|
||||
null,
|
||||
$comment,
|
||||
@@ -861,7 +889,6 @@ class ModelsCommand extends Command
|
||||
|
||||
if (in_array($relation, ['hasOne', 'hasOneThrough', 'morphOne'], true)) {
|
||||
$defaultProp = $reflectionObj->getProperty('withDefault');
|
||||
$defaultProp->setAccessible(true);
|
||||
|
||||
return !$defaultProp->getValue($relationObj);
|
||||
}
|
||||
@@ -871,7 +898,6 @@ class ModelsCommand extends Command
|
||||
}
|
||||
|
||||
$fkProp = $reflectionObj->getProperty('foreignKey');
|
||||
$fkProp->setAccessible(true);
|
||||
|
||||
$enforceNullableRelation = $this->laravel['config']->get('ide-helper.enforce_nullable_relationships', true);
|
||||
|
||||
@@ -904,7 +930,6 @@ class ModelsCommand extends Command
|
||||
}
|
||||
|
||||
$fkProp = $reflectionObj->getProperty('foreignKey');
|
||||
$fkProp->setAccessible(true);
|
||||
|
||||
foreach (Arr::wrap($fkProp->getValue($relationObj)) as $foreignKey) {
|
||||
if (isset($this->nullableColumns[$foreignKey])) {
|
||||
@@ -1174,7 +1199,7 @@ class ModelsCommand extends Command
|
||||
$default = '[]';
|
||||
} elseif (is_null($default)) {
|
||||
$default = 'null';
|
||||
} elseif (is_int($default)) {
|
||||
} elseif (is_int($default) || is_float($default)) {
|
||||
//$default = $default;
|
||||
} elseif ($default instanceof \UnitEnum) {
|
||||
$default = '\\' . get_class($default) . '::' . $default->name;
|
||||
@@ -1257,9 +1282,6 @@ class ModelsCommand extends Command
|
||||
*/
|
||||
protected function getAttributeTypes(Model $model, \ReflectionMethod $reflectionMethod): Collection
|
||||
{
|
||||
// Private/protected ReflectionMethods require setAccessible prior to PHP 8.1
|
||||
$reflectionMethod->setAccessible(true);
|
||||
|
||||
/** @var Attribute $attribute */
|
||||
$attribute = $reflectionMethod->invoke($model);
|
||||
|
||||
@@ -1395,7 +1417,7 @@ class ModelsCommand extends Command
|
||||
if (in_array('Illuminate\\Database\\Eloquent\\SoftDeletes', $traits)) {
|
||||
$modelName = $this->getClassNameInDestinationFile($model, get_class($model));
|
||||
$builder = $this->getClassNameInDestinationFile($model, \Illuminate\Database\Eloquent\Builder::class);
|
||||
$this->setMethod('withTrashed', $builder . '<static>|' . $modelName, []);
|
||||
$this->setMethod('withTrashed', $builder . '<static>|' . $modelName, ['bool $withTrashed = true']);
|
||||
$this->setMethod('withoutTrashed', $builder . '<static>|' . $modelName, []);
|
||||
$this->setMethod('onlyTrashed', $builder . '<static>|' . $modelName, []);
|
||||
}
|
||||
|
||||
@@ -16,7 +16,6 @@ class Factories
|
||||
$factory = app(Factory::class);
|
||||
|
||||
$definitions = (new ReflectionClass(Factory::class))->getProperty('definitions');
|
||||
$definitions->setAccessible(true);
|
||||
|
||||
foreach ($definitions->getValue($factory) as $factory_target => $config) {
|
||||
try {
|
||||
|
||||
+29
-18
@@ -35,7 +35,6 @@ class Generator
|
||||
protected $magic = [];
|
||||
protected $interfaces = [];
|
||||
protected $helpers;
|
||||
protected array $macroableTraits = [];
|
||||
|
||||
/**
|
||||
* @param \Illuminate\Config\Repository $config
|
||||
@@ -58,9 +57,13 @@ class Generator
|
||||
// Find the drivers to add to the extra/interfaces
|
||||
$this->detectDrivers();
|
||||
|
||||
$this->extra = array_merge($this->extra, $this->config->get('ide-helper.extra'), []);
|
||||
$this->magic = array_merge($this->magic, $this->config->get('ide-helper.magic'), []);
|
||||
$this->interfaces = array_merge($this->interfaces, $this->config->get('ide-helper.interfaces'), []);
|
||||
$this->extra = array_merge($this->extra, $this->config->get('ide-helper.extra', []));
|
||||
$this->magic = array_merge($this->magic, $this->config->get('ide-helper.magic', []));
|
||||
$this->interfaces = array_merge($this->interfaces, $this->config->get('ide-helper.interfaces', []));
|
||||
Macro::setDefaultReturnTypes($this->config->get('ide-helper.macro_default_return_types', [
|
||||
\Illuminate\Http\Client\Factory::class => \Illuminate\Http\Client\PendingRequest::class,
|
||||
]));
|
||||
|
||||
// Make all interface classes absolute
|
||||
foreach ($this->interfaces as &$interface) {
|
||||
$interface = '\\' . ltrim($interface, '\\');
|
||||
@@ -80,7 +83,7 @@ class Generator
|
||||
->with('namespaces_by_extends_ns', $this->getAliasesByExtendsNamespace())
|
||||
->with('namespaces_by_alias_ns', $this->getAliasesByAliasNamespace())
|
||||
->with('real_time_facades', $this->getRealTimeFacades())
|
||||
->with('helpers', $this->helpers)
|
||||
->with('helpers', $this->detectHelpers())
|
||||
->with('include_fluent', $this->config->get('ide-helper.include_fluent', true))
|
||||
->with('factories', $this->config->get('ide-helper.include_factory_builders') ? Factories::all() : [])
|
||||
->render();
|
||||
@@ -112,6 +115,24 @@ class Generator
|
||||
->render();
|
||||
}
|
||||
|
||||
protected function detectHelpers()
|
||||
{
|
||||
$helpers = $this->helpers;
|
||||
|
||||
$replacements = [
|
||||
'($guard is null ? \Illuminate\Contracts\Auth\Factory : \Illuminate\Contracts\Auth\StatefulGuard)' => '\\Auth',
|
||||
];
|
||||
foreach ($replacements as $search => $replace) {
|
||||
$helpers = Str::replace(
|
||||
"@return {$search}",
|
||||
"@return $replace|$search",
|
||||
$helpers
|
||||
);
|
||||
}
|
||||
|
||||
return $helpers;
|
||||
}
|
||||
|
||||
protected function detectDrivers()
|
||||
{
|
||||
$defaultUserModel = config('auth.providers.users.model', config('auth.model', 'App\User'));
|
||||
@@ -342,7 +363,7 @@ class Generator
|
||||
continue;
|
||||
}
|
||||
|
||||
$aliases[] = new Alias($this->config, $class, $class, [], $this->interfaces, true);
|
||||
$aliases[] = new Alias($this->config, $class, $class, [], $this->interfaces);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -364,18 +385,8 @@ class Generator
|
||||
->filter(function ($class) {
|
||||
$traits = class_uses_recursive($class);
|
||||
|
||||
if (isset($traits[Macroable::class])) {
|
||||
return true;
|
||||
}
|
||||
|
||||
// Filter only classes with a macroable trait
|
||||
foreach ($this->config->get('ide-helper.macroable_traits', []) as $trait) {
|
||||
if (isset($traits[$trait])) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
return false;
|
||||
// Filter only classes with the macroable trait
|
||||
return isset($traits[Macroable::class]);
|
||||
})
|
||||
->filter(function ($class) use ($aliases) {
|
||||
$class = Str::start($class, '\\');
|
||||
|
||||
+7
-6
@@ -5,14 +5,11 @@ namespace Barryvdh\LaravelIdeHelper;
|
||||
use Barryvdh\Reflection\DocBlock;
|
||||
use Barryvdh\Reflection\DocBlock\Tag;
|
||||
use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
|
||||
use Illuminate\Http\Client\PendingRequest;
|
||||
use Illuminate\Support\Collection;
|
||||
|
||||
class Macro extends Method
|
||||
{
|
||||
protected $macroDefaults = [
|
||||
\Illuminate\Http\Client\Factory::class => PendingRequest::class,
|
||||
];
|
||||
protected static $macroDefaults = [];
|
||||
|
||||
/**
|
||||
* Macro constructor.
|
||||
@@ -37,6 +34,10 @@ class Macro extends Method
|
||||
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
|
||||
*/
|
||||
@@ -84,8 +85,8 @@ class Macro extends Method
|
||||
}
|
||||
|
||||
$class = ltrim($this->declaringClassName, '\\');
|
||||
if (!$this->phpdoc->hasTag('return') && isset($this->macroDefaults[$class])) {
|
||||
$type = $this->macroDefaults[$class];
|
||||
if (!$this->phpdoc->hasTag('return') && isset(static::$macroDefaults[$class])) {
|
||||
$type = static::$macroDefaults[$class];
|
||||
$this->phpdoc->appendTag(Tag::createInstance("@return {$type}"));
|
||||
}
|
||||
}
|
||||
|
||||
+2
-2
@@ -178,7 +178,7 @@ class Method
|
||||
/**
|
||||
* Get the parameters for this method
|
||||
*
|
||||
* @param bool $implode Wether to implode the array or not
|
||||
* @param bool $implode Whether to implode the array or not
|
||||
* @return string
|
||||
*/
|
||||
public function getParams($implode = true)
|
||||
@@ -208,7 +208,7 @@ class Method
|
||||
/**
|
||||
* Get the parameters for this method including default values
|
||||
*
|
||||
* @param bool $implode Wether to implode the array or not
|
||||
* @param bool $implode Whether to implode the array or not
|
||||
* @return string
|
||||
*/
|
||||
public function getParamsWithDefault($implode = true)
|
||||
|
||||
+66
-1
@@ -7,7 +7,9 @@ namespace Barryvdh\LaravelIdeHelper\Tests;
|
||||
use Barryvdh\LaravelIdeHelper\Alias;
|
||||
use Barryvdh\LaravelIdeHelper\Macro;
|
||||
use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
|
||||
use Illuminate\Database\Query\Builder;
|
||||
use Illuminate\Support\Arr;
|
||||
use Illuminate\Support\Facades\Facade;
|
||||
|
||||
/**
|
||||
* @internal
|
||||
@@ -15,6 +17,31 @@ use Illuminate\Support\Arr;
|
||||
*/
|
||||
class AliasTest extends TestCase
|
||||
{
|
||||
/**
|
||||
* @covers ::detectMethods
|
||||
*/
|
||||
public function testDetectMethodsMacroableMacros(): void
|
||||
{
|
||||
// Mock
|
||||
$macro = __FUNCTION__;
|
||||
$alias = new AliasMock();
|
||||
|
||||
// Macros
|
||||
Builder::macro(
|
||||
$macro,
|
||||
function () {
|
||||
// empty
|
||||
}
|
||||
);
|
||||
|
||||
// Prepare
|
||||
$alias->setClasses([Builder::class]);
|
||||
$alias->detectMethods();
|
||||
|
||||
// Test
|
||||
$this->assertNotNull($this->getAliasMacro($alias, Builder::class, $macro));
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers ::detectMethods
|
||||
*/
|
||||
@@ -24,7 +51,7 @@ class AliasTest extends TestCase
|
||||
$macro = __FUNCTION__;
|
||||
$alias = new AliasMock();
|
||||
|
||||
// Macrosx
|
||||
// Macros
|
||||
EloquentBuilder::macro(
|
||||
$macro,
|
||||
function () {
|
||||
@@ -40,6 +67,22 @@ class AliasTest extends TestCase
|
||||
$this->assertNotNull($this->getAliasMacro($alias, EloquentBuilder::class, $macro));
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers ::detectFake
|
||||
*/
|
||||
public function testNoExceptionOnRequiredFakeParameters(): void
|
||||
{
|
||||
// Mock
|
||||
$alias = new AliasMock();
|
||||
|
||||
// Prepare
|
||||
$alias->setFacade(MockFacade::class);
|
||||
$this->expectNotToPerformAssertions();
|
||||
|
||||
// Test
|
||||
$alias->detectFake();
|
||||
}
|
||||
|
||||
/**
|
||||
* @covers ::detectTemplateNames
|
||||
*/
|
||||
@@ -92,4 +135,26 @@ class AliasMock extends Alias
|
||||
{
|
||||
parent::detectMethods();
|
||||
}
|
||||
|
||||
public function detectFake()
|
||||
{
|
||||
parent::detectFake();
|
||||
}
|
||||
|
||||
public function setFacade(string $facade)
|
||||
{
|
||||
$this->facade = $facade;
|
||||
}
|
||||
}
|
||||
|
||||
class MockFacade extends Facade
|
||||
{
|
||||
protected static function getFacadeAccessor()
|
||||
{
|
||||
return '';
|
||||
}
|
||||
|
||||
public static function fake(string $test1, $test2 = null)
|
||||
{
|
||||
}
|
||||
}
|
||||
|
||||
@@ -5,7 +5,6 @@ declare(strict_types=1);
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\GeneratorCommand;
|
||||
|
||||
use Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider;
|
||||
use Barryvdh\LaravelIdeHelper\Tests\SnapshotPhpDriver;
|
||||
use Barryvdh\LaravelIdeHelper\Tests\TestCase;
|
||||
|
||||
abstract class AbstractGeneratorCommand extends TestCase
|
||||
@@ -27,9 +26,4 @@ abstract class AbstractGeneratorCommand extends TestCase
|
||||
{
|
||||
return [IdeHelperServiceProvider::class];
|
||||
}
|
||||
|
||||
protected function assertMatchesMockedSnapshot()
|
||||
{
|
||||
$this->assertMatchesSnapshot($this->mockFilesystemOutput, new SnapshotPhpDriver());
|
||||
}
|
||||
}
|
||||
|
||||
@@ -6,18 +6,30 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\GeneratorCommand\GenerateIdeHe
|
||||
|
||||
use Barryvdh\LaravelIdeHelper\Console\GeneratorCommand;
|
||||
use Barryvdh\LaravelIdeHelper\Tests\Console\GeneratorCommand\AbstractGeneratorCommand;
|
||||
use Illuminate\Support\Arr;
|
||||
use Illuminate\Support\Facades\DB;
|
||||
|
||||
class Test extends AbstractGeneratorCommand
|
||||
{
|
||||
public function testGenerator(): void
|
||||
{
|
||||
Arr::macro('arr_custom_macro', function () {
|
||||
});
|
||||
DB::macro('db_custom_macro', function () {
|
||||
});
|
||||
$this->app['config']->set('ide-helper.macro_default_return_types', [Arr::class => 'Custom_Fake_Class']);
|
||||
|
||||
$command = $this->app->make(GeneratorCommand::class);
|
||||
|
||||
$tester = $this->runCommand($command);
|
||||
|
||||
$this->assertSame(0, $tester->getStatusCode());
|
||||
|
||||
$this->assertStringContainsString('A new helper file was written to _ide_helper.php', $tester->getDisplay());
|
||||
$this->assertStringContainsString('public static function configure($basePath = null)', $this->mockFilesystemOutput);
|
||||
$this->assertStringContainsString('* @return \Custom_Fake_Class', $this->mockFilesystemOutput);
|
||||
$this->assertStringContainsString('public static function arr_custom_macro()', $this->mockFilesystemOutput);
|
||||
$this->assertStringContainsString('public static function db_custom_macro()', $this->mockFilesystemOutput);
|
||||
}
|
||||
|
||||
public function testFilename(): void
|
||||
|
||||
@@ -5,7 +5,6 @@ declare(strict_types=1);
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand;
|
||||
|
||||
use Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider;
|
||||
use Barryvdh\LaravelIdeHelper\Tests\SnapshotPhpDriver;
|
||||
use Barryvdh\LaravelIdeHelper\Tests\TestCase;
|
||||
|
||||
abstract class AbstractModelsCommand extends TestCase
|
||||
@@ -51,10 +50,7 @@ abstract class AbstractModelsCommand extends TestCase
|
||||
|
||||
// Don't override integer -> int for tests
|
||||
$config->set('ide-helper.type_overrides', []);
|
||||
}
|
||||
|
||||
protected function assertMatchesMockedSnapshot()
|
||||
{
|
||||
$this->assertMatchesSnapshot($this->mockFilesystemOutput, new SnapshotPhpDriver());
|
||||
$config->set('ide-helper.write_model_relation_exists_properties', true);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,21 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts\Collections;
|
||||
|
||||
use Illuminate\Contracts\Support\Arrayable;
|
||||
use JsonSerializable;
|
||||
|
||||
class AdvancedCastMap implements Arrayable, JsonSerializable
|
||||
{
|
||||
public function toArray(): array
|
||||
{
|
||||
return [];
|
||||
}
|
||||
|
||||
public function jsonSerialize(): array
|
||||
{
|
||||
return $this->toArray();
|
||||
}
|
||||
}
|
||||
@@ -5,6 +5,7 @@ declare(strict_types=1);
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts\Models;
|
||||
|
||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts\Collections\AdvancedCastCollection;
|
||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts\Collections\AdvancedCastMap;
|
||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts\Enums\AdvancedCastEnum;
|
||||
use Illuminate\Database\Eloquent\Casts\AsArrayObject;
|
||||
use Illuminate\Database\Eloquent\Casts\AsCollection;
|
||||
@@ -29,7 +30,9 @@ class AdvancedCast extends Model
|
||||
'cast_to_encrypted_json' => 'encrypted:json',
|
||||
'cast_to_encrypted_object' => 'encrypted:object',
|
||||
'cast_to_as_collection' => AsCollection::class,
|
||||
'cast_to_as_collection_of' => AsCollection::class . ':,' . AdvancedCastMap::class, // since 12.10
|
||||
'cast_to_as_collection_using' => AsCollection::using(AdvancedCastCollection::class),
|
||||
'cast_to_as_collection_using_and_map' => AsCollection::class . ':' . AdvancedCastCollection::class . ',' . AdvancedCastMap::class, // since 12.10
|
||||
'cast_to_as_enum_collection' => AsEnumCollection::class,
|
||||
'cast_to_as_enum_collection_of' => AsEnumCollection::of(AdvancedCastEnum::class),
|
||||
'cast_to_as_array_object' => AsArrayObject::class,
|
||||
|
||||
@@ -5,6 +5,7 @@ declare(strict_types=1);
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts\Models;
|
||||
|
||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts\Collections\AdvancedCastCollection;
|
||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts\Collections\AdvancedCastMap;
|
||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts\Enums\AdvancedCastEnum;
|
||||
use Illuminate\Database\Eloquent\Casts\AsArrayObject;
|
||||
use Illuminate\Database\Eloquent\Casts\AsCollection;
|
||||
@@ -12,8 +13,6 @@ use Illuminate\Database\Eloquent\Casts\AsEnumCollection;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property \Illuminate\Support\Carbon $cast_to_date_serialization
|
||||
* @property \Illuminate\Support\Carbon $cast_to_datetime_serialization
|
||||
* @property \Illuminate\Support\Carbon $cast_to_custom_datetime
|
||||
@@ -21,15 +20,17 @@ use Illuminate\Database\Eloquent\Model;
|
||||
* @property \Carbon\CarbonImmutable $cast_to_immutable_custom_datetime
|
||||
* @property \Carbon\CarbonImmutable $cast_to_immutable_datetime
|
||||
* @property int $cast_to_timestamp
|
||||
* @property mixed $cast_to_encrypted
|
||||
* @property string $cast_to_encrypted
|
||||
* @property array<array-key, mixed> $cast_to_encrypted_array
|
||||
* @property \Illuminate\Support\Collection<array-key, mixed> $cast_to_encrypted_collection
|
||||
* @property array<array-key, mixed> $cast_to_encrypted_json
|
||||
* @property object $cast_to_encrypted_object
|
||||
* @property \Illuminate\Support\Collection $cast_to_as_collection
|
||||
* @property \Illuminate\Support\Collection $cast_to_as_enum_collection
|
||||
* @property \ArrayObject<array-key, mixed> $cast_to_as_array_object
|
||||
* @property \Illuminate\Database\Eloquent\Casts\ArrayObject<array-key, mixed> $cast_to_as_array_object
|
||||
* @property \Illuminate\Support\Collection<int, AdvancedCastMap> $cast_to_as_collection_of
|
||||
* @property AdvancedCastCollection $cast_to_as_collection_using
|
||||
* @property AdvancedCastCollection<int, AdvancedCastMap> $cast_to_as_collection_using_and_map
|
||||
* @property \Illuminate\Support\Collection<int, AdvancedCastEnum> $cast_to_as_enum_collection_of
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|AdvancedCast newModelQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|AdvancedCast newQuery()
|
||||
@@ -69,7 +70,9 @@ class AdvancedCast extends Model
|
||||
'cast_to_encrypted_json' => 'encrypted:json',
|
||||
'cast_to_encrypted_object' => 'encrypted:object',
|
||||
'cast_to_as_collection' => AsCollection::class,
|
||||
'cast_to_as_collection_of' => AsCollection::class . ':,' . AdvancedCastMap::class, // since 12.10
|
||||
'cast_to_as_collection_using' => AsCollection::using(AdvancedCastCollection::class),
|
||||
'cast_to_as_collection_using_and_map' => AsCollection::class . ':' . AdvancedCastCollection::class . ',' . AdvancedCastMap::class, // since 12.10
|
||||
'cast_to_as_enum_collection' => AsEnumCollection::class,
|
||||
'cast_to_as_enum_collection_of' => AsEnumCollection::of(AdvancedCastEnum::class),
|
||||
'cast_to_as_array_object' => AsArrayObject::class,
|
||||
|
||||
@@ -7,8 +7,6 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AllowGlobDirecto
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property int $id
|
||||
* @property string|null $char_nullable
|
||||
* @property string $char_not_nullable
|
||||
@@ -44,8 +42,8 @@ use Illuminate\Database\Eloquent\Model;
|
||||
* @property float $float_not_nullable
|
||||
* @property float|null $double_nullable
|
||||
* @property float $double_not_nullable
|
||||
* @property string|null $decimal_nullable
|
||||
* @property string $decimal_not_nullable
|
||||
* @property numeric|null $decimal_nullable
|
||||
* @property numeric $decimal_not_nullable
|
||||
* @property int|null $boolean_nullable
|
||||
* @property int $boolean_not_nullable
|
||||
* @property string|null $enum_nullable
|
||||
|
||||
@@ -7,8 +7,6 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\ArrayCastsWithCo
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property array<int, string>|null $cast_to_array -- These three should not be duplicated
|
||||
* @property array<int, string> $cast_to_json some-description
|
||||
* @property \Illuminate\Support\Collection<int, string> $cast_to_collection some-description
|
||||
|
||||
@@ -8,8 +8,6 @@ use Illuminate\Database\Eloquent\Casts\Attribute;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property int $id
|
||||
* @property string|null $name
|
||||
* @property string|null $name_read
|
||||
@@ -85,8 +83,6 @@ use Illuminate\Database\Eloquent\Casts\Attribute;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property int $id
|
||||
* @property int $diverging_type_hinted_get_and_set
|
||||
* @property string|null $name
|
||||
|
||||
@@ -10,8 +10,6 @@ use Illuminate\Database\Eloquent\Relations\HasOne;
|
||||
use Illuminate\Database\Eloquent\Relations\MorphTo;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property int $id
|
||||
* @property string $both_same_name I'm a getter
|
||||
* @property string $both_without_getter_comment
|
||||
@@ -23,6 +21,7 @@ use Illuminate\Database\Eloquent\Relations\MorphTo;
|
||||
* @property-read string $not_comment
|
||||
* @property-read \Illuminate\Database\Eloquent\Collection<int, Simple> $relationHasMany HasMany relations.
|
||||
* @property-read int|null $relation_has_many_count
|
||||
* @property-read bool|null $relation_has_many_exists
|
||||
* @property-read Simple|null $relationHasOne Others relations.
|
||||
* @property-read Model|\Eloquent $relationMorphTo MorphTo relations.
|
||||
* @property-write mixed $first_name Set the user's first name.
|
||||
|
||||
@@ -9,11 +9,10 @@ use Illuminate\Database\Eloquent\Model;
|
||||
use Illuminate\Database\Eloquent\Relations\HasMany;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property int $id
|
||||
* @property-read SimpleCollection<int, Simple> $relationHasMany
|
||||
* @property-read int|null $relation_has_many_count
|
||||
* @property-read bool|null $relation_has_many_exists
|
||||
* @method static SimpleCollection<int, static> all($columns = ['*'])
|
||||
* @method static SimpleCollection<int, static> get($columns = ['*'])
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple newModelQuery()
|
||||
|
||||
@@ -7,8 +7,6 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\CustomDate\Model
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property \Carbon\CarbonImmutable|null $created_at
|
||||
* @property \Carbon\CarbonImmutable|null $updated_at
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|CustomDate newModelQuery()
|
||||
|
||||
+2
-4
@@ -13,8 +13,6 @@
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\DoesNotGeneratePhpdocWithExternalEloquentBuilder\Models{
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property int $id
|
||||
* @property string|null $char_nullable
|
||||
* @property string $char_not_nullable
|
||||
@@ -50,8 +48,8 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\DoesNotGenerateP
|
||||
* @property float $float_not_nullable
|
||||
* @property float|null $double_nullable
|
||||
* @property float $double_not_nullable
|
||||
* @property string|null $decimal_nullable
|
||||
* @property string $decimal_not_nullable
|
||||
* @property numeric|null $decimal_nullable
|
||||
* @property numeric $decimal_not_nullable
|
||||
* @property int|null $boolean_nullable
|
||||
* @property int $boolean_not_nullable
|
||||
* @property string|null $enum_nullable
|
||||
|
||||
@@ -10,10 +10,9 @@ use Illuminate\Database\Eloquent\Relations\HasMany;
|
||||
use Illuminate\Database\Eloquent\Relations\HasOne;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property-read \Illuminate\Database\Eloquent\Collection<int, Dynamic> $regularHasMany
|
||||
* @property-read int|null $regular_has_many_count
|
||||
* @property-read bool|null $regular_has_many_exists
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Dynamic newModelQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Dynamic newQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Dynamic query()
|
||||
|
||||
@@ -9,8 +9,6 @@ use Illuminate\Database\Eloquent\Factories\HasFactory;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @method static \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\CustomSpace\ModelWithCustomNamespaceFactory factory($count = null, $state = [])
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|ModelWithCustomNamespace newModelQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|ModelWithCustomNamespace newQuery()
|
||||
@@ -41,8 +39,6 @@ use Illuminate\Database\Eloquent\Factories\HasFactory;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @method static \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Factories\ModelWithFactoryFactory factory($count = null, $state = [])
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|ModelWithFactory newModelQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|ModelWithFactory newQuery()
|
||||
@@ -60,8 +56,6 @@ declare(strict_types=1);
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Models;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @method static \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Factories\ModelWithNestedFactoryFactory factory($count = null, $state = [])
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|ModelWithNestedFactory newModelQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|ModelWithNestedFactory newQuery()
|
||||
@@ -81,8 +75,6 @@ use Illuminate\Database\Eloquent\Factories\HasFactory;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|ModelWithoutFactory newModelQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|ModelWithoutFactory newQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|ModelWithoutFactory query()
|
||||
|
||||
+2
-4
@@ -9,8 +9,6 @@ use Illuminate\Database\Eloquent\Builder;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property int $id
|
||||
* @property string|null $char_nullable
|
||||
* @property string $char_not_nullable
|
||||
@@ -46,8 +44,8 @@ use Illuminate\Database\Eloquent\Model;
|
||||
* @property float $float_not_nullable
|
||||
* @property float|null $double_nullable
|
||||
* @property float $double_not_nullable
|
||||
* @property string|null $decimal_nullable
|
||||
* @property string $decimal_not_nullable
|
||||
* @property numeric|null $decimal_nullable
|
||||
* @property numeric $decimal_not_nullable
|
||||
* @property int|null $boolean_nullable
|
||||
* @property int $boolean_not_nullable
|
||||
* @property string|null $enum_nullable
|
||||
|
||||
@@ -7,8 +7,6 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateBasicPhp
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property int $id
|
||||
* @property string|null $char_nullable
|
||||
* @property string $char_not_nullable
|
||||
@@ -44,8 +42,8 @@ use Illuminate\Database\Eloquent\Model;
|
||||
* @property float $float_not_nullable
|
||||
* @property float|null $double_nullable
|
||||
* @property float $double_not_nullable
|
||||
* @property string|null $decimal_nullable
|
||||
* @property string $decimal_not_nullable
|
||||
* @property numeric|null $decimal_nullable
|
||||
* @property numeric $decimal_not_nullable
|
||||
* @property int|null $boolean_nullable
|
||||
* @property int $boolean_not_nullable
|
||||
* @property string|null $enum_nullable
|
||||
|
||||
+2
-4
@@ -7,8 +7,6 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateBasicPhp
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property int $id
|
||||
* @property string|null $charNullable
|
||||
* @property string $charNotNullable
|
||||
@@ -44,8 +42,8 @@ use Illuminate\Database\Eloquent\Model;
|
||||
* @property float $floatNotNullable
|
||||
* @property float|null $doubleNullable
|
||||
* @property float $doubleNotNullable
|
||||
* @property string|null $decimalNullable
|
||||
* @property string $decimalNotNullable
|
||||
* @property numeric|null $decimalNullable
|
||||
* @property numeric $decimalNotNullable
|
||||
* @property int|null $booleanNullable
|
||||
* @property int $booleanNotNullable
|
||||
* @property string|null $enumNullable
|
||||
|
||||
+2
-4
@@ -7,8 +7,6 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateBasicPhp
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property int $id
|
||||
* @property string|null $char_nullable
|
||||
* @property string $char_not_nullable
|
||||
@@ -44,8 +42,8 @@ use Illuminate\Database\Eloquent\Model;
|
||||
* @property float $float_not_nullable
|
||||
* @property float|null $double_nullable
|
||||
* @property float $double_not_nullable
|
||||
* @property string|null $decimal_nullable
|
||||
* @property string $decimal_not_nullable
|
||||
* @property numeric|null $decimal_nullable
|
||||
* @property numeric $decimal_not_nullable
|
||||
* @property int|null $boolean_nullable
|
||||
* @property int $boolean_not_nullable
|
||||
* @property string|null $enum_nullable
|
||||
|
||||
@@ -67,8 +67,6 @@ class WithCollection extends Model
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateMixinCollection\Models{
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property-read \Illuminate\Support\Collection<int, string> $collection
|
||||
* @property-read \Illuminate\Support\Collection<\Illuminate\Support\Collection, \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateMixinCollection\NonModels\CollectionModel<\Illuminate\Support\Collection, \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateMixinCollection\NonModels\CollectionModel<int, \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateMixinCollection\NonModels\NonModel>>> $collection_with_nested_template
|
||||
* @property-read \Illuminate\Support\Collection<int, \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateMixinCollection\NonModels\NonModel> $collection_with_non_model_template
|
||||
|
||||
@@ -0,0 +1,251 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpDocWithTypedScopeParameter\Models;
|
||||
|
||||
use Illuminate\Database\Eloquent\Builder;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
class Comment extends Model
|
||||
{
|
||||
/**
|
||||
* @comment Scope with required boolean parameter
|
||||
*/
|
||||
protected function scopeTyped01(Builder $query, bool $value)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional boolean parameter and default true
|
||||
*/
|
||||
protected function scopeTyped02(Builder $query, bool $value = true)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional boolean parameter and default false
|
||||
*/
|
||||
protected function scopeTyped03(Builder $query, bool $value = false)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with required string parameter
|
||||
*/
|
||||
protected function scopeTyped04(Builder $query, string $value)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional string parameter and default value
|
||||
*/
|
||||
protected function scopeTyped05(Builder $query, string $value = 'dummy123')
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with required integer parameter
|
||||
*/
|
||||
protected function scopeTyped06(Builder $query, int $value)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional integer parameter and default positive value
|
||||
*/
|
||||
protected function scopeTyped07(Builder $query, int $value = 123)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional integer parameter and default negative value
|
||||
*/
|
||||
protected function scopeTyped08(Builder $query, int $value = -123)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with required float parameter
|
||||
*/
|
||||
protected function scopeTyped09(Builder $query, float $value)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional float parameter and default positive integer value
|
||||
*/
|
||||
protected function scopeTyped10(Builder $query, float $value = 123)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional float parameter and default negative integer value
|
||||
*/
|
||||
protected function scopeTyped11(Builder $query, float $value = -123)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional float parameter and default positive float value
|
||||
*/
|
||||
protected function scopeTyped12(Builder $query, float $value = 1.23)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional float parameter and default negative float value
|
||||
*/
|
||||
protected function scopeTyped13(Builder $query, float $value = -1.23)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with required nullable boolean parameter
|
||||
*/
|
||||
protected function scopeTyped14(Builder $query, ?bool $value)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional nullable boolean parameter and default true
|
||||
*/
|
||||
protected function scopeTyped15(Builder $query, ?bool $value = true)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional nullable boolean parameter and default false
|
||||
*/
|
||||
protected function scopeTyped16(Builder $query, ?bool $value = false)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional nullable boolean parameter and default null
|
||||
*/
|
||||
protected function scopeTyped17(Builder $query, ?bool $value = null)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with required nullable string parameter
|
||||
*/
|
||||
protected function scopeTyped18(Builder $query, ?string $value)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional nullable string parameter and default value
|
||||
*/
|
||||
protected function scopeTyped19(Builder $query, ?string $value = 'dummy123')
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional nullable string parameter and default null
|
||||
*/
|
||||
protected function scopeTyped20(Builder $query, ?string $value = null)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with required nullable integer parameter
|
||||
*/
|
||||
protected function scopeTyped21(Builder $query, ?int $value)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional nullable integer parameter and default positive value
|
||||
*/
|
||||
protected function scopeTyped22(Builder $query, ?int $value = 123)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional nullable integer parameter and default negative value
|
||||
*/
|
||||
protected function scopeTyped23(Builder $query, ?int $value = -123)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional nullable integer parameter and default null
|
||||
*/
|
||||
protected function scopeTyped24(Builder $query, ?int $value = null)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with required float nullable parameter
|
||||
*/
|
||||
protected function scopeTyped25(Builder $query, ?float $value)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional nullable float parameter and default positive integer value
|
||||
*/
|
||||
protected function scopeTyped26(Builder $query, ?float $value = 123)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional nullable float parameter and default negative integer value
|
||||
*/
|
||||
protected function scopeTyped27(Builder $query, ?float $value = -123)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional float parameter and default positive float value
|
||||
*/
|
||||
protected function scopeTyped28(Builder $query, ?float $value = 1.23)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional float parameter and default negative float value
|
||||
*/
|
||||
protected function scopeTyped29(Builder $query, ?float $value = -1.23)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional float parameter and default null
|
||||
*/
|
||||
protected function scopeTyped30(Builder $query, ?float $value = null)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,24 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpDocWithTypedScopeParameter;
|
||||
|
||||
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
|
||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AbstractModelsCommand;
|
||||
|
||||
class Test extends AbstractModelsCommand
|
||||
{
|
||||
public function test(): void
|
||||
{
|
||||
$command = $this->app->make(ModelsCommand::class);
|
||||
|
||||
$tester = $this->runCommand($command, [
|
||||
'--write' => true,
|
||||
]);
|
||||
|
||||
$this->assertSame(0, $tester->getStatusCode());
|
||||
$this->assertStringContainsString('Written new phpDocBlock to', $tester->getDisplay());
|
||||
$this->assertMatchesMockedSnapshot();
|
||||
}
|
||||
}
|
||||
+287
@@ -0,0 +1,287 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpDocWithTypedScopeParameter\Models;
|
||||
|
||||
use Illuminate\Database\Eloquent\Builder;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
* @method static Builder<static>|Comment newModelQuery()
|
||||
* @method static Builder<static>|Comment newQuery()
|
||||
* @method static Builder<static>|Comment query()
|
||||
* @method static Builder<static>|Comment typed01(bool $value) Scope with required boolean parameter
|
||||
* @method static Builder<static>|Comment typed02(bool $value = true) Scope with optional boolean parameter and default true
|
||||
* @method static Builder<static>|Comment typed03(bool $value = false) Scope with optional boolean parameter and default false
|
||||
* @method static Builder<static>|Comment typed04(string $value) Scope with required string parameter
|
||||
* @method static Builder<static>|Comment typed05(string $value = 'dummy123') Scope with optional string parameter and default value
|
||||
* @method static Builder<static>|Comment typed06(int $value) Scope with required integer parameter
|
||||
* @method static Builder<static>|Comment typed07(int $value = 123) Scope with optional integer parameter and default positive value
|
||||
* @method static Builder<static>|Comment typed08(int $value = -123) Scope with optional integer parameter and default negative value
|
||||
* @method static Builder<static>|Comment typed09(float $value) Scope with required float parameter
|
||||
* @method static Builder<static>|Comment typed10(float $value = 123) Scope with optional float parameter and default positive integer value
|
||||
* @method static Builder<static>|Comment typed11(float $value = -123) Scope with optional float parameter and default negative integer value
|
||||
* @method static Builder<static>|Comment typed12(float $value = 1.23) Scope with optional float parameter and default positive float value
|
||||
* @method static Builder<static>|Comment typed13(float $value = -1.23) Scope with optional float parameter and default negative float value
|
||||
* @method static Builder<static>|Comment typed14(?bool $value) Scope with required nullable boolean parameter
|
||||
* @method static Builder<static>|Comment typed15(?bool $value = true) Scope with optional nullable boolean parameter and default true
|
||||
* @method static Builder<static>|Comment typed16(?bool $value = false) Scope with optional nullable boolean parameter and default false
|
||||
* @method static Builder<static>|Comment typed17(?bool $value = null) Scope with optional nullable boolean parameter and default null
|
||||
* @method static Builder<static>|Comment typed18(?string $value) Scope with required nullable string parameter
|
||||
* @method static Builder<static>|Comment typed19(?string $value = 'dummy123') Scope with optional nullable string parameter and default value
|
||||
* @method static Builder<static>|Comment typed20(?string $value = null) Scope with optional nullable string parameter and default null
|
||||
* @method static Builder<static>|Comment typed21(?int $value) Scope with required nullable integer parameter
|
||||
* @method static Builder<static>|Comment typed22(?int $value = 123) Scope with optional nullable integer parameter and default positive value
|
||||
* @method static Builder<static>|Comment typed23(?int $value = -123) Scope with optional nullable integer parameter and default negative value
|
||||
* @method static Builder<static>|Comment typed24(?int $value = null) Scope with optional nullable integer parameter and default null
|
||||
* @method static Builder<static>|Comment typed25(?float $value) Scope with required float nullable parameter
|
||||
* @method static Builder<static>|Comment typed26(?float $value = 123) Scope with optional nullable float parameter and default positive integer value
|
||||
* @method static Builder<static>|Comment typed27(?float $value = -123) Scope with optional nullable float parameter and default negative integer value
|
||||
* @method static Builder<static>|Comment typed28(?float $value = 1.23) Scope with optional float parameter and default positive float value
|
||||
* @method static Builder<static>|Comment typed29(?float $value = -1.23) Scope with optional float parameter and default negative float value
|
||||
* @method static Builder<static>|Comment typed30(?float $value = null) Scope with optional float parameter and default null
|
||||
* @mixin \Eloquent
|
||||
*/
|
||||
class Comment extends Model
|
||||
{
|
||||
/**
|
||||
* @comment Scope with required boolean parameter
|
||||
*/
|
||||
protected function scopeTyped01(Builder $query, bool $value)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional boolean parameter and default true
|
||||
*/
|
||||
protected function scopeTyped02(Builder $query, bool $value = true)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional boolean parameter and default false
|
||||
*/
|
||||
protected function scopeTyped03(Builder $query, bool $value = false)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with required string parameter
|
||||
*/
|
||||
protected function scopeTyped04(Builder $query, string $value)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional string parameter and default value
|
||||
*/
|
||||
protected function scopeTyped05(Builder $query, string $value = 'dummy123')
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with required integer parameter
|
||||
*/
|
||||
protected function scopeTyped06(Builder $query, int $value)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional integer parameter and default positive value
|
||||
*/
|
||||
protected function scopeTyped07(Builder $query, int $value = 123)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional integer parameter and default negative value
|
||||
*/
|
||||
protected function scopeTyped08(Builder $query, int $value = -123)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with required float parameter
|
||||
*/
|
||||
protected function scopeTyped09(Builder $query, float $value)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional float parameter and default positive integer value
|
||||
*/
|
||||
protected function scopeTyped10(Builder $query, float $value = 123)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional float parameter and default negative integer value
|
||||
*/
|
||||
protected function scopeTyped11(Builder $query, float $value = -123)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional float parameter and default positive float value
|
||||
*/
|
||||
protected function scopeTyped12(Builder $query, float $value = 1.23)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional float parameter and default negative float value
|
||||
*/
|
||||
protected function scopeTyped13(Builder $query, float $value = -1.23)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with required nullable boolean parameter
|
||||
*/
|
||||
protected function scopeTyped14(Builder $query, ?bool $value)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional nullable boolean parameter and default true
|
||||
*/
|
||||
protected function scopeTyped15(Builder $query, ?bool $value = true)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional nullable boolean parameter and default false
|
||||
*/
|
||||
protected function scopeTyped16(Builder $query, ?bool $value = false)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional nullable boolean parameter and default null
|
||||
*/
|
||||
protected function scopeTyped17(Builder $query, ?bool $value = null)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with required nullable string parameter
|
||||
*/
|
||||
protected function scopeTyped18(Builder $query, ?string $value)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional nullable string parameter and default value
|
||||
*/
|
||||
protected function scopeTyped19(Builder $query, ?string $value = 'dummy123')
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional nullable string parameter and default null
|
||||
*/
|
||||
protected function scopeTyped20(Builder $query, ?string $value = null)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with required nullable integer parameter
|
||||
*/
|
||||
protected function scopeTyped21(Builder $query, ?int $value)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional nullable integer parameter and default positive value
|
||||
*/
|
||||
protected function scopeTyped22(Builder $query, ?int $value = 123)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional nullable integer parameter and default negative value
|
||||
*/
|
||||
protected function scopeTyped23(Builder $query, ?int $value = -123)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional nullable integer parameter and default null
|
||||
*/
|
||||
protected function scopeTyped24(Builder $query, ?int $value = null)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with required float nullable parameter
|
||||
*/
|
||||
protected function scopeTyped25(Builder $query, ?float $value)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional nullable float parameter and default positive integer value
|
||||
*/
|
||||
protected function scopeTyped26(Builder $query, ?float $value = 123)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional nullable float parameter and default negative integer value
|
||||
*/
|
||||
protected function scopeTyped27(Builder $query, ?float $value = -123)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional float parameter and default positive float value
|
||||
*/
|
||||
protected function scopeTyped28(Builder $query, ?float $value = 1.23)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional float parameter and default negative float value
|
||||
*/
|
||||
protected function scopeTyped29(Builder $query, ?float $value = -1.23)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope with optional float parameter and default null
|
||||
*/
|
||||
protected function scopeTyped30(Builder $query, ?float $value = null)
|
||||
{
|
||||
$query->where('type', $value);
|
||||
}
|
||||
}
|
||||
+2
-4
@@ -13,8 +13,6 @@
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithExternalEloquentBuilder\Models{
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property int $id
|
||||
* @property string|null $char_nullable
|
||||
* @property string $char_not_nullable
|
||||
@@ -50,8 +48,8 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWi
|
||||
* @property float $float_not_nullable
|
||||
* @property float|null $double_nullable
|
||||
* @property float $double_not_nullable
|
||||
* @property string|null $decimal_nullable
|
||||
* @property string $decimal_not_nullable
|
||||
* @property numeric|null $decimal_nullable
|
||||
* @property numeric $decimal_not_nullable
|
||||
* @property int|null $boolean_nullable
|
||||
* @property int $boolean_not_nullable
|
||||
* @property string|null $enum_nullable
|
||||
|
||||
+2
-4
@@ -8,8 +8,6 @@ use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithExte
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property int $id
|
||||
* @property string|null $char_nullable
|
||||
* @property string $char_not_nullable
|
||||
@@ -45,8 +43,8 @@ use Illuminate\Database\Eloquent\Model;
|
||||
* @property float $float_not_nullable
|
||||
* @property float|null $double_nullable
|
||||
* @property float $double_not_nullable
|
||||
* @property string|null $decimal_nullable
|
||||
* @property string $decimal_not_nullable
|
||||
* @property numeric|null $decimal_nullable
|
||||
* @property numeric $decimal_not_nullable
|
||||
* @property int|null $boolean_nullable
|
||||
* @property int $boolean_not_nullable
|
||||
* @property string|null $enum_nullable
|
||||
|
||||
+4
-5
@@ -9,8 +9,6 @@ use Illuminate\Database\Eloquent\Relations\HasMany;
|
||||
use Illuminate\Database\Eloquent\SoftDeletes;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property int $id
|
||||
* @property string|null $char_nullable
|
||||
* @property string $char_not_nullable
|
||||
@@ -46,8 +44,8 @@ use Illuminate\Database\Eloquent\SoftDeletes;
|
||||
* @property float $float_not_nullable
|
||||
* @property float|null $double_nullable
|
||||
* @property float $double_not_nullable
|
||||
* @property string|null $decimal_nullable
|
||||
* @property string $decimal_not_nullable
|
||||
* @property numeric|null $decimal_nullable
|
||||
* @property numeric $decimal_not_nullable
|
||||
* @property int|null $boolean_nullable
|
||||
* @property int $boolean_not_nullable
|
||||
* @property string|null $enum_nullable
|
||||
@@ -84,6 +82,7 @@ use Illuminate\Database\Eloquent\SoftDeletes;
|
||||
* @property \Illuminate\Support\Carbon|null $updated_at
|
||||
* @property-read \Illuminate\Database\Eloquent\Collection<int, \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post> $posts
|
||||
* @property-read int|null $posts_count
|
||||
* @property-read bool|null $posts_exists
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post newModelQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post newQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post null(string $unusedParam)
|
||||
@@ -160,7 +159,7 @@ use Illuminate\Database\Eloquent\SoftDeletes;
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post whereUuidNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post whereYearNotNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post whereYearNullable($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post withTrashed()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post withTrashed(bool $withTrashed = true)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post withoutTrashed()
|
||||
* @mixin \Eloquent
|
||||
*/
|
||||
|
||||
@@ -15,8 +15,6 @@ use Illuminate\Database\Query\Builder as QueryBuilder;
|
||||
use Illuminate\Support\Carbon;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property int $id
|
||||
* @property string|null $char_nullable
|
||||
* @property CastType $char_not_nullable
|
||||
@@ -52,8 +50,8 @@ use Illuminate\Support\Carbon;
|
||||
* @property float $float_not_nullable
|
||||
* @property float|null $double_nullable
|
||||
* @property float $double_not_nullable
|
||||
* @property string|null $decimal_nullable
|
||||
* @property string $decimal_not_nullable
|
||||
* @property numeric|null $decimal_nullable
|
||||
* @property numeric $decimal_not_nullable
|
||||
* @property int|null $boolean_nullable
|
||||
* @property int $boolean_not_nullable
|
||||
* @property string|null $enum_nullable
|
||||
@@ -90,6 +88,7 @@ use Illuminate\Support\Carbon;
|
||||
* @property Carbon|null $updated_at
|
||||
* @property-read Collection<int, Post> $posts
|
||||
* @property-read int|null $posts_count
|
||||
* @property-read bool|null $posts_exists
|
||||
* @method static EloquentBuilder<static>|Post newModelQuery()
|
||||
* @method static EloquentBuilder<static>|Post newQuery()
|
||||
* @method static EloquentBuilder<static>|Post null(string $unusedParam)
|
||||
@@ -166,7 +165,7 @@ use Illuminate\Support\Carbon;
|
||||
* @method static EloquentBuilder<static>|Post whereUuidNullable($value)
|
||||
* @method static EloquentBuilder<static>|Post whereYearNotNullable($value)
|
||||
* @method static EloquentBuilder<static>|Post whereYearNullable($value)
|
||||
* @method static EloquentBuilder<static>|Post withTrashed()
|
||||
* @method static EloquentBuilder<static>|Post withTrashed(bool $withTrashed = true)
|
||||
* @method static EloquentBuilder<static>|Post withoutTrashed()
|
||||
* @mixin Eloquent
|
||||
*/
|
||||
|
||||
+2
-4
@@ -13,8 +13,6 @@
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithFqnInExternalFile\Models{
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property int $id
|
||||
* @property string|null $char_nullable
|
||||
* @property string $char_not_nullable
|
||||
@@ -50,8 +48,8 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWi
|
||||
* @property float $float_not_nullable
|
||||
* @property float|null $double_nullable
|
||||
* @property float $double_not_nullable
|
||||
* @property string|null $decimal_nullable
|
||||
* @property string $decimal_not_nullable
|
||||
* @property numeric|null $decimal_nullable
|
||||
* @property numeric $decimal_not_nullable
|
||||
* @property int|null $boolean_nullable
|
||||
* @property int $boolean_not_nullable
|
||||
* @property string|null $enum_nullable
|
||||
|
||||
@@ -45,8 +45,6 @@ class Post extends Model
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithMixin\Models{
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property $someProp
|
||||
* @method someMethod(string $method)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|FinalPost newModelQuery()
|
||||
@@ -60,8 +58,6 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWi
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithMixin\Models{
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property $someProp
|
||||
* @method someMethod(string $method)
|
||||
* @property int $id
|
||||
@@ -99,8 +95,8 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWi
|
||||
* @property float $float_not_nullable
|
||||
* @property float|null $double_nullable
|
||||
* @property float $double_not_nullable
|
||||
* @property string|null $decimal_nullable
|
||||
* @property string $decimal_not_nullable
|
||||
* @property numeric|null $decimal_nullable
|
||||
* @property numeric $decimal_not_nullable
|
||||
* @property int|null $boolean_nullable
|
||||
* @property int $boolean_not_nullable
|
||||
* @property string|null $enum_nullable
|
||||
|
||||
@@ -9,13 +9,13 @@ use Illuminate\Database\Eloquent\Relations\BelongsToMany;
|
||||
use Illuminate\Database\Eloquent\Relations\HasMany;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property int $id
|
||||
* @property-read \Illuminate\Database\Eloquent\Collection|Simple[] $regularBelongsToMany
|
||||
* @property-read int|null $regular_belongs_to_many_count
|
||||
* @property-read bool|null $regular_belongs_to_many_exists
|
||||
* @property-read \Illuminate\Database\Eloquent\Collection|Simple[] $regularHasMany
|
||||
* @property-read int|null $regular_has_many_count
|
||||
* @property-read bool|null $regular_has_many_exists
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple newModelQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple newQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple query()
|
||||
|
||||
@@ -8,8 +8,6 @@ use DateTime;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property int $id
|
||||
* @property-read int|null $attribute_return_type_int_or_null
|
||||
* @property-read array $attribute_returns_array
|
||||
|
||||
@@ -7,8 +7,6 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Ignored\Models;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|NotIgnored newModelQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|NotIgnored newQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|NotIgnored query()
|
||||
|
||||
@@ -13,8 +13,6 @@
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Interfaces\Models{
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|User newModelQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|User newQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|User query()
|
||||
|
||||
@@ -24,8 +24,6 @@ use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Cas
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts\CastedProperty $casted_property_with_return_type
|
||||
* @property \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts\CastedProperty $casted_property_with_return_docblock
|
||||
* @property \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts\CastedProperty $casted_property_with_return_docblock_fqn
|
||||
|
||||
@@ -7,8 +7,6 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\MagicWhere\Model
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property int $id
|
||||
* @property string|null $char_nullable
|
||||
* @property string $char_not_nullable
|
||||
@@ -44,8 +42,8 @@ use Illuminate\Database\Eloquent\Model;
|
||||
* @property float $float_not_nullable
|
||||
* @property float|null $double_nullable
|
||||
* @property float $double_not_nullable
|
||||
* @property string|null $decimal_nullable
|
||||
* @property string $decimal_not_nullable
|
||||
* @property numeric|null $decimal_nullable
|
||||
* @property numeric $decimal_not_nullable
|
||||
* @property int|null $boolean_nullable
|
||||
* @property int $boolean_not_nullable
|
||||
* @property string|null $enum_nullable
|
||||
|
||||
@@ -9,8 +9,6 @@ use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AbstractModelsCommand;
|
||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\ModelHooks\Hooks\CustomMethod;
|
||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\ModelHooks\Hooks\CustomProperty;
|
||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\ModelHooks\Hooks\UnsetMethod;
|
||||
use Illuminate\Filesystem\Filesystem;
|
||||
use Mockery;
|
||||
|
||||
class Test extends AbstractModelsCommand
|
||||
{
|
||||
@@ -34,24 +32,6 @@ class Test extends AbstractModelsCommand
|
||||
|
||||
public function test(): void
|
||||
{
|
||||
$actualContent = null;
|
||||
|
||||
$mockFilesystem = Mockery::mock(Filesystem::class)->makePartial();
|
||||
$mockFilesystem
|
||||
->shouldReceive('get')
|
||||
->andReturn(file_get_contents(__DIR__ . '/Models/Simple.php'))
|
||||
->once();
|
||||
$mockFilesystem
|
||||
->shouldReceive('put')
|
||||
->with(
|
||||
Mockery::any(),
|
||||
Mockery::capture($actualContent)
|
||||
)
|
||||
->andReturn(1) // Simulate we wrote _something_ to the file
|
||||
->once();
|
||||
|
||||
$this->instance(Filesystem::class, $mockFilesystem);
|
||||
|
||||
$command = $this->app->make(ModelsCommand::class);
|
||||
|
||||
$tester = $this->runCommand($command, [
|
||||
@@ -60,33 +40,6 @@ class Test extends AbstractModelsCommand
|
||||
|
||||
$this->assertSame(0, $tester->getStatusCode());
|
||||
$this->assertStringContainsString('Written new phpDocBlock to', $tester->getDisplay());
|
||||
|
||||
$expectedContent = <<<'PHP'
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\ModelHooks\Models;
|
||||
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property int $id
|
||||
* @property-read string $custom
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple custom($custom)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple newQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple query()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple whereId($value)
|
||||
* @mixin \Eloquent
|
||||
*/
|
||||
class Simple extends Model
|
||||
{
|
||||
}
|
||||
|
||||
PHP;
|
||||
|
||||
$this->assertSame($expectedContent, $actualContent);
|
||||
$this->assertMatchesMockedSnapshot();
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,20 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\ModelHooks\Models;
|
||||
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
* @property int $id
|
||||
* @property-read string $custom
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple custom($custom)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple newQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple query()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple whereId($value)
|
||||
* @mixin \Eloquent
|
||||
*/
|
||||
class Simple extends Model
|
||||
{
|
||||
}
|
||||
@@ -8,8 +8,6 @@ use Illuminate\Database\Eloquent\Model;
|
||||
use Illuminate\Database\Eloquent\Relations\MorphTo;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property string $relation_morph_to_type
|
||||
* @property int $relation_morph_to_id
|
||||
* @property string|null $nullable_relation_morph_to_type
|
||||
|
||||
-2
@@ -7,8 +7,6 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\PHPStormNoInspec
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property int $id
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple newModelQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple newQuery()
|
||||
|
||||
-2
@@ -7,8 +7,6 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\PHPStormNoInspec
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property int $id
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple newModelQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple newQuery()
|
||||
|
||||
@@ -9,21 +9,24 @@ use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Pivot\Models\Pivots\Di
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property-read DifferentCustomPivot|CustomPivot|null $pivot
|
||||
* @property-read \Illuminate\Database\Eloquent\Collection<int, ModelWithPivot> $relationCustomPivotUsingSameAccessor
|
||||
* @property-read int|null $relation_custom_pivot_using_same_accessor_count
|
||||
* @property-read bool|null $relation_custom_pivot_using_same_accessor_exists
|
||||
* @property-read \Illuminate\Database\Eloquent\Collection<int, ModelWithPivot> $relationCustomPivotUsingSameAccessorAndClass
|
||||
* @property-read int|null $relation_custom_pivot_using_same_accessor_and_class_count
|
||||
* @property-read bool|null $relation_custom_pivot_using_same_accessor_and_class_exists
|
||||
* @property-read CustomPivot|null $customAccessor
|
||||
* @property-read \Illuminate\Database\Eloquent\Collection<int, ModelWithPivot> $relationWithCustomPivot
|
||||
* @property-read int|null $relation_with_custom_pivot_count
|
||||
* @property-read bool|null $relation_with_custom_pivot_exists
|
||||
* @property-read DifferentCustomPivot|null $differentCustomAccessor
|
||||
* @property-read \Illuminate\Database\Eloquent\Collection<int, ModelWithPivot> $relationWithDifferentCustomPivot
|
||||
* @property-read int|null $relation_with_different_custom_pivot_count
|
||||
* @property-read bool|null $relation_with_different_custom_pivot_exists
|
||||
* @property-read \Illuminate\Database\Eloquent\Collection<int, ModelWithPivot> $relationWithDifferentCustomPivotUsingSameAccessor
|
||||
* @property-read int|null $relation_with_different_custom_pivot_using_same_accessor_count
|
||||
* @property-read bool|null $relation_with_different_custom_pivot_using_same_accessor_exists
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|ModelWithPivot newModelQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|ModelWithPivot newQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|ModelWithPivot query()
|
||||
@@ -75,8 +78,6 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Pivot\Models\Piv
|
||||
use Illuminate\Database\Eloquent\Relations\Pivot;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|CustomPivot newModelQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|CustomPivot newQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|CustomPivot query()
|
||||
@@ -94,8 +95,6 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Pivot\Models\Piv
|
||||
use Illuminate\Database\Eloquent\Relations\Pivot;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|DifferentCustomPivot newModelQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|DifferentCustomPivot newQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|DifferentCustomPivot query()
|
||||
|
||||
@@ -0,0 +1,33 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\QueryScopes\Models;
|
||||
|
||||
use Illuminate\Database\Eloquent\Attributes\Scope;
|
||||
use Illuminate\Database\Eloquent\Builder;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
class Comment extends Model
|
||||
{
|
||||
/**
|
||||
* @comment Scope using the 'Scope' attribute
|
||||
* @param Builder $query
|
||||
* @return void
|
||||
*/
|
||||
#[Scope]
|
||||
protected function local(Builder $query): void
|
||||
{
|
||||
$query->where('ip_address', '127.0.0.1');
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope using the 'scope' prefix
|
||||
* @param Builder $query
|
||||
* @return void
|
||||
*/
|
||||
protected function scopeSystem(Builder $query): void
|
||||
{
|
||||
$query->where('system', true);
|
||||
}
|
||||
}
|
||||
@@ -4,9 +4,48 @@ declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\QueryScopes\Models;
|
||||
|
||||
use Illuminate\Database\Eloquent\Attributes\Scope;
|
||||
use Illuminate\Database\Eloquent\Builder;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
* @method static Builder<static>|Comment local() Scope using the 'Scope' attribute
|
||||
* @method static Builder<static>|Comment newModelQuery()
|
||||
* @method static Builder<static>|Comment newQuery()
|
||||
* @method static Builder<static>|Comment query()
|
||||
* @method static Builder<static>|Comment system() Scope using the 'scope' prefix
|
||||
* @mixin \Eloquent
|
||||
*/
|
||||
class Comment extends Model
|
||||
{
|
||||
/**
|
||||
* @comment Scope using the 'Scope' attribute
|
||||
* @param Builder $query
|
||||
* @return void
|
||||
*/
|
||||
#[Scope]
|
||||
protected function local(Builder $query): void
|
||||
{
|
||||
$query->where('ip_address', '127.0.0.1');
|
||||
}
|
||||
|
||||
/**
|
||||
* @comment Scope using the 'scope' prefix
|
||||
* @param Builder $query
|
||||
* @return void
|
||||
*/
|
||||
protected function scopeSystem(Builder $query): void
|
||||
{
|
||||
$query->where('system', true);
|
||||
}
|
||||
}
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\QueryScopes\Models;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property int $id
|
||||
* @property string|null $char_nullable
|
||||
* @property string $char_not_nullable
|
||||
@@ -42,8 +81,8 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\QueryScopes\Mode
|
||||
* @property float $float_not_nullable
|
||||
* @property float|null $double_nullable
|
||||
* @property float $double_not_nullable
|
||||
* @property string|null $decimal_nullable
|
||||
* @property string $decimal_not_nullable
|
||||
* @property numeric|null $decimal_nullable
|
||||
* @property numeric $decimal_not_nullable
|
||||
* @property int|null $boolean_nullable
|
||||
* @property int $boolean_not_nullable
|
||||
* @property string|null $enum_nullable
|
||||
@@ -172,8 +211,6 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\QueryScopes\Mode
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|PostParent active()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|PostParent newModelQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|PostParent newQuery()
|
||||
|
||||
@@ -14,6 +14,7 @@ class Test extends AbstractModelsCommand
|
||||
parent::getEnvironmentSetUp($app);
|
||||
|
||||
$app['config']->set('ide-helper.write_model_relation_count_properties', false);
|
||||
$app['config']->set('ide-helper.write_model_relation_exists_properties', false);
|
||||
}
|
||||
|
||||
public function test(): void
|
||||
|
||||
@@ -8,8 +8,6 @@ use Illuminate\Database\Eloquent\Model;
|
||||
use Illuminate\Database\Eloquent\Relations\HasMany;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property int $id
|
||||
* @property string|null $char_nullable
|
||||
* @property string $char_not_nullable
|
||||
@@ -45,8 +43,8 @@ use Illuminate\Database\Eloquent\Relations\HasMany;
|
||||
* @property float $float_not_nullable
|
||||
* @property float|null $double_nullable
|
||||
* @property float $double_not_nullable
|
||||
* @property string|null $decimal_nullable
|
||||
* @property string $decimal_not_nullable
|
||||
* @property numeric|null $decimal_nullable
|
||||
* @property numeric $decimal_not_nullable
|
||||
* @property int|null $boolean_nullable
|
||||
* @property int $boolean_not_nullable
|
||||
* @property string|null $enum_nullable
|
||||
|
||||
+8
-6
@@ -8,8 +8,6 @@ use Illuminate\Database\Eloquent\Model;
|
||||
use Illuminate\Database\Eloquent\Relations\BelongsTo;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property int $id
|
||||
* @property int $not_null_column_with_foreign_key_constraint
|
||||
* @property int $not_null_column_with_no_foreign_key_constraint
|
||||
@@ -61,8 +59,6 @@ use Illuminate\Database\Eloquent\Model;
|
||||
use Illuminate\Database\Eloquent\Relations\BelongsTo;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property int $id
|
||||
* @property int $not_null_column_with_foreign_key_constraint
|
||||
* @property int $not_null_column_with_no_foreign_key_constraint
|
||||
@@ -132,33 +128,39 @@ use Illuminate\Database\Eloquent\Relations\MorphTo;
|
||||
use Illuminate\Database\Eloquent\Relations\MorphToMany;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property int $id
|
||||
* @property-read Simple $relationBelongsTo
|
||||
* @property-read AnotherModel $relationBelongsToInAnotherNamespace
|
||||
* @property-read \Illuminate\Database\Eloquent\Collection<int, Simple> $relationBelongsToMany
|
||||
* @property-read int|null $relation_belongs_to_many_count
|
||||
* @property-read bool|null $relation_belongs_to_many_exists
|
||||
* @property-read \Illuminate\Database\Eloquent\Collection<int, Simple> $relationBelongsToManyWithSub
|
||||
* @property-read int|null $relation_belongs_to_many_with_sub_count
|
||||
* @property-read bool|null $relation_belongs_to_many_with_sub_exists
|
||||
* @property-read \Illuminate\Database\Eloquent\Collection<int, Simple> $relationBelongsToManyWithSubAnother
|
||||
* @property-read int|null $relation_belongs_to_many_with_sub_another_count
|
||||
* @property-read bool|null $relation_belongs_to_many_with_sub_another_exists
|
||||
* @property-read AnotherModel $relationBelongsToSameNameAsColumn
|
||||
* @property-read \Illuminate\Database\Eloquent\Collection<int, Simple> $relationHasMany
|
||||
* @property-read int|null $relation_has_many_count
|
||||
* @property-read bool|null $relation_has_many_exists
|
||||
* @property-read Simple|null $relationHasOne
|
||||
* @property-read Simple $relationHasOneWithDefault
|
||||
* @property-read \Illuminate\Database\Eloquent\Collection<int, Simple> $relationMorphMany
|
||||
* @property-read int|null $relation_morph_many_count
|
||||
* @property-read bool|null $relation_morph_many_exists
|
||||
* @property-read Simple|null $relationMorphOne
|
||||
* @property-read Model|\Eloquent $relationMorphTo
|
||||
* @property-read \Illuminate\Database\Eloquent\Collection<int, Simple> $relationMorphedByMany
|
||||
* @property-read int|null $relation_morphed_by_many_count
|
||||
* @property-read bool|null $relation_morphed_by_many_exists
|
||||
* @property-read \Illuminate\Database\Eloquent\Collection<int, Simple> $relationSampleRelationType
|
||||
* @property-read int|null $relation_sample_relation_type_count
|
||||
* @property-read bool|null $relation_sample_relation_type_exists
|
||||
* @property-read Model|\Eloquent $relationSampleToAnyMorphedRelationType
|
||||
* @property-read \Illuminate\Database\Eloquent\Collection<int, Simple> $relationSampleToAnyRelationType
|
||||
* @property-read int|null $relation_sample_to_any_relation_type_count
|
||||
* @property-read bool|null $relation_sample_to_any_relation_type_exists
|
||||
* @property-read Simple $relationSampleToBadlyNamedNotManyRelation
|
||||
* @property-read Simple $relationSampleToManyRelationType
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple newModelQuery()
|
||||
|
||||
@@ -8,8 +8,6 @@ use Illuminate\Database\Eloquent\Model;
|
||||
use Illuminate\Database\Eloquent\Relations\BelongsTo;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property int $id
|
||||
* @property int $not_null_column_with_foreign_key_constraint
|
||||
* @property int $not_null_column_with_no_foreign_key_constraint
|
||||
@@ -61,8 +59,6 @@ use Illuminate\Database\Eloquent\Model;
|
||||
use Illuminate\Database\Eloquent\Relations\BelongsTo;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property int $id
|
||||
* @property int $not_null_column_with_foreign_key_constraint
|
||||
* @property int $not_null_column_with_no_foreign_key_constraint
|
||||
@@ -132,33 +128,39 @@ use Illuminate\Database\Eloquent\Relations\MorphTo;
|
||||
use Illuminate\Database\Eloquent\Relations\MorphToMany;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property int $id
|
||||
* @property-read Simple|null $relationBelongsTo
|
||||
* @property-read AnotherModel|null $relationBelongsToInAnotherNamespace
|
||||
* @property-read \Illuminate\Database\Eloquent\Collection<int, Simple> $relationBelongsToMany
|
||||
* @property-read int|null $relation_belongs_to_many_count
|
||||
* @property-read bool|null $relation_belongs_to_many_exists
|
||||
* @property-read \Illuminate\Database\Eloquent\Collection<int, Simple> $relationBelongsToManyWithSub
|
||||
* @property-read int|null $relation_belongs_to_many_with_sub_count
|
||||
* @property-read bool|null $relation_belongs_to_many_with_sub_exists
|
||||
* @property-read \Illuminate\Database\Eloquent\Collection<int, Simple> $relationBelongsToManyWithSubAnother
|
||||
* @property-read int|null $relation_belongs_to_many_with_sub_another_count
|
||||
* @property-read bool|null $relation_belongs_to_many_with_sub_another_exists
|
||||
* @property-read AnotherModel|null $relationBelongsToSameNameAsColumn
|
||||
* @property-read \Illuminate\Database\Eloquent\Collection<int, Simple> $relationHasMany
|
||||
* @property-read int|null $relation_has_many_count
|
||||
* @property-read bool|null $relation_has_many_exists
|
||||
* @property-read Simple|null $relationHasOne
|
||||
* @property-read Simple $relationHasOneWithDefault
|
||||
* @property-read \Illuminate\Database\Eloquent\Collection<int, Simple> $relationMorphMany
|
||||
* @property-read int|null $relation_morph_many_count
|
||||
* @property-read bool|null $relation_morph_many_exists
|
||||
* @property-read Simple|null $relationMorphOne
|
||||
* @property-read Model|\Eloquent $relationMorphTo
|
||||
* @property-read \Illuminate\Database\Eloquent\Collection<int, Simple> $relationMorphedByMany
|
||||
* @property-read int|null $relation_morphed_by_many_count
|
||||
* @property-read bool|null $relation_morphed_by_many_exists
|
||||
* @property-read \Illuminate\Database\Eloquent\Collection<int, Simple> $relationSampleRelationType
|
||||
* @property-read int|null $relation_sample_relation_type_count
|
||||
* @property-read bool|null $relation_sample_relation_type_exists
|
||||
* @property-read Model|\Eloquent $relationSampleToAnyMorphedRelationType
|
||||
* @property-read \Illuminate\Database\Eloquent\Collection<int, Simple> $relationSampleToAnyRelationType
|
||||
* @property-read int|null $relation_sample_to_any_relation_type_count
|
||||
* @property-read bool|null $relation_sample_to_any_relation_type_exists
|
||||
* @property-read Simple $relationSampleToBadlyNamedNotManyRelation
|
||||
* @property-read Simple $relationSampleToManyRelationType
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple newModelQuery()
|
||||
|
||||
@@ -7,8 +7,6 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\SimpleCasts\Mode
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property int $cast_to_int
|
||||
* @property int $cast_to_integer
|
||||
* @property float $cast_to_real
|
||||
@@ -33,7 +31,7 @@ use Illuminate\Database\Eloquent\Model;
|
||||
* @property \Carbon\CarbonImmutable $cast_to_immutable_datetime
|
||||
* @property \Carbon\CarbonImmutable $cast_to_immutable_datetime_serialization
|
||||
* @property int $cast_to_timestamp
|
||||
* @property mixed $cast_to_encrypted
|
||||
* @property string $cast_to_encrypted
|
||||
* @property array<array-key, mixed> $cast_to_encrypted_array
|
||||
* @property \Illuminate\Support\Collection<array-key, mixed> $cast_to_encrypted_collection
|
||||
* @property array<array-key, mixed> $cast_to_encrypted_json
|
||||
|
||||
@@ -8,15 +8,13 @@ use Illuminate\Database\Eloquent\Model;
|
||||
use Illuminate\Database\Eloquent\SoftDeletes;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property int $id
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple newModelQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple newQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple onlyTrashed()
|
||||
* @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 withTrashed()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple withTrashed(bool $withTrashed = true)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple withoutTrashed()
|
||||
* @mixin \Eloquent
|
||||
*/
|
||||
|
||||
@@ -9,11 +9,10 @@ use Illuminate\Database\Eloquent\Relations\HasMany;
|
||||
use Illuminate\Database\Query\Builder;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property-read string|int|null $foo
|
||||
* @property-read \Illuminate\Database\Eloquent\Collection<int, UnionTypeModel> $withUnionTypeReturn
|
||||
* @property-read int|null $with_union_type_return_count
|
||||
* @property-read bool|null $with_union_type_return_exists
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|UnionTypeModel newModelQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|UnionTypeModel newQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|UnionTypeModel query()
|
||||
|
||||
@@ -8,8 +8,6 @@ use Illuminate\Database\Eloquent\Builder;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @property int $id
|
||||
* @method static Builder<static>|Simple newModelQuery()
|
||||
* @method static Builder<static>|Simple newQuery()
|
||||
|
||||
@@ -1,6 +1,4 @@
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @mixin \Eloquent
|
||||
* @mixin \Illuminate\Database\Eloquent\Builder
|
||||
* @mixin \Illuminate\Database\Query\Builder
|
||||
|
||||
+2
-4
@@ -242,13 +242,11 @@ class MacroTest extends TestCase
|
||||
$macro = new Macro($reflectionMethod, 'URL', new ReflectionClass(UrlGenerator::class), 'macroName');
|
||||
$output = <<<'DOC'
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @param string $foo
|
||||
* @param int $bar
|
||||
* @return string
|
||||
* @return string
|
||||
* @see \Barryvdh\LaravelIdeHelper\Tests\UrlGeneratorMacroClass::__invoke()
|
||||
* @static
|
||||
* @static
|
||||
*/
|
||||
DOC;
|
||||
$this->assertSame($output, $macro->getDocComment(''));
|
||||
|
||||
+11
-15
@@ -36,12 +36,10 @@ class MethodTest extends TestCase
|
||||
|
||||
$output = <<<'DOC'
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @param string $last
|
||||
* @param string $first
|
||||
* @param string $middle
|
||||
* @static
|
||||
* @static
|
||||
*/
|
||||
DOC;
|
||||
$this->assertSame($output, $method->getDocComment(''));
|
||||
@@ -71,8 +69,8 @@ DOC;
|
||||
* @param array $values
|
||||
* @param array|string $uniqueBy
|
||||
* @param array|null $update
|
||||
* @return int
|
||||
* @static
|
||||
* @return int
|
||||
* @static
|
||||
*/
|
||||
DOC;
|
||||
$this->assertSame($output, $method->getDocComment(''));
|
||||
@@ -104,8 +102,8 @@ DOC;
|
||||
* @param mixed $operator
|
||||
* @param mixed $value
|
||||
* @param string $boolean
|
||||
* @return \Illuminate\Database\Eloquent\Builder<static>
|
||||
* @static
|
||||
* @return \Illuminate\Database\Eloquent\Builder<static>
|
||||
* @static
|
||||
*/
|
||||
DOC;
|
||||
$this->assertSame($output, $method->getDocComment(''));
|
||||
@@ -134,8 +132,8 @@ DOC;
|
||||
* @param string|array|\Illuminate\Contracts\Database\Query\Expression $columns
|
||||
* @param string $boolean
|
||||
* @param bool $not
|
||||
* @return \Illuminate\Database\Eloquent\Builder<static>
|
||||
* @static
|
||||
* @return \Illuminate\Database\Eloquent\Builder<static>
|
||||
* @static
|
||||
*/
|
||||
DOC;
|
||||
|
||||
@@ -177,10 +175,8 @@ DOC;
|
||||
|
||||
$output = <<<'DOC'
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @return \Illuminate\Foundation\Application
|
||||
* @static
|
||||
* @return \Illuminate\Foundation\Application
|
||||
* @static
|
||||
*/
|
||||
DOC;
|
||||
|
||||
@@ -208,8 +204,8 @@ DOC;
|
||||
* @template TValue
|
||||
* @param (\Closure(): TValue)|list<string> $columns
|
||||
* @param (\Closure(): TValue)|null $callback
|
||||
* @return TModel|TValue
|
||||
* @static
|
||||
* @return TModel|TValue
|
||||
* @static
|
||||
*/
|
||||
DOC;
|
||||
$this->assertSame($output, $method->getDocComment(''));
|
||||
|
||||
@@ -11,7 +11,7 @@ class SnapshotPhpDriver implements Driver
|
||||
{
|
||||
public function serialize($data): string
|
||||
{
|
||||
return (string) $data;
|
||||
return str_replace(["\r\n", "\r"], "\n", (string) $data);
|
||||
}
|
||||
|
||||
public function extension(): string
|
||||
@@ -21,6 +21,6 @@ class SnapshotPhpDriver implements Driver
|
||||
|
||||
public function match($expected, $actual)
|
||||
{
|
||||
Assert::assertSame($expected, $this->serialize($actual));
|
||||
Assert::assertSame(str_replace(["\r\n", "\r"], "\n", $expected), $this->serialize($actual));
|
||||
}
|
||||
}
|
||||
|
||||
@@ -11,7 +11,7 @@ class SnapshotTxtDriver implements Driver
|
||||
{
|
||||
public function serialize($data): string
|
||||
{
|
||||
return (string) $data;
|
||||
return str_replace(["\r\n", "\r"], "\n", (string) $data);
|
||||
}
|
||||
|
||||
public function extension(): string
|
||||
@@ -21,6 +21,6 @@ class SnapshotTxtDriver implements Driver
|
||||
|
||||
public function match($expected, $actual)
|
||||
{
|
||||
Assert::assertSame($expected, $this->serialize($actual));
|
||||
Assert::assertSame(str_replace(["\r\n", "\r"], "\n", $expected), $this->serialize($actual));
|
||||
}
|
||||
}
|
||||
|
||||
@@ -55,6 +55,11 @@ abstract class TestCase extends BaseTestCase
|
||||
$this->assertMatchesSnapshot($actualContent, new SnapshotTxtDriver());
|
||||
}
|
||||
|
||||
protected function assertMatchesMockedSnapshot()
|
||||
{
|
||||
$this->assertMatchesSnapshot($this->mockFilesystemOutput, new SnapshotPhpDriver());
|
||||
}
|
||||
|
||||
protected function mockFilesystem()
|
||||
{
|
||||
$mockFilesystem = Mockery::mock(Filesystem::class)->makePartial();
|
||||
@@ -66,6 +71,7 @@ abstract class TestCase extends BaseTestCase
|
||||
Mockery::any()
|
||||
)
|
||||
->andReturnUsing(function ($path, $contents) {
|
||||
$contents = str_replace(["\r\n", "\r"], "\n", $contents);
|
||||
$this->mockFilesystemOutput .= $contents;
|
||||
|
||||
return strlen($contents);
|
||||
|
||||
Reference in New Issue
Block a user