PLGMAG2V2-814: Add instructions field to payment methods (#738)

vinodsowdagar · web-flow · commit a63f8be56815 · 2024-12-19T16:20:38.000+01:00
diff --git a/Model/Ui/Gateway/AfterpayConfigProvider.php b/Model/Ui/Gateway/AfterpayConfigProvider.php
@@ -53,6 +53,7 @@ public function getConfig(): array
                     'image' => $this->getImage(),
                     'is_preselected' => $this->isPreselected(),
                     'transaction_type' => $this->getTransactionType(),
+                    'instructions' => $this->getInstructions(),
                     'payment_type' => $this->getPaymentType(),
                     'afterpay_terms_url' => $this->getAfterpayTermsAndConditionUrl(),
                 ],
diff --git a/Model/Ui/Gateway/AmexConfigProvider.php b/Model/Ui/Gateway/AmexConfigProvider.php
@@ -36,6 +36,7 @@ public function getConfig(): array
                     'image' => $this->getImage(),
                     'vaultCode' => self::VAULT_CODE,
                     'is_preselected' => $this->isPreselected(),
+                    'instructions' => $this->getInstructions(),
                 ]
             ]
         ];
diff --git a/Model/Ui/Gateway/BnplinstmConfigProvider.php b/Model/Ui/Gateway/BnplinstmConfigProvider.php
@@ -34,7 +34,8 @@ public function getConfig(): array
                 $this->getCode() => [
                     'image' => $this->getImage(),
                     'is_preselected' => $this->isPreselected(),
-                    'payment_type' => $this->getPaymentType()
+                    'payment_type' => $this->getPaymentType(),
+                    'instructions' => $this->getInstructions()
                 ]
             ]
         ];
diff --git a/Model/Ui/Gateway/BnplmfConfigProvider.php b/Model/Ui/Gateway/BnplmfConfigProvider.php
@@ -34,7 +34,8 @@ public function getConfig(): array
                 $this->getCode() => [
                     'image' => $this->getImage(),
                     'is_preselected' => $this->isPreselected(),
-                    'payment_type' => $this->getPaymentType()
+                    'payment_type' => $this->getPaymentType(),
+                    'instructions' => $this->getInstructions()
                 ]
             ]
         ];
diff --git a/Model/Ui/Gateway/CreditCardConfigProvider.php b/Model/Ui/Gateway/CreditCardConfigProvider.php
@@ -37,7 +37,8 @@ public function getConfig(): array
                     'image' => $this->getImage(),
                     'vaultCode' => self::VAULT_CODE,
                     'is_preselected' => $this->isPreselected(),
-                    'payment_type' => $this->getPaymentType()
+                    'payment_type' => $this->getPaymentType(),
+                    'instructions' => $this->getInstructions()
                 ]
             ]
         ];
diff --git a/Model/Ui/Gateway/DirectDebitConfigProvider.php b/Model/Ui/Gateway/DirectDebitConfigProvider.php
@@ -37,6 +37,7 @@ public function getConfig(): array
                     'vaultCode' => self::VAULT_CODE,
                     'is_preselected' => $this->isPreselected(),
                     'transaction_type' => $this->getTransactionType(),
+                    'instructions' => $this->getInstructions()
                 ],
             ],
         ];
diff --git a/Model/Ui/Gateway/EinvoicingConfigProvider.php b/Model/Ui/Gateway/EinvoicingConfigProvider.php
@@ -35,6 +35,7 @@ public function getConfig(): array
                     'image' => $this->getImage(),
                     'is_preselected' => $this->isPreselected(),
                     'transaction_type' => $this->getTransactionType(),
