$order->getCustomer() returns NULL for registered customer

[jakwinkler]

Preconditions (*)

1. Magento 2.3.2 & 2.4-develop, community edition

Steps to reproduce (*)

1. Create customer account and make an order
2. Create a module with an observer to sales_order_save_after event

<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Event/etc/events.xsd">
    <event name="sales_order_save_after">
        <observer name="my-observer" instance="Something\Darkside\Observer\OrderSaveAfter" />
    </event>
</config>

3. Try to access Customer object from order object

public function execute(Observer $observer): void
    {
         /** @var Order $order */
         $order = $observer->getEvent()->getOrder();
         $customer = $order->getCustomer();
        ....

Expected result (*)

1. Method getCustomer should return customer object, as defined in phpdoc block OR phpdoc block should be changed to highlight that NULL could be returned

Actual result (*)

1. Method getCustomer always returns NULL, but it's not highlighted in phpdoc block that it could return null

Additional info

Method getCustomer will return customer only in case if someone added it to Order object, in other cases it doesn't exists. In case if you need to get customer from the Order object you need to do following get customer ID from the order object

$customerId = $order->getCustomerId();

// $customerId could be NULL in case if order was placed as guest
$customer = $customerId ? $this->customerRepository->getById($customerId) : null;

Where $this->customerRepository is instance of \Magento\Customer\Api\CustomerRepositoryInterface that retrieved via constructor

[m2-assistant]

Hi @qsolutions-pl. Thank you for your report.
To help us process this issue please make sure that you provided the following information:

• Summary of the issue
• Information on your environment
• Steps to reproduce
• Expected and actual results

Please make sure that the issue is reproducible on the vanilla Magento instance following Steps to reproduce. To deploy vanilla Magento instance on our environment, please, add a comment to the issue:

@magento give me 2.3-develop instance - upcoming 2.3.x release

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

@qsolutions-pl do you confirm that you were able to reproduce the issue on vanilla Magento instance following steps to reproduce?

• yes
• no

---

• Join Magento Community Engineering Slack and ask your questions in #github channel.

[m2-assistant]

Hi @itsPranith. 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).

  Details

  If the issue has a valid description, the label Issue: Format is valid will be added to the issue automatically. Please, edit issue description if needed, until label Issue: Format is valid appears.

• 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue. If the report is valid, add Issue: Clear Description label to the issue by yourself.

• 3. Add Component: XXXXX label(s) to the ticket, indicating the components it may be related to.

• 4. Verify that the issue is reproducible on 2.3-develop branch

  Details

  - Add the comment @magento give me 2.3-develop instance to deploy test instance on Magento infrastructure.
  - If the issue is reproducible on 2.3-develop branch, please, add the label Reproduced on 2.3.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.

[jakwinkler]

Any update on this?

[magento-engcom-team]

✅ Confirmed by @itsPranith
Thank you for verifying the issue. Based on the provided information internal tickets MC-22188 were created

Issue Available: @itsPranith, You will be automatically unassigned. Contributors/Maintainers can claim this issue to continue. To reclaim and continue work, reassign the ticket to yourself.

[m2-assistant]

Hi @sudheer-gajjala. Thank you for working on this issue.
Looks like this issue is already verified and confirmed. But if you want to validate it one more time, please, go though the following instruction:

• 1. Add/Edit Component: XXXXX label(s) to the ticket, indicating the components it may be related to.

• 2. Verify that the issue is reproducible on 2.3-develop branch

  Details

  - Add the comment @magento give me 2.3-develop instance to deploy test instance on Magento infrastructure.
  - If the issue is reproducible on 2.3-develop branch, please, add the label Reproduced on 2.3.x.
  - If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and stop verification process here!

• 3. If the issue is not relevant or is not reproducible any more, feel free to close it.

---

• Join Magento Community Engineering Slack and ask your questions in #github channel.

[mohith227]

@qsolutions-pl in this event we are not getting customer object so instead of $order->getCustomer() use like $order->getCustomerFirstname() for customer first name

[jakwinkler]

honestly @mohith227 that is not an answer nor a solution, I need customer object to fetch other customer data like:

• customer custom attributes
• customer group

[m2-assistant]

Hi @rajeebkumar-sahoo. Thank you for working on this issue.
Looks like this issue is already verified and confirmed. But if you want to validate it one more time, please, go though the following instruction:

• 1. Add/Edit Component: XXXXX label(s) to the ticket, indicating the components it may be related to.

• 2. Verify that the issue is reproducible on 2.3-develop branch

  Details

  - Add the comment @magento give me 2.3-develop instance to deploy test instance on Magento infrastructure.
  - If the issue is reproducible on 2.3-develop branch, please, add the label Reproduced on 2.3.x.
  - If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and stop verification process here!

• 3. If the issue is not relevant or is not reproducible any more, feel free to close it.

---

• Join Magento Community Engineering Slack and ask your questions in #github channel.

[ihor-sviziev]

Hi @qsolutions-pl @itsPranith @rajeebkumar-sahoo,

Unfortunately adding new method to existing functionality will break backward compatibility, more details: https://devdocs.magento.com/guides/v2.3/contributor-guide/backward-compatible-development/

Why do you think order model should have method "getCustomer"?

As for me it shoudn't as it's not his responsibility. It should just contain getCustomerId method or something like this, and it is:

magento2/app/code/Magento/Sales/Model/Order.php

Lines 2744 to 2747 in bff0d38

	public function getCustomerId()
	{
	return $this->getData(OrderInterface::CUSTOMER_ID);
	}

If you need to have customer - you can get it from customer repository.

I would mark it as not an issue

[rajeebkumar-sahoo]

Hi @ihor-sviziev,

