Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

$product is Product model or DataObject #31005

Closed
wants to merge 1 commit into from
Closed

$product is Product model or DataObject #31005

wants to merge 1 commit into from

Conversation

dfelton
Copy link
Contributor

@dfelton dfelton commented Nov 22, 2020 •
edited by m2-assistant bot

Description (*)

Updates the phpdoc to better reflect the potential object type.

\Magento\Catalog\Ui\Component\Listing\Columns\Thumbnail::prepareDataSource() is an example of where the first argument passed to \Magento\Catalog\Helper\Image::init() is not actually an instance of \Magento\Catalog\Model\Product, but rather, just an instance of \Magento\Framework\DataObject.

Fixed Issues (if relevant)

N/A

Manual testing scenarios (*)

This is only an update of the PHP doc in (what I believe) is not a class where the PHP Doc is parsed out by any tools. No testing done.

Questions or comments

In my current project, I had built a beforeInit() plugin to \Magento\Catalog\Helper\Image::init(). The signature of my beforeInit() plugin specified that the second argument to the plugin must be an object of \Magento\Catalog\Model\Product. This then broke the product grid page of the admin because \Magento\Catalog\Ui\Component\Listing\Columns\Thumbnail::prepareDataSource() does not pass a product model, but rather simply an instance of \Magento\Framework\DataObject.

To provide to developers better context into the possible object types passed to this non-type-hinted method, I think an updated phpdoc is appropriate.

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)
  • All automated tests passed successfully (all builds are green)

Resolved issues:

  1. resolves [Issue] $product is Product model or DataObject #31037: $product is Product model or DataObject

@dfelton
$product is Product model or DataObject
b158c6e 
\Magento\Catalog\Ui\Component\Listing\Columns\Thumbnail::prepareDataSource() is an example of where the first argument passed to \Magento\Catalog\Helper\Image::init() is not actually an instance of \Magento\Catalog\Model\Product, but rather, just an instance of \Magento\Framework\DataObject.
@m2-assistant
Copy link

m2-assistant bot commented Nov 22, 2020

Hi @dfelton. Thank you for your contribution
Here is some useful tips how you can test your changes using Magento test environment.
Add the comment under your pull request to deploy test or vanilla Magento instance:

  • @magento give me test instance - deploy test instance based on PR changes
  • @magento give me 2.4-develop instance - deploy vanilla Magento instance

❗ 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

You can find more information about the builds here

ℹ️ Please run only needed test builds instead of all when developing. Please run all test builds before sending your PR for review.

For more details, please, review the Magento Contributor Guide documentation.

⚠️ According to the Magento Contribution requirements, all Pull Requests must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting.

🕙 You can find the schedule on the Magento Community Calendar page.

📞 The triage of Pull Requests happens in the queue order. If you want to speed up the delivery of your contribution, please join the Community Contributions Triage session to discuss the appropriate ticket.

🎥 You can find the recording of the previous Community Contributions Triage on the Magento Youtube Channel

✏️ Feel free to post questions/proposals/feedback related to the Community Contributions Triage process to the corresponding Slack Channel

@dfelton
Copy link
Contributor Author

dfelton commented Nov 22, 2020

@magento run all tests

@gabrieldagama gabrieldagama added Priority: P4 No current plan to fix. Fixing can be deferred as a logical part of more important work. Severity: S4 Affects aesthetics, professional look and feel, “quality” or “usability”. labels Nov 24, 2020
@m2-community-project m2-community-project bot added this to Pending Review in Pull Requests Dashboard Nov 24, 2020
@gabrieldagama
Copy link
Contributor

@magento create issue

@m2-assistant m2-assistant bot mentioned this pull request Nov 24, 2020
Closed
4 tasks
ihor-sviziev
ihor-sviziev requested changes Jan 15, 2021
View reviewed changes
Copy link
Contributor

@ihor-sviziev ihor-sviziev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @dfelton,
It seems to me that the issue you're referencing is the opposite - in the

magento2/app/code/Magento/Catalog/Ui/Component/Listing/Columns/Thumbnail.php

Line 55 in f55f411

$product = new \Magento\Framework\DataObject($item);
, we should have the product model, not the data object.
Could you update your PR in order to fix that?

@m2-community-project m2-community-project bot moved this from Pending Review to Changes Requested in Pull Requests Dashboard Jan 15, 2021
@ihor-sviziev
Copy link
Contributor

Hi @dfelton,
I am closing this PR now due to inactivity.
Please reopen and update if you wish to continue.
Thank you for the collaboration!

@m2-assistant
Copy link

m2-assistant bot commented Apr 14, 2021

Hi @dfelton, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.

@m2-community-project m2-community-project bot removed this from Changes Requested in Pull Requests Dashboard Apr 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ihor-sviziev ihor-sviziev ihor-sviziev requested changes

Assignees

@ihor-sviziev ihor-sviziev

Labels
Component: Catalog Priority: P4 No current plan to fix. Fixing can be deferred as a logical part of more important work. Release Line: 2.4 Severity: S4 Affects aesthetics, professional look and feel, “quality” or “usability”.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Issue] $product is Product model or DataObject
4 participants
@dfelton @gabrieldagama @ihor-sviziev @magento-engcom-team