[9.x] Add PHPStan-specific tags to improve analysis on model factories #41286
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Nuno made model factories generic in this PR. To preserve compatibility with PhpStorm the return types were defined as a union of
\Illuminate\Database\Eloquent\Model|TModel
. PHPStan normalises this into\Illuminate\Database\Eloquent\Model
(becauseTModel
is a subtype ofModel
), resulting in a bunch of unknown property/method errors when running PHPStan on tests that use model factories.This PR adds specific tags for PHPStan that overrule the standard PHPDoc tags, to preserve the specific model types provided by the generics. PhpStorm's understanding of return types is unaffected (because it ignores these PHPStan-specific tags), but PHPStan gains a lot of benefits from these specific tags as can be seen in the updated tests.