+                    'instructions' => $this->getInstructions(),
                     'payment_type' => $this->getPaymentType(),
                     'checkout_fields' => $this->checkoutFieldsUtil->getCheckoutFields(
                         self::CODE,
diff --git a/Model/Ui/Gateway/GenericGatewayConfigProvider.php b/Model/Ui/Gateway/GenericGatewayConfigProvider.php
@@ -111,7 +111,8 @@ public function getConfig(): array
         foreach ($this->getGenericList() as $gatewayCode) {
             $configData[$gatewayCode] = [
                 'image' => $this->getGenericFullImagePath($gatewayCode),
-                'is_preselected' => $this->isPreselectedByCode($gatewayCode)
+                'is_preselected' => $this->isPreselectedByCode($gatewayCode),
+                'instructions' => $this->getInstructions()
             ];
         }
 
diff --git a/Model/Ui/Gateway/IdealConfigProvider.php b/Model/Ui/Gateway/IdealConfigProvider.php
@@ -38,6 +38,7 @@ public function getConfig(): array
                     'image' => $this->getImage(),
                     'vaultCode' => self::VAULT_CODE,
                     'is_preselected' => $this->isPreselected(),
+                    'instructions' => $this->getInstructions()
                 ],
             ],
         ];
diff --git a/Model/Ui/Gateway/In3B2bConfigProvider.php b/Model/Ui/Gateway/In3B2bConfigProvider.php
@@ -34,7 +34,8 @@ public function getConfig(): array
                 $this->getCode() => [
                     'image' => $this->getImage(),
                     'is_preselected' => $this->isPreselected(),
-                    'payment_type' => $this->getPaymentType()
+                    'payment_type' => $this->getPaymentType(),
+                    'instructions' => $this->getInstructions()
                 ]
             ]
         ];
diff --git a/Model/Ui/Gateway/In3ConfigProvider.php b/Model/Ui/Gateway/In3ConfigProvider.php
@@ -35,6 +35,7 @@ public function getConfig(): array
                     'image' => $this->getImage(),
                     'is_preselected' => $this->isPreselected(),
                     'transaction_type' => $this->getTransactionType(),
+                    'instructions' => $this->getInstructions(),
                     'payment_type' => $this->getPaymentType()
                 ]
             ]
diff --git a/Model/Ui/Gateway/MaestroConfigProvider.php b/Model/Ui/Gateway/MaestroConfigProvider.php
@@ -36,6 +36,7 @@ public function getConfig(): array
                     'image' => $this->getImage(),
                     'vaultCode' => self::VAULT_CODE,
                     'is_preselected' => $this->isPreselected(),
+                    'instructions' => $this->getInstructions()
                 ]
             ]
         ];
diff --git a/Model/Ui/Gateway/MastercardConfigProvider.php b/Model/Ui/Gateway/MastercardConfigProvider.php
@@ -36,6 +36,7 @@ public function getConfig(): array
                     'image' => $this->getImage(),
                     'vaultCode' => self::VAULT_CODE,
                     'is_preselected' => $this->isPreselected(),
+                    'instructions' => $this->getInstructions()
                 ]
             ]
         ];
diff --git a/Model/Ui/Gateway/MyBankConfigProvider.php b/Model/Ui/Gateway/MyBankConfigProvider.php
@@ -37,6 +37,7 @@ public function getConfig(): array
                     'issuers' => $this->getIssuers(),
                     'image' => $this->getImage(),
                     'is_preselected' => $this->isPreselected(),
+                    'instructions' => $this->getInstructions()
                 ],
             ],
         ];
diff --git a/Model/Ui/Gateway/VisaConfigProvider.php b/Model/Ui/Gateway/VisaConfigProvider.php
@@ -36,6 +36,7 @@ public function getConfig(): array
                     'image' => $this->getImage(),
                     'vaultCode' => self::VAULT_CODE,
                     'is_preselected' => $this->isPreselected(),
+                    'instructions' => $this->getInstructions()
                 ]
             ]
         ];
diff --git a/Model/Ui/Gateway/ZiniaConfigProvider.php b/Model/Ui/Gateway/ZiniaConfigProvider.php
@@ -34,7 +34,8 @@ public function getConfig(): array
                 $this->getCode() => [
                     'image' => $this->getImage(),
                     'is_preselected' => $this->isPreselected(),
-                    'payment_type' => $this->getPaymentType()
+                    'payment_type' => $this->getPaymentType(),
+                    'instructions' => $this->getInstructions()
                 ]
             ]
         ];
