Merge pull request #74 from unzerdev/UMCS-434/basket_v2_examples

Ryouzanpaku · web-flow · commit 68f840f6fb43 · 2022-04-13T15:02:31.000+02:00
(fix) (UMCS-434) Make examples use basket v2.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,8 +7,11 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 ### Added
 *   Add Support for basket `v2` resource.
 ### Changed
-* Add support for payment state `create` which can occur when using payment pages.
-* Several minor improvements.
+*   Add support for payment state `create` which can occur when using payment pages.
+*   Examples:
+    *   Use `v2/basket` resource for secured payment methods and payment pages.
+    *   Remove broken image-URLs of payment page examples.
+*   Several minor improvements.
 
 ## [1.1.4.2](https://github.com/unzerdev/php-sdk/compare/1.1.4.1..1.1.4.2)
 ### Added
diff --git a/examples/EmbeddedPayPage/Controller.php b/examples/EmbeddedPayPage/Controller.php
@@ -78,8 +78,7 @@
     $orderId = 'o' . str_replace(['0.', ' '], '', microtime(false));
 
     // ... however you can customize the Payment Page using additional parameters.
-    $paypage->setLogoImage('https://dev.unzer.com/wp-content/uploads/2020/09/Unzer__PrimaryLogo_Raspberry_RGB.png')
-            ->setShopName('My Test Shop')
+    $paypage->setShopName('My Test Shop')
             ->setTagline('Try and stop us from being awesome!')
             ->setOrderId($orderId)
             ->setInvoiceId('i' . microtime(true));
@@ -88,10 +87,17 @@
     $paypage->setEffectiveInterestRate(4.99);
 
     // ... a Basket is mandatory for InstallmentSecured
