if comment has a textual value, we dont serialize the <Attachment> element anymore. See DTD:

Author: mathielen

composer.json

@@ -87,6 +87,9 @@
     ]
   },
   "config": {
+    "platform": {
+      "php": "8.2"
+    },
     "allow-plugins": {
       "phpstan/extension-installer": true
     }

src/CXml/Jms/CXmlExclusionStrategy.php

@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CXml\Jms;
+
+use CXml\Model\Comment;
+use JMS\Serializer\Context;
+use JMS\Serializer\Exclusion\ExclusionStrategyInterface;
+use JMS\Serializer\Metadata\ClassMetadata;
+use JMS\Serializer\Metadata\PropertyMetadata;
+
+class CXmlExclusionStrategy implements ExclusionStrategyInterface
+{
+    public function shouldSkipClass(ClassMetadata $metadata, Context $context): bool
+    {
+        return false;
+    }
+
+    public function shouldSkipProperty(PropertyMetadata $property, Context $context): bool
+    {
+        // Check if we are serializing to XML
+        if ('xml' !== $context->getFormat()) {
+            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;
+                }
+            }
+        }
+
+        return false;
+    }
+}

src/CXml/Model/Comment.php

@@ -19,8 +19,8 @@ public function __construct(
         public ?string $type = null,
         #[Serializer\XmlAttribute(namespace: 'http://www.w3.org/XML/1998/namespace')]
         public ?string $lang = null,
-        ?string $attachment = null,
+        ?string $attachmentUrl = null,
     ) {
-        $this->attachment = (null === $attachment ? null : new Url($attachment));
+        $this->attachment = (null === $attachmentUrl ? null : new Url($attachmentUrl));
     }
 }

src/CXml/Serializer.php

@@ -4,6 +4,7 @@
 
 namespace CXml;
 
+use CXml\Jms\CXmlExclusionStrategy;
 use CXml\Jms\CXmlWrappingNodeJmsEventSubscriber;
 use CXml\Jms\JmsDateTimeHandler;
 use CXml\Model\CXml;
@@ -15,6 +16,7 @@
 use JMS\Serializer\GraphNavigatorInterface;
 use JMS\Serializer\Handler\HandlerRegistry;
 use JMS\Serializer\Naming\IdenticalPropertyNamingStrategy;
+use JMS\Serializer\SerializationContext;
 use JMS\Serializer\SerializerBuilder;
 use JMS\Serializer\SerializerInterface;
 use JMS\Serializer\XmlDeserializationVisitor;
@@ -52,6 +54,10 @@ public static function create(): self
             ->setPropertyNamingStrategy(
                 new IdenticalPropertyNamingStrategy(),
             )
+            ->setSerializationContextFactory(function () {
+                return SerializationContext::create()
+                    ->addExclusionStrategy(new CXmlExclusionStrategy());
+            })
             ->build();
 
         return new self($jmsSerializer);

tests/CXmlTest/Model/OrderRequestTest.php

@@ -41,9 +41,20 @@ final class OrderRequestTest extends TestCase implements PayloadIdentityFactoryI
 {
     private DtdValidator $dtdValidator;
 
+    private Serializer $serializer;
+
     protected function setUp(): void
     {
         $this->dtdValidator = DtdValidator::fromDtdDirectory(__DIR__ . '/../../metadata/cxml/dtd/1.2.050/');
+        $this->serializer = Serializer::create();
+    }
+
+    public function testReference(): void
+    {
+        // test whether deserialize/serialize of the reference file works
+        $xml = file_get_contents(__DIR__ . '/../../metadata/cxml/samples/OrderRequest.xml');
+        $cxml = Serializer::create()->deserialize($xml);
+        Serializer::create()->serialize($cxml);
     }
 
     public function testMinimumExample(): void
@@ -171,6 +182,8 @@ public function testMinimumExample(): void
             ),
             new DateTime('2020-02-28'),
         );
+        $item->addComment(new Comment('Test comment', 'test', ''));
+
         $orderRequest->addItem($item);
 
         $cxml = Builder::create('Platform Order Fulfillment Hub', null, $this)
@@ -183,7 +196,7 @@ public function testMinimumExample(): void
         $this->assertSame('OrderRequest_1625586002.193314.7293@dev', (string)$cxml);
 
         $xml = Serializer::create()->serialize($cxml);
-        $this->assertXmlStringEqualsXmlFile('tests/metadata/cxml/samples/OrderRequest.xml', $xml);
+        $this->assertXmlStringEqualsXmlFile(__DIR__ . '/../../metadata/cxml/samples/OrderRequest.xml', $xml);
 
         $this->dtdValidator->validateAgainstDtd($xml);
     }

tests/metadata/cxml/samples/OrderRequest.xml

@@ -101,6 +101,7 @@
                     <UnitOfMeasure>EA</UnitOfMeasure>
                     <Classification domain="custom">0</Classification>
                  </ItemDetail>
+                 <Comments type="test" xml:lang="">Test comment</Comments>
              </ItemOut>
          </OrderRequest>
     </Request>