diff --git a/Model/Ui/GenericConfigProvider.php b/Model/Ui/GenericConfigProvider.php
@@ -151,6 +151,7 @@ public function getConfig(): array
                     'image' => $this->getImage(),
                     'is_preselected' => $this->isPreselected(),
                     'transaction_type' => $this->getTransactionType(),
+                    'instructions' => $this->getInstructions(),
                 ],
             ],
         ];
@@ -427,4 +428,16 @@ protected function getStoreIdFromCheckoutSession(): ?int
 
         return $storeId;
     }
+
+    /**
+     * Get the payment instructions
+     *
+     * @return string
+     */
+    protected function getInstructions(): string
+    {
+        $this->paymentConfig->setMethodCode($this->getCode());
+
+        return (string)$this->paymentConfig->getValue('instructions', $this->getStoreIdFromCheckoutSession());
+    }
 }
diff --git a/Model/Ui/Giftcard/EdenredGiftcardConfigProvider.php b/Model/Ui/Giftcard/EdenredGiftcardConfigProvider.php
@@ -45,6 +45,7 @@ public function getConfig(): array
                     'image' => $this->getImage(),
                     'is_preselected' => $this->isPreselected(),
                     'transaction_type' => $this->getTransactionType(),
+                    'instructions' => $this->getInstructions(),
                     'coupons' => $this->getAvailableCouponsByQuote($this->checkoutSession->getQuote()),
                 ],
             ],

Original file line number	Diff line number	Diff line change
`@@ -36,6 +36,7 @@ public function getConfig(): array`
`36`	`36`	`'image' => $this->getImage(),`
`37`	`37`	`'vaultCode' => self::VAULT_CODE,`
`38`	`38`	`'is_preselected' => $this->isPreselected(),`
	`39`	`+ 'instructions' => $this->getInstructions(),`
`39`	`40`	`]`
`40`	`41`	`]`
`41`	`42`	`];`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,8 @@ public function getConfig(): array`
`34`	`34`	`$this->getCode() => [`
`35`	`35`	`'image' => $this->getImage(),`
`36`	`36`	`'is_preselected' => $this->isPreselected(),`
`37`		`- 'payment_type' => $this->getPaymentType()`
	`37`	`+ 'payment_type' => $this->getPaymentType(),`
	`38`	`+ 'instructions' => $this->getInstructions()`
`38`	`39`	`]`
`39`	`40`	`]`
`40`	`41`	`];`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,8 @@ public function getConfig(): array`
`37`	`37`	`'image' => $this->getImage(),`
`38`	`38`	`'vaultCode' => self::VAULT_CODE,`
`39`	`39`	`'is_preselected' => $this->isPreselected(),`
`40`		`- 'payment_type' => $this->getPaymentType()`
	`40`	`+ 'payment_type' => $this->getPaymentType(),`
	`41`	`+ 'instructions' => $this->getInstructions()`
`41`	`42`	`]`
`42`	`43`	`]`
`43`	`44`	`];`
Original file line number	Diff line number	Diff line change
`@@ -111,7 +111,8 @@ public function getConfig(): array`
`111`	`111`	`foreach ($this->getGenericList() as $gatewayCode) {`
`112`	`112`	`$configData[$gatewayCode] = [`
`113`	`113`	`'image' => $this->getGenericFullImagePath($gatewayCode),`
`114`		`- 'is_preselected' => $this->isPreselectedByCode($gatewayCode)`
	`114`	`+ 'is_preselected' => $this->isPreselectedByCode($gatewayCode),`
	`115`	`+ 'instructions' => $this->getInstructions()`
`115`	`116`	`];`
`116`	`117`	`}`
`117`	`118`
Original file line number	Diff line number	Diff line change
`@@ -35,6 +35,7 @@ public function getConfig(): array`
`35`	`35`	`'image' => $this->getImage(),`
`36`	`36`	`'is_preselected' => $this->isPreselected(),`
`37`	`37`	`'transaction_type' => $this->getTransactionType(),`
	`38`	`+ 'instructions' => $this->getInstructions(),`
`38`	`39`	`'payment_type' => $this->getPaymentType()`
`39`	`40`	`]`
`40`	`41`	`]`