-    $basketItem = (new BasketItem('Hat', 100.00, 119.00, 1))
-        ->setAmountGross(119.0)
-        ->setAmountVat(19.0);
-    $basket = new Basket($orderId, 119.0, 'EUR', [$basketItem]);
+    $basketItem = (new BasketItem())
+        ->setAmountPerUnitGross(119.00)
+        ->setVat(19.00)
+        ->setQuantity(1)
+        ->setBasketItemReferenceId('item1')
+        ->setTitle('Hat');
+
+    $basket = new Basket($orderId);
+    $basket->setTotalValueGross(119.00)
+        ->addBasketItem($basketItem)
+        ->setCurrencyCode('EUR');
 
     if ($transactionType === 'charge') {
         $unzer->initPayPageCharge($paypage, $customer, $basket);
diff --git a/examples/HostedPayPage/Controller.php b/examples/HostedPayPage/Controller.php
@@ -84,9 +84,7 @@ function redirect($url, $merchantMessage = '', $clientMessage = '')
     $orderId = 'o' . str_replace(['0.', ' '], '', microtime(false));
 
     // ... however you can customize the Payment Page using additional parameters.
-    $paypage->setLogoImage('https://dev.unzer.com/wp-content/uploads/2020/09/Unzer__PrimaryLogo_Raspberry_RGB.png')
-            ->setFullPageImage('https://dev.unzer.com/wp-content/uploads/2020/09/01_Unzer_Ambitious_RGB_LoRes.jpg')
-            ->setShopName('My Test Shop')
+    $paypage->setShopName('My Test Shop')
             ->setShopDescription('Best shop in the whole world!')
             ->setTagline('Try and stop us from being awesome!')
             ->setOrderId('OrderNr' . $orderId)
@@ -101,10 +99,17 @@ function redirect($url, $merchantMessage = '', $clientMessage = '')
     $paypage->setEffectiveInterestRate(4.99);
 
     // ... a Basket is mandatory for InstallmentSecured
-    $basketItem = (new BasketItem('Hat', 100.00, 119.00, 1))
-        ->setAmountGross(119.0)
-        ->setAmountVat(19.0);
-    $basket = new Basket($orderId, 119.0, 'EUR', [$basketItem]);
+    $basketItem = (new BasketItem())
+        ->setAmountPerUnitGross(119.00)
+        ->setVat(19.00)
+        ->setQuantity(1)
+        ->setBasketItemReferenceId('item1')
+        ->setTitle('Hat');
+
+    $basket = new Basket($orderId);
+    $basket->setTotalValueGross(119.00)
+        ->addBasketItem($basketItem)
+        ->setCurrencyCode('EUR');
 
     if ($transactionType === 'charge') {
         $unzer->initPayPageCharge($paypage, $customer, $basket);
diff --git a/examples/InstallmentSecured/Controller.php b/examples/InstallmentSecured/Controller.php
@@ -87,10 +87,17 @@ function redirect($url, $merchantMessage = '', $clientMessage = '')
         ->setEmail('linda.heideich@test.de');
 
     // A Basket is mandatory for Installment Secured payment type
-    $basketItem = (new BasketItem('Hat', 100.00, 119.00, 1))
-        ->setAmountGross(119.0)
-        ->setAmountVat(19.0);
-    $basket = (new Basket($orderId, 119.0, 'EUR', [$basketItem]))->setAmountTotalVat(19.0);
+    $basketItem = (new BasketItem())
+        ->setAmountPerUnitGross(119.00)
+        ->setVat(19)
+        ->setQuantity(1)
+        ->setBasketItemReferenceId('item1')
+        ->setTitle('Hat');
+
+    $basket = new Basket($orderId);
+    $basket->setTotalValueGross(119.00)
+        ->addBasketItem($basketItem)
+        ->setCurrencyCode('EUR');
 
     // initialize the payment
     $authorize = $unzer->authorize(
diff --git a/examples/InvoiceSecured/Controller.php b/examples/InvoiceSecured/Controller.php
@@ -71,10 +71,17 @@ function redirect($url, $merchantMessage = '', $clientMessage = '')
     $orderId = 'o' . str_replace(['0.', ' '], '', microtime(false));
 
     // A Basket is mandatory for Invoice Secured payment type
-    $basketItem = (new BasketItem('Hat', 100.00, 119.00, 1))
-        ->setAmountGross(119.0)
-        ->setAmountVat(19.0);
-    $basket = new Basket($orderId, 119.0, 'EUR', [$basketItem]);
+    $basketItem = (new BasketItem())
+        ->setAmountPerUnitGross(119.00)
+        ->setVat(19.00)
+        ->setQuantity(1)
+        ->setBasketItemReferenceId('item1')
+        ->setTitle('Hat');
+
+    $basket = new Basket($orderId);
+    $basket->setTotalValueGross(119.00)
+        ->addBasketItem($basketItem)
+        ->setCurrencyCode('EUR');
 
     $transaction = $unzer->charge(119.0, 'EUR', $paymentTypeId, CONTROLLER_URL, $customerId, $orderId, null, $basket);
 
diff --git a/examples/SepaDirectDebitSecured/Controller.php b/examples/SepaDirectDebitSecured/Controller.php
@@ -67,10 +67,17 @@ function redirect($url, $merchantMessage = '', $clientMessage = '')
     $orderId = 'o' . str_replace(['0.', ' '], '', microtime(false));
 
     // A Basket is mandatory for SEPA direct debit secured payment type
-    $basketItem = (new BasketItem('Hat', 100.00, 119.00, 1))
-        ->setAmountGross(119.0)
-        ->setAmountVat(19.0);
-    $basket = new Basket($orderId, 119.0, 'EUR', [$basketItem]);
+    $basketItem = (new BasketItem())
+        ->setAmountPerUnitGross(119.00)
+        ->setVat(19.00)
+        ->setQuantity(1)
+        ->setBasketItemReferenceId('item1')
+        ->setTitle('Hat');
+
+    $basket = new Basket($orderId);
+    $basket->setTotalValueGross(119.00)
+        ->addBasketItem($basketItem)
+        ->setCurrencyCode('EUR');
 
     $transaction = $unzer->charge(119.0, 'EUR', $paymentTypeId, CONTROLLER_URL, $customerId, $orderId, null, $basket);
 
diff --git a/examples/index.php b/examples/index.php
@@ -327,7 +327,7 @@ function printMessage($type, $title, $text)
                             server and redirected to a given RedirectUrl.
                         </div>
                     </div>
-                    <div class="ui attached white button" onclick="location.href='https://docs.unzer.com/accept-payments/accept-payments-payment-page';">
+                    <div class="ui attached white button" onclick="location.href='https://docs.unzer.com/online-payments/payment-pages/integrate-hpp/';">
                         Documentation
                     </div>
                     <div id="tryHostedPayPageExample" class="ui bottom attached green button" onclick="location.href='HostedPayPage/';">
@@ -344,7 +344,7 @@ function printMessage($type, $title, $text)
                             The Payment Page will be shown as an Overlay in your own shop.
                         </div>
                     </div>
-                    <div class="ui attached white button" onclick="location.href='https://docs.unzer.com/accept-payments/accept-payments-payment-page';">
+                    <div class="ui attached white button" onclick="location.href='https://docs.unzer.com/online-payments/payment-pages/integrate-epp/';">
                         Documentation
                     </div>
                     <div id="tryEmbeddedPayPageExample" class="ui bottom attached green button" onclick="location.href='EmbeddedPayPage/';">
diff --git a/src/Resources/TransactionTypes/Authorization.php b/src/Resources/TransactionTypes/Authorization.php
@@ -65,9 +65,9 @@ class Authorization extends AbstractTransactionType
     /**
      * Authorization constructor.
      *
-     * @param float  $amount
-     * @param string $currency
-     * @param string $returnUrl
+     * @param float|null  $amount
+     * @param string|null $currency
+     * @param string|null $returnUrl
      */
     public function __construct($amount = null, $currency = null, $returnUrl = null)
     {
@@ -87,7 +87,7 @@ public function getAmount(): ?float
     }
 
     /**
-     * @param float $amount
+     * @param float|null $amount
      *
      * @return self
      */
@@ -120,7 +120,7 @@ public function getCurrency(): ?string
     }
 
     /**
-     * @param string $currency
+     * @param string|null $currency
      *
      * @return self
      */
@@ -177,7 +177,7 @@ public function getPaymentReference(): ?string
     }
 
     /**
-     * @param $paymentReference
+     * @param string|null $paymentReference
      *
      * @return Authorization
      */
@@ -265,7 +265,7 @@ protected function getResourcePath($httpMethod = HttpAdapterInterface::REQUEST_G
     /**
      * Full cancel of this authorization.
      *
-     * @param null $amount
+     * @param float|null $amount
      *
      * @return Cancellation
      *
@@ -280,7 +280,7 @@ public function cancel($amount = null): Cancellation
     /**
      * Charge authorization.
      *
-     * @param null $amount
+     * @param float|null $amount
      *
      * @return Charge
      *

Original file line number	Diff line number	Diff line change
`@@ -65,9 +65,9 @@ class Authorization extends AbstractTransactionType`
`65`	`65`	`/**`
`66`	`66`	`* Authorization constructor.`
`67`	`67`	`*`
`68`		`- * @param float $amount`
`69`		`- * @param string $currency`
`70`		`- * @param string $returnUrl`
	`68`	`+ * @param float\|null $amount`
	`69`	`+ * @param string\|null $currency`
	`70`	`+ * @param string\|null $returnUrl`
`71`	`71`	`*/`
`72`	`72`	`public function __construct($amount = null, $currency = null, $returnUrl = null)`
`73`	`73`	`{`
`@@ -87,7 +87,7 @@ public function getAmount(): ?float`
`87`	`87`	`}`
`88`	`88`
`89`	`89`	`/**`
`90`		`- * @param float $amount`
	`90`	`+ * @param float\|null $amount`
`91`	`91`	`*`
`92`	`92`	`* @return self`
`93`	`93`	`*/`
`@@ -120,7 +120,7 @@ public function getCurrency(): ?string`
`120`	`120`	`}`
`121`	`121`
`122`	`122`	`/**`
`123`		`- * @param string $currency`
	`123`	`+ * @param string\|null $currency`
`124`	`124`	`*`
`125`	`125`	`* @return self`
`126`	`126`	`*/`
`@@ -177,7 +177,7 @@ public function getPaymentReference(): ?string`
`177`	`177`	`}`
`178`	`178`
`179`	`179`	`/**`
`180`		`- * @param $paymentReference`
	`180`	`+ * @param string\|null $paymentReference`
`181`	`181`	`*`
`182`	`182`	`* @return Authorization`
`183`	`183`	`*/`
`@@ -265,7 +265,7 @@ protected function getResourcePath($httpMethod = HttpAdapterInterface::REQUEST_G`
`265`	`265`	`/**`
`266`	`266`	`* Full cancel of this authorization.`
`267`	`267`	`*`
`268`		`- * @param null $amount`
	`268`	`+ * @param float\|null $amount`
`269`	`269`	`*`
`270`	`270`	`* @return Cancellation`
`271`	`271`	`*`
`@@ -280,7 +280,7 @@ public function cancel($amount = null): Cancellation`
`280`	`280`	`/**`
`281`	`281`	`* Charge authorization.`
`282`	`282`	`*`
`283`		`- * @param null $amount`
	`283`	`+ * @param float\|null $amount`
`284`	`284`	`*`
`285`	`285`	`* @return Charge`
`286`	`286`	`*`