Skip to content

Conversation

@lbajsarowicz
Copy link
Contributor

@lbajsarowicz lbajsarowicz commented Feb 4, 2026

Description (*)

Fixed incorrect return type documentation in Magento\Catalog\Ui\DataProvider\Product\Related\AbstractDataProvider::getCollection().

The method was documented via @inheritdoc to return \Magento\Framework\Model\ResourceModel\Db\Collection\AbstractCollection, but it actually returns \Magento\Catalog\Model\ResourceModel\Product\Collection which inherits from the EAV collection hierarchy, not the Framework DB collection.

Related Pull Requests

Fixed Issues (if relevant)

  1. Fixes Magento\Catalog\Ui\DataProvider\Product\Related\AbstractDataProvider::getCollection() is documented as returning incorrect type #40152

Manual testing scenarios (*)

  1. Verify PHPDoc tools correctly identify the return type
  2. Run existing unit tests in AbstractDataProviderTestCase - they already assert the correct return type

Questions or comments

Contribution checklist (*)

  • Pull request has a meaningful description of its purpose
  • All commits are accompanied by meaningful commit messages
  • All new or changed code is covered with unit/integration tests (if applicable)
  • README.md files for modified modules are updated and included in the pull request if any README.md predefined sections require an update
  • All automated tests passed successfully (all builds are green)

⭐ 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

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
@m2-assistant
Copy link

m2-assistant bot commented Feb 4, 2026

Hi @lbajsarowicz. Thank you for your contribution!
Here are some useful tips on how you can test your changes using Magento test environment.
❗ Automated tests can be triggered manually with an appropriate comment:

  • @magento run all tests - run or re-run all required tests against the PR changes
  • @magento run <test-build(s)> - run or re-run specific test build(s)
    For example: @magento run Unit Tests

<test-build(s)> is a comma-separated list of build names.

Allowed build names are:
  1. Database Compare
  2. Functional Tests CE
  3. Functional Tests EE
  4. Functional Tests B2B
  5. Integration Tests
  6. Magento Health Index
  7. Sample Data Tests CE
  8. Sample Data Tests EE
  9. Sample Data Tests B2B
  10. Static Tests
  11. Unit Tests
  12. WebAPI Tests
  13. Semantic Version Checker

You can find more information about the builds here
ℹ️ Run only required test builds during development. Run all test builds before sending your pull request for review.


For more details, review the Code Contributions documentation.
Join Magento Community Engineering Slack and ask your questions in #github channel.

@lbajsarowicz
Copy link
Contributor Author

@magento run all tests

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Priority: P3 May be fixed according to the position in the backlog. Progress: pending review

Projects

Status: Pending Review

Development

Successfully merging this pull request may close these issues.

Magento\Catalog\Ui\DataProvider\Product\Related\AbstractDataProvider::getCollection() is documented as returning incorrect type

2 participants