[PHPDOC] Update argument type in Magento\Customer\Api\Data\CustomerInterface::setConfirmation()

[dimitriBouteille]

Description (*)

This PR fix the bad phpdoc in Magento\Customer\Api\Data\CustomerInterface::setConfirmation(). The argument $confirmation can be null.

Here is an example where the type null is used :

magento2/app/code/Magento/Customer/Model/ForgotPasswordToken/ConfirmCustomerByToken.php

Lines 60 to 66 in 57bad41

	private function resetConfirmation(CustomerInterface $customer): void
	{
	// skip unnecessary address and customer validation
	$customer->setData('ignore_validation_flag', true);
	$customer->setConfirmation(null);
	$this->customerRepository->save($customer);

With PHPSTAN is very complicated to setup the project with level 5 or higher :(

Related Pull Requests

None

Fixed Issues (if relevant)

None

Manual testing scenarios (*)

Setup PHPSTAN with level 5 or higher and run check.

Questions or comments

The quality of Magento code needs to be improved so that it is easier to use the code quality tools (phpstan, rector, ...) ❤️

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] [PHPDOC] Update argument type in Magento\Customer\Api\Data\CustomerInterface::setConfirmation() #40625: [PHPDOC] Update argument type in Magento\Customer\Api\Data\CustomerInterface::setConfirmation()

[m2-assistant]

Hi @dimitriBouteille. 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.

[dimitriBouteille]

Please, thank you for not taking 3 years to accept this PR that modifies just one line of PHPDoc.

[engcom-Hotel]

@magento create issue