add getPaymentParametersAsJson method for robokassa_iframe.js

Author: igor-netFantom

src/RobokassaApi.php

@@ -172,6 +172,14 @@ public function getPaymentParameters(InvoiceOptions $invoiceOptions): array
         ];
     }
 
+    public function getPaymentParametersAsJson(InvoiceOptions $invoiceOptions): string
+    {
+        return json_encode(
+            $this->getPaymentParameters($invoiceOptions),
+            JSON_THROW_ON_ERROR | JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES
+        );
+    }
+
     public function smsRequest(int $phone, string $message): RequestInterface
     {
         $requestData = $this->getSendSmsData($phone, $message);

src/RobokassaApiInterface.php

@@ -59,6 +59,23 @@ public function getBase64SignedPostData(SecondReceiptOptions|ReceiptStatusOption
      */
     public function getPaymentParameters(InvoiceOptions $invoiceOptions): array;
 
+    /**
+     * Получает параметры платежа для передачи в Робокассу в формате JSON строки для использования
+     * с PopUp iFrame виджетом {@link https://docs.robokassa.ru/iframe/}
+     *
+     * ##Пример:
+     * ```
+     * <script type="text/javascript" src="https://auth.robokassa.ru/Merchant/bundle/robokassa_iframe.js"></script>
+     * <input type="submit"
+     * onclick="Robokassa.StartPayment(<?= $robokassa->getPaymentParametersAsJson($invoiceOptions) ?>)"
+     * value="Оплатить">
+     * ```
+     * @param InvoiceOptions $invoiceOptions
+     * @return string
+     * @throws JsonException
+     */
+    public function getPaymentParametersAsJson(InvoiceOptions $invoiceOptions): string;
+
     /**
      * Получение URL для оплаты счета с указанными параметрами
      * (GET запрос длиной более 2083 символов может не работать,

tests/RobokassaApiTest.php

@@ -86,44 +86,45 @@ public function testGetPaymentParameters(): void
             password2: 'password#2',
         );
 
-        $paymentParameters = $robokassa->getPaymentParameters(
-            new InvoiceOptions(
-                outSum: 100,
-                invId: 999,
-                description: 'Description',
-                receipt: new Receipt(
-                    items: [
-                        new Item(
-                            name: 'Название товара 1 (50%)',
-                            quantity: 1,
-                            sum: 100,
-                            tax: Tax::vat10,
-                            payment_method: PaymentMethod::full_payment,
-                            payment_object: PaymentObject::commodity
-                        ),
-                        new Item(
-                            name: 'Название товара 2',
-                            quantity: 3,
-                            sum: 450,
-                            tax: Tax::vat120,
-                            payment_method: PaymentMethod::full_payment,
-                            payment_object: PaymentObject::excise,
-                            nomenclature_code: '04620034587217'
-                        ),
-                    ],
-                    sno: Sno::osn,
-                ),
-                culture: Culture::en,
+        $invoiceOptions = new InvoiceOptions(
+            outSum: 100,
+            invId: 999,
+            description: "Description\"'><b>",
+            receipt: new Receipt(
+                items: [
+                    new Item(
+                        name: 'Название товара 1 (50%)',
+                        quantity: 1,
+                        sum: 100,
+                        tax: Tax::vat10,
+                        payment_method: PaymentMethod::full_payment,
+                        payment_object: PaymentObject::commodity
+                    ),
+                    new Item(
+                        name: "Название товара 2\"'><b>",
+                        quantity: 3,
+                        sum: 450,
+                        tax: Tax::vat120,
+                        payment_method: PaymentMethod::full_payment,
+                        payment_object: PaymentObject::excise,
+                        nomenclature_code: '04620034587217'
+                    ),
+                ],
+                sno: Sno::osn,
             ),
+            culture: Culture::en,
+        );
+        $paymentParameters = $robokassa->getPaymentParameters(
+            $invoiceOptions,
         );
 
         $expectedPaymentParameters = [
             'MerchantLogin' => 'robo-demo',
             'OutSum' => '100.00',
-            'Description' => 'Description',
-            'SignatureValue' => '9da55279722ba167a1384b05a2c5e330',
+            'Description' => "Description\"'><b>",
+            'SignatureValue' => '7c6a95094fa5c3e5e2baf83c8817e8c0',
             'IncCurrLabel' => null,
-            'InvId' => 999,
+            'InvId' => '999',
             'Culture' => 'en',
             'Encoding' => 'utf-8',
             'Email' => null,
@@ -133,12 +134,27 @@ public function testGetPaymentParameters(): void
             'Receipt' => '{"items":['
                 . '{"sum":"100.00","name":"Название товара 1 (50%)","quantity":1,"tax":"vat10",'
                 . '"payment_method":"full_payment","payment_object":"commodity"},'
-                . '{"sum":"450.00","name":"Название товара 2","quantity":3,"tax":"vat120",'
+                . '{"sum":"450.00","name":"Название товара 2\"\'><b>","quantity":3,"tax":"vat120",'
                 . '"payment_method":"full_payment","payment_object":"excise","nomenclature_code":"04620034587217"}'
                 . '],"sno":"osn"}',
             'IsTest' => null,
         ];
         $this->assertEquals($expectedPaymentParameters, $paymentParameters);
+
+        $paymentParametersAsJson = $robokassa->getPaymentParametersAsJson($invoiceOptions);
+        $expectedPaymentParametersAsJson = '{"MerchantLogin":"robo-demo","OutSum":"100.00","Description":"Description\"\'><b>",'
+            . '"SignatureValue":"7c6a95094fa5c3e5e2baf83c8817e8c0","IncCurrLabel":null,"InvId":"999","Culture":"en",'
+            . '"Encoding":"utf-8","Email":null,"ExpirationDate":null,"OutSumCurrency":null,"UserIp":null,'
+            . '"Receipt":"{\"items\":['
+            . '{\"sum\":\"100.00\",\"name\":\"Название товара 1 (50%)\",\"quantity\":1,\"tax\":\"vat10\",'
+            . '\"payment_method\":\"full_payment\",\"payment_object\":\"commodity\"},'
+            . '{\\"sum\\":\\"450.00\\",\\"name\\":\\"Название товара 2\\\\\\"\'><b>\\",\\"quantity\\":3,\\"tax\\":\\"vat120\\",'
+            . '\"payment_method\":\"full_payment\",\"payment_object\":\"excise\",\"nomenclature_code\":\"04620034587217\"}],'
+            . '\"sno\":\"osn\"}","IsTest":null}';
+        $this->assertEquals($expectedPaymentParametersAsJson, $paymentParametersAsJson);
+
+        $decodedJson = json_decode($paymentParametersAsJson, true, 512, JSON_THROW_ON_ERROR);
+        $this->assertEquals($expectedPaymentParameters, $decodedJson);
     }
 
     public function testPaymentReceipt(): void