Improve replacement of return type for methods from Query\Builder

[pjio]

Summary

See issue for expected improvement: #1574

The class \Eloquent in _ide_helper.php contains methods from Illuminate\Database\Eloquent\Builder and Illuminate\Database\Query\Builder. The return type for $this is replaced with the real class (in case of the Eloquent\Builder already with an additional |static). This merge requests replaces $this in methods from Query\Builder with the identical return type Illuminate\Database\Eloquent\Builder|static. In the context of an \Eloquent instance this should be the real behavior and improves the derived types.

Type of change

• New feature (non-breaking change which adds functionality)

Checklist

• Existing tests have been adapted and/or new tests have been added
• Add a CHANGELOG.md entry
• Code style has been fixed via composer fix-style

[pjio]

Here the old and new file for easier comparison:
_ide_helper.php.old.txt
_ide_helper.php.new.txt

[eldair]

@pjio will this fix #1572 as well?

[pjio]

@pjio will this fix #1572 as well?

No, for #1572 it doesn't make a difference. The cause is a different one. This PR only affects the return type $this.

[pjio]

Changes 03.09.24

• normalizeReturn() does set the return type only with $tag->setContent() (before it was overwritten by $tag->setType() which had the side effect to reset Tag::$content)
• It is now clearer how $this could be normalized depending on the alias.
• Generation of _ide_helper.php tested with Laravel 10 and PHP 8.1, 8.2 and 8.3
• Set "Type of change" to "New feature" (the generated file changes but it shouldn't break anything)

Edit: Intelephense up to version 1.10.4 and again since version 1.12.6 works with the |static return type.

[CongAn]

Thank you very much for your valuable contributions!
I would greatly appreciate it if the project maintainers could merge this pull request and release a new version as soon as possible.

[barryvdh]

Is this fixed with 3.2 now adding the type?

[pjio]

Is this fixed with 3.2 now adding the type?

Not yet. This pull request additionally adds the type for various methods of \Eloquent in _ide_helper.php (I tested with a fresh Laravel 11 project and 3.2 to see if it already would work without the change).

Examples:

User::query()->where('name', 'joe')->first(); // `query()` from the model already works as of 3.2
User::where('name', 'joe')->first();          // `where` from Eloquent\Builder will work with this pull request
User::whereNull('name')->first();             // `whereNull` from Query\Builder will work with this pull request