Merge pull request magento#4726 from magento-chaika/Chaika-PR-2019-09-03-2.3

Chaika-PR-2019-09-03-2.3

Author: dhorytskyi

app/code/Magento/OfflinePayments/Observer/BeforeOrderPaymentSaveObserver.php

@@ -3,38 +3,38 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
 
-/**
- * OfflinePayments Observer
- */
 namespace Magento\OfflinePayments\Observer;
 
 use Magento\Framework\Event\ObserverInterface;
 use Magento\OfflinePayments\Model\Banktransfer;
 use Magento\OfflinePayments\Model\Cashondelivery;
 use Magento\OfflinePayments\Model\Checkmo;
+use Magento\Sales\Model\Order\Payment;
 
+/**
+ * Sets payment additional information.
+ */
 class BeforeOrderPaymentSaveObserver implements ObserverInterface
 {
     /**
-     * Sets current instructions for bank transfer account
+     * Sets current instructions for bank transfer account.
      *
      * @param \Magento\Framework\Event\Observer $observer
      * @return void
+     * @throws \Magento\Framework\Exception\LocalizedException
      */
-    public function execute(\Magento\Framework\Event\Observer $observer)
+    public function execute(\Magento\Framework\Event\Observer $observer): void
     {
-        /** @var \Magento\Sales\Model\Order\Payment $payment */
+        /** @var Payment $payment */
         $payment = $observer->getEvent()->getPayment();
         $instructionMethods = [
             Banktransfer::PAYMENT_METHOD_BANKTRANSFER_CODE,
             Cashondelivery::PAYMENT_METHOD_CASHONDELIVERY_CODE
         ];
         if (in_array($payment->getMethod(), $instructionMethods)) {
-            $payment->setAdditionalInformation(
-                'instructions',
-                $payment->getMethodInstance()->getInstructions()
-            );
+            $payment->setAdditionalInformation('instructions', $this->getInstructions($payment));
         } elseif ($payment->getMethod() === Checkmo::PAYMENT_METHOD_CHECKMO_CODE) {
             $methodInstance = $payment->getMethodInstance();
             if (!empty($methodInstance->getPayableTo())) {
@@ -45,4 +45,17 @@ public function execute(\Magento\Framework\Event\Observer $observer)
             }
         }
     }
+
+    /**
+     * Retrieve store-specific payment method instructions, or already saved if exists.
+     *
+     * @param Payment $payment
+     * @return string|null
+     * @throws \Magento\Framework\Exception\LocalizedException
+     */
+    private function getInstructions(Payment $payment): ?string
+    {
+        return $payment->getAdditionalInformation('instructions')
+            ?: $payment->getMethodInstance()->getConfigData('instructions', $payment->getOrder()->getStoreId());
+    }
 }

app/code/Magento/OfflinePayments/Test/Unit/Observer/BeforeOrderPaymentSaveObserverTest.php

@@ -11,6 +11,7 @@
 use Magento\OfflinePayments\Model\Banktransfer;
 use Magento\OfflinePayments\Model\Cashondelivery;
 use Magento\OfflinePayments\Observer\BeforeOrderPaymentSaveObserver;
+use Magento\Sales\Model\Order;
 use Magento\Sales\Model\Order\Payment;
 use PHPUnit_Framework_MockObject_MockObject as MockObject;
 use Magento\OfflinePayments\Model\Checkmo;
@@ -76,19 +77,12 @@ public function testBeforeOrderPaymentSaveWithInstructions($methodCode)
         $this->payment->expects(self::once())
             ->method('getMethod')
             ->willReturn($methodCode);
+        $this->payment->method('getAdditionalInformation')
+            ->with('instructions')
+            ->willReturn('payment configuration');
         $this->payment->expects(self::once())
             ->method('setAdditionalInformation')
             ->with('instructions', 'payment configuration');
-        $method = $this->getMockBuilder(Banktransfer::class)
-            ->disableOriginalConstructor()
-            ->getMock();
-
-        $method->expects(self::once())
-            ->method('getInstructions')
-            ->willReturn('payment configuration');
-        $this->payment->expects(self::once())
-            ->method('getMethodInstance')
-            ->willReturn($method);
 
         $this->_model->execute($this->observer);
     }

app/code/Magento/OfflinePayments/composer.json

@@ -8,7 +8,8 @@
         "php": "~7.1.3||~7.2.0||~7.3.0",
         "magento/framework": "*",
         "magento/module-checkout": "*",
