Fix incorrect return type for getOptionByCode method

[ihor-sviziev]

Description (*)

I've noticed that \Magento\Catalog\Model\Product\Configuration\Item\ItemInterface::getOptionByCode return type is defined as object all the time:

magento2/app/code/Magento/Catalog/Model/Product/Configuration/Item/ItemInterface.php

Lines 24 to 30 in b2ce2a3

	/**
	* Get item option by code
	*
	* @param string $code
	* @return \Magento\Catalog\Model\Product\Configuration\Item\Option\OptionInterface
	*/
	public function getOptionByCode($code);

However, this interface implements 3 classes, and each of them returns object OR null, so it's a bug in the method definition on interface:

• magento2/app/code/Magento/Quote/Model/Quote/Address/Item.php

  Lines 200 to 210 in 6729b6e

  	/**
  	* @inheritdoc
  	* @since 101.1.1
  	*/
  	public function getOptionByCode($code)
  	{
  	if ($this->getQuoteItem()) {
  	return $this->getQuoteItem()->getOptionBycode($code);
  	}
  	return null;
  	}

• magento2/app/code/Magento/Quote/Model/Quote/Item.php

  Lines 726 to 738 in 2afe92f

  	/**
  	* Get item option by code
  	*
  	* @param string $code
  	* @return \Magento\Quote\Model\Quote\Item\Option || null
  	*/
  	public function getOptionByCode($code)
  	{
  	if (isset($this->_optionsByCode[$code]) && !$this->_optionsByCode[$code]->isDeleted()) {
  	return $this->_optionsByCode[$code];
  	}
  	return null;
  	}

• magento2/app/code/Magento/Wishlist/Model/Item.php

  Lines 697 to 709 in 795b2c6

  	/**
  	* Get item option by code
  	*
  	* @param string $code
  	* @return Option|null
  	*/
  	public function getOptionByCode($code)
  	{
  	if (isset($this->_optionsByCode[$code]) && !$this->_optionsByCode[$code]->isDeleted()) {
  	return $this->_optionsByCode[$code];
  	}
  	return null;
  	}

This pull request fixes incorrect phpdoc block, which leads to confusion, which leads to bugs during development

Related Pull Requests

Fixed Issues (if relevant)

1. Fixes magento/magento2#<issue_number>

Manual testing scenarios (*)

1. ...
2. ...

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)

Resolved issues:

1. resolves [Issue] Fix incorrect return type for getOptionByCode method #39404: Fix incorrect return type for getOptionByCode method

[m2-assistant]

Hi @ihor-sviziev. 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.

[ihor-sviziev]

@magento run all tests

[engcom-Hotel]

@magento create issue