Add generic types for ActiveRecord and Container #20325
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #20325 +/- ##
=========================================
Coverage 64.85% 64.85%
Complexity 11435 11435
=========================================
Files 431 431
Lines 37193 37193
=========================================
Hits 24120 24120
Misses 13073 13073 ☔ View full report in Codecov by Sentry. |
samdark
requested changes
Feb 18, 2025
framework/db/ActiveQuery.php
Outdated
Comment on lines
129
to
131
| * @return array|ActiveRecord[] the query results. If the query results in nothing, an empty array will be returned. | ||
| * @return T[] the query results. If the query results in nothing, an empty array will be returned. |
There was a problem hiding this comment.
That will likely break many IDEs. It will likely break API docs generation as well. Can we keep regular type for @return and add psalm/phpstan annotations only?
framework/db/ActiveQuery.php
Outdated
Comment on lines
319
to
343
| /** | ||
| * {@inheritdoc} | ||
| * | ||
| * @return T[][] | ||
| * @psalm-return T[][]|BatchQueryResult | ||
| * @phpstan-return T[][]|BatchQueryResult | ||
| * @codeCoverageIgnore | ||
| */ | ||
| public function batch($batchSize = 100, $db = null) | ||
| { | ||
| return parent::batch($batchSize, $db); | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| * | ||
| * @return T[] | ||
| * @psalm-return T[]|BatchQueryResult | ||
| * @phpstan-return T[]|BatchQueryResult | ||
| * @codeCoverageIgnore | ||
| */ | ||
| public function each($batchSize = 100, $db = null) | ||
| { | ||
| return parent::each($batchSize, $db); | ||
| } |
There was a problem hiding this comment.
Can we do it without adding methods? I think @method annotation for a class may work.
There was a problem hiding this comment.
Unfortunately, @method phpdoc doesn't support multiple @return phpdocs
xepozz
changed the title
samdark
approved these changes
Feb 21, 2025
samdark
changed the title
|
Thank you! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Using this two-way binding allows PHPStorm / PHPStan / Psalm recognize return type of calling
all()/one()/batch()/each()methodsIt's possible both:
@extends ActiveQuery<ModelClass>phpdoc to the query class@method static ActiveQuery<static> find()phpdoc to the active record class in case the query class isn't necessary