-        "magento/module-payment": "*"
+        "magento/module-payment": "*",
+        "magento/module-sales": "*"
     },
     "suggest": {
         "magento/module-config": "*"

app/code/Magento/Payment/Block/Info/Instructions.php

@@ -25,6 +25,18 @@ class Instructions extends \Magento\Payment\Block\Info
      */
     protected $_template = 'Magento_Payment::info/instructions.phtml';
 
+    /**
+     * Gets payment method title for appropriate store.
+     *
+     * @return string
+     * @throws \Magento\Framework\Exception\LocalizedException
+     */
+    public function getTitle()
+    {
+        return $this->getInfo()->getAdditionalInformation('method_title')
+            ?: $this->getMethod()->getConfigData('title', $this->getInfo()->getOrder()->getStoreId());
+    }
+
     /**
      * Get instructions text from order payment
      * (or from config, if instructions are missed in payment)

app/code/Magento/Payment/Test/Unit/Block/Info/InstructionsTest.php

@@ -4,11 +4,12 @@
  * See COPYING.txt for license details.
  */
 
-/**
- * Test class for \Magento\Payment\Block\Info\Instructions
- */
 namespace Magento\Payment\Test\Unit\Block\Info;
 
+use Magento\Payment\Model\MethodInterface;
+use Magento\Sales\Model\Order;
+use PHPUnit\Framework\MockObject\MockObject;
+
 class InstructionsTest extends \PHPUnit\Framework\TestCase
 {
     /**
@@ -25,10 +26,59 @@ protected function setUp()
     {
         $context = $this->createMock(\Magento\Framework\View\Element\Template\Context::class);
         $this->_instructions = new \Magento\Payment\Block\Info\Instructions($context);
-        $this->_info = $this->createMock(\Magento\Payment\Model\Info::class);
+        $this->_info = $this->getMockBuilder(\Magento\Payment\Model\Info::class)
+            ->setMethods(
+                [
+                    'getOrder',
+                    'getAdditionalInformation',
+                    'getMethodInstance'
+                ]
+            )
+            ->disableOriginalConstructor()
+            ->getMock();
         $this->_instructions->setData('info', $this->_info);
     }
 
+    /**
+     * @return void
+     * @throws \Magento\Framework\Exception\LocalizedException
+     */
+    public function testGetTitleFromPaymentAdditionalData()
+    {
+        $this->_info->method('getAdditionalInformation')
+            ->with('method_title')
+            ->willReturn('payment_method_title');
+
+        $this->getMethod()->expects($this->never())
+            ->method('getConfigData');
+
+        $this->assertEquals($this->_instructions->getTitle(), 'payment_method_title');
+    }
+
+    /**
+     * @return void
+     * @throws \Magento\Framework\Exception\LocalizedException
+     */
+    public function testGetTitleFromPaymentMethodConfig()
+    {
+        $this->_info->method('getAdditionalInformation')
+            ->with('method_title')
+            ->willReturn(null);
+
+        $this->getMethod()->expects($this->once())
+            ->method('getConfigData')
+            ->with('title', null)
+            ->willReturn('payment_method_title');
+
+        $order = $this->getOrder();
+        $this->_info->method('getOrder')->willReturn($order);
+
+        $this->assertEquals($this->_instructions->getTitle(), 'payment_method_title');
+    }
+
+    /**
+     * @return void
+     */
     public function testGetInstructionAdditionalInformation()
     {
         $this->_info->expects($this->once())
@@ -41,10 +91,13 @@ public function testGetInstructionAdditionalInformation()
         $this->assertEquals('get the instruction here', $this->_instructions->getInstructions());
     }
 
+    /**
+     * @return void
+     */
     public function testGetInstruction()
     {
         $methodInstance = $this->getMockBuilder(
-            \Magento\Payment\Model\MethodInterface::class
+            MethodInterface::class
         )->getMockForAbstractClass();
         $methodInstance->expects($this->once())
             ->method('getConfigData')
@@ -59,4 +112,27 @@ public function testGetInstruction()
             ->willReturn($methodInstance);
         $this->assertEquals('get the instruction here', $this->_instructions->getInstructions());
     }
+
+    /**
+     * @return MethodInterface|MockObject
+     */
+    private function getMethod()
+    {
+        $method = $this->getMockBuilder(MethodInterface::class)
+            ->getMockForAbstractClass();
+        $this->_info->method('getMethodInstance')
+            ->willReturn($method);
+
+        return $method;
+    }
+
+    /**
+     * @return Order|MockObject
+     */
+    private function getOrder()
+    {
+        return $this->getMockBuilder(Order::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+    }
 }

app/code/Magento/Payment/view/adminhtml/templates/info/instructions.phtml

@@ -9,7 +9,7 @@
  * @see \Magento\Payment\Block\Info
  */
 ?>
-<p><?= $block->escapeHtml($block->getMethod()->getTitle()) ?></p>
+<p><?= $block->escapeHtml($block->getTitle()) ?></p>
 <?php if ($block->getInstructions()) : ?>
     <table>
         <tbody>

app/code/Magento/Payment/view/frontend/templates/info/instructions.phtml

@@ -10,7 +10,7 @@
  */
 ?>
 <dl class="payment-method">
-    <dt class="title"><?= $block->escapeHtml($block->getMethod()->getTitle()) ?></dt>
+    <dt class="title"><?= $block->escapeHtml($block->getTitle()) ?></dt>
 <?php if ($block->getInstructions()) : ?>
     <dd class="content"><?= /* @noEscape */ nl2br($block->escapeHtml($block->getInstructions())) ?></dd>
 <?php endif; ?>