Merge pull request #51 from paynl/extrafields

Added stats field to PayOrder class

Author: woutse

Tests/Unit/Model/PayOrderTest.php

@@ -14,13 +14,13 @@ public function testConstructorMapsPayloadObject(): void
     {
         $payload = [
             'object' => [
-                'id'          => 'PO-123',
-                'description' => 'Test order',
-                'reference'   => 'REF-999',
-                'status'      => ['code' => 200, 'action' => 'PAID'],
-                'amount'          => ['value' => 1000, 'currency' => 'EUR'],
-                'capturedAmount'  => ['value' => 500, 'currency' => 'EUR'],
-                'authorizedAmount'=> ['value' => 1000, 'currency' => 'EUR'],
+                'id'               => 'PO-123',
+                'description'      => 'Test order',
+                'reference'        => 'REF-999',
+                'status'           => ['code' => 200, 'action' => 'PAID'],
+                'amount'           => ['value' => 1000, 'currency' => 'EUR'],
+                'capturedAmount'   => ['value' => 500, 'currency' => 'EUR'],
+                'authorizedAmount' => ['value' => 1000, 'currency' => 'EUR'],
             ],
         ];
 
@@ -42,7 +42,7 @@ public function testAmountRefundedIsNullWhenNotSet(): void
 
     public function testAmountRefundedReturnsValueInUnits(): void
     {
-        $order = new PayOrder();
+        $order  = new PayOrder();
         $amount = new Amount(1234, 'EUR');
 
         $order->setAmountRefunded($amount);
@@ -124,6 +124,7 @@ public function testPaymentHelpersReturnNullWhenNoPayments(): void
         $this->assertNull($order->getPaymentMethod());
         $this->assertNull($order->getCustomerId());
         $this->assertNull($order->getCustomerName());
+        $this->assertSame([], $order->getPayments());
     }
 
     public function testIsTestmodeTrueWhenIntegrationTestFlagTrue(): void
@@ -146,6 +147,13 @@ public function testIsTestmodeFalseWhenIntegrationTestFlagMissingOrFalse(): void
         $this->assertFalse($order->isTestmode());
     }
 
+    public function testCheckoutDataReturnsEmptyArrayWhenNotSet(): void
+    {
+        $order = new PayOrder();
+
+        $this->assertSame([], $order->getCheckoutData());
+    }
+
     public function testAmountAndCurrency(): void
     {
         $order  = new PayOrder();
@@ -157,6 +165,21 @@ public function testAmountAndCurrency(): void
         $this->assertSame('EUR', $order->getCurrency());
     }
 
+    public function testAuthorizedAndCapturedAmountGettersAndSetters(): void
+    {
+        $order      = new PayOrder();
+        $authorized = new Amount(1000, 'EUR');
+        $captured   = new Amount(500, 'EUR');
+
+        $this->assertNull($order->getAuthorizedAmount());
+        $this->assertNull($order->getCapturedAmount());
+
+        $order->setAuthorizedAmount($authorized);
+        $order->setCapturedAmount($captured);
+
+        $this->assertSame($authorized, $order->getAuthorizedAmount());
+        $this->assertSame($captured, $order->getCapturedAmount());
+    }
 
     public function testPaymentAndStatusUrls(): void
     {
@@ -192,8 +215,53 @@ public function testTransferDataGetterAndSetter(): void
         $data = ['some' => 'value', 'foo' => 'bar'];
 
         $order->setTransferData($data);
-
         $this->assertSame($data, $order->getTransferData());
+
+        $order->setTransferData(null);
+        $this->assertNull($order->getTransferData());
     }
 
