Merge pull request #14 from kinimodmeyer/several-warehouses

Work in Progress - #13

Author: kinimodmeyer

examples/stock.php

@@ -32,8 +32,20 @@
 $catalog->close();
 
 /*
- * update stock
+ * one centralised warehouse
  */
 $stockHandler->updateStock([
-    (new Tradebyte\Stock\Model\Stock())->setArticleNumber('12345')->setStock(6)
+    (new Tradebyte\Stock\Model\StockUpdate())
+        ->setArticleNumber('12345')
+        ->setStock(6)
 ]);
+
+/*
+ * several warehouses
+ */
+$stockHandler->updateStock([
+    (new Tradebyte\Stock\Model\StockUpdate())
+        ->setArticleNumber('12345')
+        ->addStockForWarehouse('zentrallager', 10)
+        ->addStockForWarehouse('aussenlager', 5)
+]);

src/Stock/Handler.php

@@ -5,6 +5,8 @@
 namespace Tradebyte\Stock;
 
 use Tradebyte\Client;
+use Tradebyte\Stock\Model\Stock;
+use Tradebyte\Stock\Model\StockUpdate;
 use XMLWriter;
 
 class Handler
@@ -31,11 +33,19 @@ public function downloadStockList(string $filePath, array $filter = []): bool
         return $this->client->getRestClient()->downloadFile($filePath, 'stock/', $filter);
     }
 
+    /**
+     * @deprecated Don´t use this method, will be removed in next major release.
+     */
     public function updateStockFromStockList(string $filePath): string
     {
         return $this->client->getRestClient()->postXMLFile($filePath, 'articles/stock');
     }
 
+    /**
+     * Don´t use Stock[] anymore as object-array, support will be removed in next major release.
+     *
+     * @param Stock[]|StockUpdate[] $stockArray
+     */
     public function updateStock(array $stockArray): string
     {
         $writer = new XMLWriter();
@@ -46,7 +56,23 @@ public function updateStock(array $stockArray): string
         foreach ($stockArray as $stock) {
             $writer->startElement('ARTICLE');
             $writer->writeElement('A_NR', $stock->getArticleNumber());
-            $writer->writeElement('A_STOCK', (string)$stock->getStock());
+
+            if ($stock instanceof StockUpdate) {
+                if ($stock->getStock() !== null) {
+                    $writer->writeElement('A_STOCK', (string)$stock->getStock());
+                }
+
+                foreach ($stock->getStockForWarehouses() as $warehouseStock) {
+                    $writer->startElement('A_STOCK');
+                    $writer->writeAttribute('identifier', $warehouseStock['identifier']);
+                    $writer->writeAttribute('key', $warehouseStock['key']);
+                    $writer->text((string)$warehouseStock['stock']);
+                    $writer->endElement();
+                }
+            } else {
+                $writer->writeElement('A_STOCK', (string)$stock->getStock());
+            }
+
             $writer->endElement();
         }
 

src/Stock/Model/StockUpdate.php

@@ -0,0 +1,60 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tradebyte\Stock\Model;
+
+class StockUpdate
+{
+    private ?string $articleNumber = null;
+
+    private ?int $stock = null;
+
+    private array $stockForWarehouses = [];
+
+    public function getArticleNumber(): ?string
+    {
+        return $this->articleNumber;
+    }
+
+    public function setArticleNumber(string $articleNumber): StockUpdate
+    {
+        $this->articleNumber = $articleNumber;
+        return $this;
+    }
+
+    public function getStock(): ?int
+    {
+        return $this->stock;
+    }
+
+    public function setStock(int $stock): StockUpdate
+    {
+        $this->stock = $stock;
+        return $this;
+    }
+
+    public function getStockForWarehouses(): array
+    {
+        return $this->stockForWarehouses;
+    }
+
+    public function addStockForWarehouse(string $warehouseKey, int $stock): StockUpdate
+    {
+        $this->stockForWarehouses[] = [
+            'identifier' => 'key',
+            'key' => $warehouseKey,
+            'stock' => $stock,
+        ];
+        return $this;
+    }
+
+    public function getRawData(): array
+    {
+        return [
+            'article_number' => $this->getArticleNumber(),
+            'stock' => $this->getStock(),
+            'stockForWarehouses' => $this->getStockForWarehouses(),
+        ];
+    }
+}

tests/Stock/StockTest.php tests/Stock/StockListTest.phptests/Stock/StockTest.php renamed to tests/Stock/StockListTest.php

@@ -8,7 +8,7 @@
 use Tradebyte\Client;
 use Tradebyte\Stock\Model\Stock;
 
-class StockTest extends Base
+class StockListTest extends Base
 {
     public function testGetStockListFromFile(): void
     {

tests/Stock/StockUpdateTest.php

@@ -0,0 +1,69 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tradebyte\Stock;
+
+use Tradebyte\Base;
+use Tradebyte\Client;
+use Tradebyte\Stock\Model\StockUpdate;
+
+class StockUpdateTest extends Base
+{
+    public function testUpdateStock(): void
+    {
+        $expectedXML = '<TBCATALOG><ARTICLEDATA><ARTICLE><A_NR>1234</A_NR><A_STOCK>5</A_STOCK>'
+            . '<A_STOCK identifier="key" key="test">6</A_STOCK>'
+            . '<A_STOCK identifier="key" key="test2">7</A_STOCK></ARTICLE></ARTICLEDATA></TBCATALOG>';
+        $mockRestClient = $this->getMockBuilder(Client\Rest::class)
+            ->disableOriginalConstructor()
+            ->onlyMethods(['postXML'])
+            ->getMock();
+        $mockRestClient->expects($this->once())
+            ->method('postXML')
+            ->with('articles/stock', $expectedXML);
+        $mockClient = $this->getMockBuilder(Client::class)
+            ->disableOriginalConstructor()
+            ->onlyMethods(['getRestClient'])
+            ->getMock();
+        $mockClient->expects($this->any())
+            ->method('getRestClient')
+            ->willReturn($mockRestClient);
+        $stockHandler = $mockClient->getStockHandler();
+        $stockHandler->updateStock(
+            [
+                (new StockUpdate())
+                ->setArticleNumber('1234')
+                ->setStock(5)
+                ->addStockForWarehouse('test', 6)
+                ->addStockForWarehouse('test2', 7)
+            ]
+        );
+    }
+
+    public function testStockObjectGetRawData(): void
+    {
+        $stock = new StockUpdate();
+        $stock->setStock(20);
+        $stock->addStockForWarehouse('warehouse', 20);
+        $stock->addStockForWarehouse('warehouse2', 40);
+        $stock->setArticleNumber('123456');
+        $this->assertSame([
+            'article_number' => '123456',
+            'stock' => 20,
+            'stockForWarehouses' => [
+                0 => [
+                    'identifier' => 'key',
+                    'key' => 'warehouse',
+                    'stock' => 20
+                ],
+                1 => [
+
+                    'identifier' => 'key',
+                    'key' => 'warehouse2',
+                    'stock' => 40
+                ]
+            ]
+        ], $stock->getRawData());
+    }
+}