[Issue] Fix PHPDocs for \Magento\Framework\Data\Collection::getItemById

[m2-assistant]

This issue is automatically created based on existing pull request: #38439: Fix PHPDocs for \Magento\Framework\Data\Collection::getItemById

---

Add null as possible type returned by getItemById method.
Method returns null when item is not found.

PHPStan complains in the code using that method:
Sample usage:

$product = $productCollection->getItemById(42);
if ($product) { # phpstan: If condition is always true.
    // some logic
}

Result in PHPStorm:

Description (*)

Adds null type to PHPDocs of \Magento\Framework\Data\Collection::getItemById.
Fixes minor grammar issues in PHPDocs of that class.

Related Pull Requests

Fixed Issues (if relevant)

Manual testing scenarios (*)

1. Create a module that uses any Collection and add code which reflects if condition specified in the PR summary
2. Configure PHPStan with enabled Treat PHPDoc types as certain (usually it is enabled by default)
3. Run static analysis (or open file in IDE with static analysis capabilities such as PHPStorm)
4. There should be no warning/error if condition is always true

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)

[engcom-November]

Hello @MTheProgrammer,

Thank you for the report and collaboration!

Verified this on 2.4-develop.
Configured phpstan. In \Magento\Framework\Data\Collection::getItemById phpstan shows condition is always true.
Please take a look at the screenshot below:

Hence confirming this issue.

Thank you.

[m2-assistant]

Hi @engcom-November. Thank you for working on this issue.
In order to make sure that issue has enough information and ready for development, please read and check the following instruction: 👇

• 1. Verify that issue has all the required information. (Preconditions, Steps to reproduce, Expected result, Actual result).
• 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue.
• 3. Add Area: XXXXX label to the ticket, indicating the functional areas it may be related to.
• 4. Verify that the issue is reproducible on 2.4-develop branch
  Details

  - Add the comment @magento give me 2.4-develop instance to deploy test instance on Magento infrastructure.
  - If the issue is reproducible on 2.4-develop branch, please, add the label Reproduced on 2.4.x.
  - If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and stop verification process here!
• 5. Add label Issue: Confirmed once verification is complete.
• 6. Make sure that automatic system confirms that report has been added to the backlog.

[github-jira-sync-bot]

✅ Jira issue https://jira.corp.adobe.com/browse/AC-11489 is successfully created for this GitHub issue.