+    public function testStatsGettersReturnNullWhenNotSet(): void
+    {
+        $order = new PayOrder();
+
+        // Typed property $stats is not initialized unless setStats() is called
+        $order->setStats([]);
+
+        $this->assertSame([], $order->getStats());
+        $this->assertNull($order->getExtra1());
+        $this->assertNull($order->getExtra2());
+        $this->assertNull($order->getExtra3());
+        $this->assertNull($order->getTool());
+        $this->assertNull($order->getInfo());
+        $this->assertNull($order->getObject());
+        $this->assertNull($order->getDomainId());
+    }
+
+
+    public function testStatsGettersReturnValuesWhenSet(): void
+    {
+        $order = new PayOrder();
+
+        $stats = [
+            'extra1'   => 'E1',
+            'extra2'   => 'E2',
+            'extra3'   => 'E3',
+            'tool'     => 'api',
+            'info'     => ['k' => 'v'],
+            'object'   => 'order',
+            'domainId' => 123,
+        ];
+
+        $order->setStats($stats);
+
+        $this->assertSame($stats, $order->getStats());
+        $this->assertSame('E1', $order->getExtra1());
+        $this->assertSame('E2', $order->getExtra2());
+        $this->assertSame('E3', $order->getExtra3());
+        $this->assertSame('api', $order->getTool());
+        $this->assertSame(['k' => 'v'], $order->getInfo());
+        $this->assertSame('order', $order->getObject());
+        $this->assertSame(123, $order->getDomainId());
+    }
 }

samples/OrderStatus.php

@@ -53,4 +53,13 @@
 echo 'getCurrency: ' . $payOrder->getCurrency() . PHP_EOL;
 echo 'paymentMethod: ' . $payOrder->getPaymentMethod() . PHP_EOL;
 
+print_r($payOrder->getStats());
+echo 'extra1: ' . $payOrder->getExtra1() . PHP_EOL;
+echo 'extra2: ' . $payOrder->getExtra2() . PHP_EOL;
+echo 'extra3: ' . $payOrder->getExtra3() . PHP_EOL;
+echo 'getTool: ' . $payOrder->getTool() . PHP_EOL;
+echo 'getInfo: ' . $payOrder->getInfo() . PHP_EOL;
+echo 'getObject: ' . $payOrder->getObject() . PHP_EOL;
+echo 'getDomainId: ' . $payOrder->getDomainId() . PHP_EOL;
+
 print_r($payOrder->getFastCheckoutData());

src/Model/Pay/PayOrder.php

@@ -145,6 +145,10 @@ class PayOrder implements ModelInterface
      */
     protected ?array $transferData;
 
+    /**
+     * @var array
+     */
+    protected ?array $stats = [];
 
     /**
      * @param array|null $payload
@@ -854,4 +858,78 @@ public function setTransferData(?array $transferData): self
         $this->transferData = $transferData;
         return $this;
     }
+
+    /**
+     * @return array|null
+     */
+    public function getStats(): ?array
+    {
+        return $this->stats;
+    }
+
+    /**
+     * @param array|null $stats
+     * @return $this
+     */
+    public function setStats(?array $stats): self
+    {
+        $this->stats = $stats;
+        return $this;
+    }
+
+    /**
+     * @return mixed|null
+     */
+    public function getExtra1()
+    {
+        return $this->stats['extra1'] ?? null;
+    }
+
+    /**
+     * @return mixed|null
+     */
+    public function getExtra2()
+    {
+        return $this->stats['extra2'] ?? null;
+    }
+
+    /**
+     * @return mixed|null
+     */
+    public function getExtra3()
+    {
+        return $this->stats['extra3'] ?? null;
+    }
+
+    /**
+     * @return mixed|null
+     */
+    public function getTool()
+    {
+        return $this->stats['tool'] ?? null;
+    }
+
+    /**
+     * @return mixed|null
+     */
+    public function getInfo()
+    {
+        return $this->stats['info'] ?? null;
+    }
+
+    /**
+     * @return mixed|null
+     */
+    public function getObject()
+    {
+        return $this->stats['object'] ?? null;
+    }
+
+    /**
+     * @return mixed|null
+     */
+    public function getDomainId()
+    {
+        return $this->stats['domainId'] ?? null;
+    }
 }

src/Util/Exchange.php

@@ -27,6 +27,7 @@ class Exchange
     public const ERROR_EMPTY_CONFIG = 8003;
     public const ERROR_PAYLOAD_OBJECT = 8004;
     public const ERROR_ACTION_FAULT = 8005;
+    public const ERROR_PAYLOAD_VALIDATION = 8006;
 
     private PayLoad $payload;
     private ?array $custom_payload;