The call to "$order->getCustomer()" as mentioned in the issue does not raise any PHP error saying that "method does not exist on object" but it returns NULL. So the method already exists and the functionality provided on "Order" model class as a magic method like
"@method \Magento\Customer\Model\Customer getCustomer()". And the magic method gets resolved in "\Magento\Framework\DataObject::__call" where it doesn't find any key named "customer" and hence returns NULL which violets the method signature defined like "@method \Magento\Customer\Model\Customer getCustomer()".

The solution to this could be either we provide logic on "__call" by overriding it in "\Magento\Sales\Model\Order" or the way I did it by providing a direct function. I choose the second method because overriding "__call" would be only possible by introducing static text comparison like "if ($method === 'getCustomer')", which is not appropriate.

[ihor-sviziev]

In this case would be better to update phpdoc block that will show that return type for getCustomer() could be also null. Is it sounds reasonable to you?

…

On Thu, 28 Nov 2019 at 05:09, Rajeeb Kumar Sahoo ***@***.***> wrote: Hi @ihor-sviziev <https://github.com/ihor-sviziev>, The call to "$order->getCustomer()" as mentioned in the issue does not raise any PHP error saying that "method does not exist on object" but it returns NULL. So the method already exists and the functionality provided on "Order" model class as a magic method like ***@***.*** <https://github.com/method> \Magento\Customer\Model\Customer getCustomer()". And the magic method gets resolved in "\Magento\Framework\DataObject::__call" where it doesn't find any key named "customer" and hence returns NULL which violets the method signature defined like ***@***.*** <https://github.com/method> \Magento\Customer\Model\Customer getCustomer()". The solution to this could be either we provide logic on "__call" by overriding it in "\Magento\Sales\Model\Order" or the way I did it by providing a direct function. I choose the second method because overriding "__call" would be only possible by introducing static text comparison like "if ($method === 'getCustomer')", which is not appropriate. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#25268?email_source=notifications&email_token=AAOJOUK7OBY4N4TFE47BLL3QV4Y5ZA5CNFSM4JETGHJ2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEFLJUEY#issuecomment-559323667>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAOJOUMVMDI774WMXNI6RA3QV4Y5ZANCNFSM4JETGHJQ> .

[rajeebkumar-sahoo]

HI @ihor-sviziev @qsolutions-pl @itsPranith,

Yes, that sounds reasonable and also we should mark the magic method as deprecated so that with the next minor release we could remove that altogether.

like:
* @method \Magento\Customer\Model\Customer|null getCustomer() { @deprecated instead use getCustomerId() along with customer repository to get customer instance }

[ihor-sviziev]

Replacing to something like will be good enough: * @method \Magento\Customer\Model\Customer|null getCustomer()
So people will see that it could be also null and will check it additionally. Also as it's not real method - we can't deprecate it.

[rajeebkumar-sahoo]

Actually we can see "phpDocumentor/phpDocumentor#1604" if we could or will go with the above solution.

[ihor-sviziev]

Actually we can see "phpDocumentor/phpDocumentor#1604" if we could or will go with the above solution.

It wasn't fixed and AFAIK major IDEs are not supporting this syntax.

[m2-assistant]

Hi @engcom-Hotel. 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).

  Details

  If the issue has a valid description, the label Issue: Format is valid will be added to the issue automatically. Please, edit issue description if needed, until label Issue: Format is valid appears.

• 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue. If the report is valid, add Issue: Clear Description label to the issue by yourself.

• 3. Add Component: XXXXX label(s) to the ticket, indicating the components 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.

[magento-engcom-team]

✅ Confirmed by @engcom-Hotel
Thank you for verifying the issue. Based on the provided information internal tickets MC-25044 were created

Issue Available: @engcom-Hotel, You will be automatically unassigned. Contributors/Maintainers can claim this issue to continue. To reclaim and continue work, reassign the ticket to yourself.

[m2-assistant]

Hi @sertlab. Thank you for working on this issue.
Looks like this issue is already verified and confirmed. But if you want to validate it one more time, please, go though the following instruction:

• 1. Add/Edit Component: XXXXX label(s) to the ticket, indicating the components it may be related to.

• 2. 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!

• 3. If the issue is not relevant or is not reproducible any more, feel free to close it.

---

• Join Magento Community Engineering Slack and ask your questions in #github channel.

[ihor-sviziev]

@engcom-Hotel i think we expected result should be changed, that magic method should highlight that it could return null. This is not direct responsibility of order object to retrieve customer. In client code customer could be retrieved by customerId.
Btw both methods getCustomer and getCustomerId might return null in case when order were placed as guest, and that would be absolutely valid behavior

[engcom-Hotel]

@ihor-sviziev thanks for contributing! I have updated the description.

[magento-deployment-service]

Thanks for opening this issue!

[magento-deployment-service]

Thanks for opening this issue!

[magento-deployment-service]

Thanks for opening this issue!

[magento-deployment-service]

Thanks for opening this issue!

[slavvka]

Hi @qsolutions-pl. Thank you for your report.
The issue has been fixed in #26423 by @sertlab in 2.4-develop branch
Related commit(s):

• 92816ab04db61666741ae9ab0986175068c46bee
• 427a4ad298210ed5287044cd49c51391daa0af65
• f8bcd47e0959bf34b1f2f01712c0488e0939e881
• 80c737a7287439876f73ab90c7fce7e1a5a43877
• 5a1f48e1cc590a9605c0ae82844e89a9b74e84f6
• 57e2532e05b93315c610ffc9076b422030c94781
• 3ca45d8efa0a2a79c207451428b845d34c1addc8

The fix will be available with the upcoming 2.4.0 release.