Add ability to generate Index (product catalog)

Author: mathielen

src/CXml/Builder/OrderRequestBuilder.php

@@ -134,7 +134,7 @@ public static function fromPunchOutOrderMessage(
             $orb->addItem(
                 $item->quantity,
                 $item->itemId,
-                $item->itemDetail->description->value ?? '',
+                $item->itemDetail->descriptions[0]->value ?? '',
                 $item->itemDetail->unitOfMeasure,
                 $item->itemDetail->unitPrice->money->getValueCent(),
                 [

src/CXml/Jms/CXmlExclusionStrategy.php

@@ -24,17 +24,14 @@ public function shouldSkipProperty(PropertyMetadata $property, Context $context)
             return false;
         }
 
-        if (Comment::class === $property->class) {
-            if ('attachment' === $property->name) {
-                /** @var Comment $object */
-                /** @phpstan-ignore-next-line */
-                $object = $context->getObject();
-
-                // if comment has a textual value, we dont serialize the <Attachment> element anymore. See DTD:
-                // <!ELEMENT Comments ( #PCDATA | Attachment )* >
-                if (isset($object->value)) {
-                    return true;
-                }
+        if (Comment::class === $property->class && 'attachment' === $property->name) {
+            /** @var Comment $object */
+            /** @phpstan-ignore-next-line */
+            $object = $context->getObject();
+            // if comment has a textual value, we dont serialize the <Attachment> element anymore. See DTD:
+            // <!ELEMENT Comments ( #PCDATA | Attachment )* >
+            if (isset($object->value)) {
+                return true;
             }
         }
 

src/CXml/Model/AttachmentReference.php

@@ -0,0 +1,26 @@
+<?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,20 @@
+<?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

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

src/CXml/Model/Index.php

@@ -0,0 +1,59 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CXml\Model;
+
+use Assert\Assertion;
+use CXml\Model\Trait\CommentsTrait;
+use JMS\Serializer\Annotation as Serializer;
+use ReflectionClass;
+use Stringable;
+
+#[Serializer\XmlRoot('Index')]
+#[Serializer\AccessorOrder(order: 'custom', custom: ['supplierId', 'comments', 'indexItems'])]
+class Index implements Stringable
+{
+    use CommentsTrait;
+
+    public function __construct(
+        #[Serializer\XmlAttribute]
+        #[Serializer\SerializedName('loadmode')]
+        public readonly string $loadmode,
+        #[Serializer\SerializedName('SupplierID')]
+        public readonly SupplierId $supplierId,
+        /**
+         * @var IndexItemWrapper[]
+         */
+        #[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->indexItems[$shortClsName])) {
+            $this->indexItems[$shortClsName] = new IndexItemWrapper();
+        }
+
+        $this->indexItems[$shortClsName]->addIndexItem($indexItem);
+
+        return $this;
+    }
+
+    public function __toString(): string
+    {
+        return 'Index';
+    }
+}

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,34 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CXml\Model;
+
+use DateTimeInterface;
+use JMS\Serializer\Annotation as Serializer;
+
+#[Serializer\AccessorOrder(order: 'custom', custom: ['leadtime', 'expirationDate', 'territoryAvailables'])]
+class IndexItemDetail
+{
+    /**
+     * @var TerritoryAvailable[]
+     */
+    #[Serializer\XmlList(entry: 'TerritoryAvailable', inline: true)]
+    #[Serializer\Type('array<CXml\Model\TerritoryAvailable>')]
+    private array $territoryAvailables = [];
+
+    /**
+     * @param string[] $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): TerritoryAvailable => new TerritoryAvailable($territory), $territoryAvailables);
+    }
+}

src/CXml/Model/IndexItemInterface.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CXml\Model;
+
+interface IndexItemInterface
+{
+}