Add ability to generate Index (product catalog)

Author: mathielen

src/CXml/Model/AttachmentReference.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CXml\Model;
+
+use JMS\Serializer\Annotation as Serializer;
+
+class AttachmentReference
+{
+
+    public function __construct(
+        #[Serializer\SerializedName('Name')]
+        #[Serializer\XmlElement(cdata: false)]
+        public MultilanguageString $name,
+        #[Serializer\SerializedName('Description')]
+        #[Serializer\XmlElement(cdata: false)]
+        public MultilanguageString $description,
+        #[Serializer\SerializedName('InternalID')]
+        #[Serializer\XmlElement(cdata: false)]
+        public string $internalId,
+        #[Serializer\SerializedName('URL')]
+        #[Serializer\XmlElement(cdata: false)]
+        public ?string $url = null,
+    ) {
+    }
+
+}

src/CXml/Model/Characteristic.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CXml\Model;
+
+use JMS\Serializer\Annotation as Serializer;
+
+readonly class Characteristic
+{
+
+    public function __construct(
+        #[Serializer\XmlAttribute]
+        public string $domain,
+        #[Serializer\XmlAttribute]
+        public string $value,
+        #[Serializer\XmlAttribute]
+        public ?string $code = null,
+    ) {
+    }
+
+}

src/CXml/Model/Classification.php

@@ -14,6 +14,8 @@ public function __construct(
         public string $domain,
         #[Serializer\XmlValue(cdata: false)]
         public string $value,
+        #[Serializer\XmlAttribute]
+        public ?string $code = null,
     ) {
     }
 }

src/CXml/Model/Index.php

@@ -0,0 +1,49 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CXml\Model;
+
+use Assert\Assertion;
+use CXml\Model\Trait\CommentsTrait;
+use JMS\Serializer\Annotation as Serializer;
+
+#[Serializer\XmlRoot('Index')]
+#[Serializer\AccessorOrder(order: 'custom', custom: ['supplierId', 'comments', 'indexItems'])]
+class Index
+{
+    use CommentsTrait;
+
+    public function __construct(
+        #[Serializer\XmlAttribute]
+        #[Serializer\SerializedName('loadmode')]
+        public readonly string $loadmode,
+        #[Serializer\SerializedName('SupplierID')]
+        public readonly SupplierId $supplierId,
+        #[Serializer\XmlList(entry: 'IndexItem', inline: true)]
+        #[Serializer\Type('array<CXml\Model\IndexItemWrapper>')]
+        private array $indexItems = [],
+        #[Serializer\Exclude]
+        public string $dtdUri = 'http://xml.cxml.org/schemas/cXML/1.2.063/cXML.dtd',
+    ) {
+        Assertion::inArray($this->loadmode, ['Full', 'Incremental']);
+    }
+
+    public static function create(string $loadmode, SupplierId $supplierId): self
+    {
+        return new self($loadmode, $supplierId);
+    }
+
+    public function addIndexItem(IndexItemInterface $indexItem): self
+    {
+        $shortClsName = (new \ReflectionClass($indexItem))->getShortName();
+
+        if (!isset($this->indexItem[$shortClsName])) {
+            $this->indexItems[$shortClsName] = new IndexItemWrapper();
+        }
+
+        $this->indexItems[$shortClsName]->addIndexItem($indexItem);
+
+        return $this;
+    }
+}

src/CXml/Model/IndexItemAdd.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CXml\Model;
+
+use JMS\Serializer\Annotation as Serializer;
+
+class IndexItemAdd implements IndexItemInterface
+{
+    public function __construct(
+        #[Serializer\SerializedName('ItemID')]
+        public ItemId $itemId,
+        #[Serializer\SerializedName('ItemDetail')]
+        public ItemDetail $itemDetail,
+        #[Serializer\SerializedName('IndexItemDetail')]
+        public IndexItemDetail $indexItemDetail,
+    ) {}
+
+    public static function create(ItemId $itemId, ItemDetail $itemDetail, IndexItemDetail $indexItemDetail): self
+    {
+        return new self($itemId, $itemDetail, $indexItemDetail);
+    }
+
+}

