fix(catalog): correct getCollection() return type docblock#40508
Open
lbajsarowicz wants to merge 1 commit intomagento:2.4-developfrom
Open
fix(catalog): correct getCollection() return type docblock#40508lbajsarowicz wants to merge 1 commit intomagento:2.4-developfrom
lbajsarowicz wants to merge 1 commit intomagento:2.4-developfrom
Conversation
The getCollection() method in AbstractDataProvider was documented via @inheritdoc to return Framework\Model\ResourceModel\Db\Collection\AbstractCollection, but actually returns Catalog\Model\ResourceModel\Product\Collection which does not inherit from that class. Fixes magento#40152
|
Hi @lbajsarowicz. Thank you for your contribution!
Allowed build names are:
You can find more information about the builds here For more details, review the Code Contributions documentation. |
Contributor
Author
|
@magento run all tests |
This file contains hidden or 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
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.
Description (*)
Fixed incorrect return type documentation in
Magento\Catalog\Ui\DataProvider\Product\Related\AbstractDataProvider::getCollection().The method was documented via
@inheritdocto return\Magento\Framework\Model\ResourceModel\Db\Collection\AbstractCollection, but it actually returns\Magento\Catalog\Model\ResourceModel\Product\Collectionwhich inherits from the EAV collection hierarchy, not the Framework DB collection.Related Pull Requests
Fixed Issues (if relevant)
Manual testing scenarios (*)
AbstractDataProviderTestCase- they already assert the correct return typeQuestions or comments
Contribution checklist (*)
⭐ Support my work
Do you like the fix? Remember to react with "👍🏻" to get it merged faster,
Then Sponsor me on Github so I can spend more time on fixing issues like this one.
Learn more at https://github.com/sponsors/lbajsarowicz