src/CXml/Model/IndexItemDelete.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CXml\Model;
+
+use JMS\Serializer\Annotation as Serializer;
+
+class IndexItemDelete implements IndexItemInterface
+{
+    public function __construct(
+        #[Serializer\SerializedName('ItemID')]
+        public ItemId $itemId,
+        #[Serializer\SerializedName('ItemDetail')]
+        public ItemDetail $itemDetail,
+        #[Serializer\SerializedName('IndexItemDetail')]
+        public IndexItemDetail $indexItemDetail,
+    ) {}
+
+    public static function create(ItemId $itemId, ItemDetail $itemDetail, IndexItemDetail $indexItemDetail,): self
+    {
+        return new self($itemId, $itemDetail, $indexItemDetail);
+    }
+
+}

src/CXml/Model/IndexItemDetail.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CXml\Model;
+
+use JMS\Serializer\Annotation as Serializer;
+
+#[Serializer\AccessorOrder(order: 'custom', custom: ['leadtime', 'expirationDate', 'territoryAvailables'])]
+class IndexItemDetail
+{
+
+    #[Serializer\XmlList(entry: 'TerritoryAvailable', inline: true)]
+    #[Serializer\Type('array<CXml\Model\TerritoryAvailable>')]
+    private array $territoryAvailables = [];
+
+    public function __construct(
+        #[Serializer\SerializedName('LeadTime')]
+        #[Serializer\XmlElement(cdata: false)]
+        public int $leadtime,
+        #[Serializer\SerializedName('ExpirationDate')]
+        #[Serializer\XmlElement(cdata: false)]
+        public ?\DateTimeInterface $expirationDate = null,
+        array $territoryAvailables
+    ) {
+        $this->territoryAvailables = array_map(fn(string $territory) => new TerritoryAvailable($territory), $territoryAvailables);
+    }
+
+}

src/CXml/Model/IndexItemInterface.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace CXml\Model;
+
+interface IndexItemInterface
+{
+}

src/CXml/Model/IndexItemPunchout.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CXml\Model;
+
+use JMS\Serializer\Annotation as Serializer;
+
+class IndexItemPunchout implements IndexItemInterface
+{
+    public function __construct(
+        #[Serializer\SerializedName('ItemID')]
+        public ItemId $itemId,
+        #[Serializer\SerializedName('ItemDetail')]
+        public ItemDetail $itemDetail,
+        #[Serializer\SerializedName('IndexItemDetail')]
+        public IndexItemDetail $indexItemDetail,
+    ) {}
+
+    public static function create(ItemId $itemId, ItemDetail $itemDetail, IndexItemDetail $indexItemDetail,): self
+    {
+        return new self($itemId, $itemDetail, $indexItemDetail);
+    }
+
+}

src/CXml/Model/IndexItemWrapper.php

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CXml\Model;
+
+use JMS\Serializer\Annotation as Serializer;
+
+class IndexItemWrapper
+{
+
+    public function __construct(
+        #[Serializer\XmlList(entry: 'IndexItemAdd', inline: true)]
+        #[Serializer\Type('array<CXml\Model\IndexItemAdd>')]
+        private array $indexItemAdds = [],
+        #[Serializer\XmlList(entry: 'IndexItemDelete', inline: true)]
+        #[Serializer\Type('array<CXml\Model\IndexItemDelete>')]
+        private array $indexItemDeletes = [],
+        #[Serializer\XmlList(entry: 'IndexItemPunchout', inline: true)]
+        #[Serializer\Type('array<CXml\Model\IndexItemPunchout>')]
+        private array $indexItemPunchouts = [],
+    ) {}
+
+    public function addIndexItem(IndexItemInterface $indexItem): self
+    {
+        if ($indexItem instanceof IndexItemAdd) {
+            $this->indexItemAdds[] = $indexItem;
+        } elseif ($indexItem instanceof IndexItemDelete) {
+            $this->indexItemDeletes[] = $indexItem;
+        } elseif ($indexItem instanceof IndexItemPunchout) {
+            $this->indexItemPunchouts[] = $indexItem;
+        } else {
+            throw new \InvalidArgumentException('Invalid index item type');
+        }
+
+        return $this;
+    }
+
+}