the dtd actually depends on what request/response/message is about to be generated. So there is a hard dependency between the model and the dtd. Refactored to have it set in CXml/Builder to reflect that.

Author: mathielen

src/CXml/Builder.php

@@ -123,6 +123,8 @@ class Builder
 
     private ?Status $status = null;
 
+    private string $dtdUri = 'http://xml.cxml.org/schemas/cXML/1.2.063/cXML.dtd';
+
     private function __construct(private ?string $senderUserAgent, private readonly ?string $locale = null, ?PayloadIdentityFactoryInterface $payloadIdentityFactory = null)
     {
         $this->payloadIdentityFactory = $payloadIdentityFactory ?? new DefaultPayloadIdentityFactory();
@@ -133,6 +135,13 @@ public static function create(string $senderUserAgent = 'cxml-php UserAgent', ?s
         return new self($senderUserAgent, $locale, $payloadIdentityFactory);
     }
 
+    public function dtdUri(string $dtdUri): self
+    {
+        $this->dtdUri = $dtdUri;
+
+        return $this;
+    }
+
     public function payload(?PayloadInterface $payload = null): self
     {
         $this->payload = $payload;
@@ -209,6 +218,7 @@ public function build(?string $deploymentMode = null): CXml
                     new Request($this->payload, null, $deploymentMode),
                     $this->buildHeader(),
                     $this->locale,
+                    $this->dtdUri,
                 );
                 break;
 
@@ -219,6 +229,7 @@ public function build(?string $deploymentMode = null): CXml
                     new Message($this->payload, $this->status, null, $deploymentMode),
                     $this->buildHeader(),
                     $this->locale,
+                    $this->dtdUri,
                 );
                 break;
 
@@ -235,6 +246,7 @@ public function build(?string $deploymentMode = null): CXml
                     $this->payloadIdentityFactory->newPayloadIdentity(),
                     new Response($status, $this->payload),
                     $this->locale,
+                    $this->dtdUri,
                 );
                 break;
 
@@ -245,6 +257,7 @@ public function build(?string $deploymentMode = null): CXml
                         $this->payloadIdentityFactory->newPayloadIdentity(),
                         new Response($this->status),
                         $this->locale,
+                        $this->dtdUri,
                     );
 
                     break;

src/CXml/Model/CXml.php

@@ -14,7 +14,7 @@
 
 #[Serializer\XmlRoot('cXML')]
 #[Serializer\AccessorOrder(order: 'custom', custom: ['header', 'message', 'request', 'response'])]
-readonly class CXml implements Stringable
+class CXml implements Stringable
 {
     final public const DEPLOYMENT_TEST = 'test';
 
@@ -23,35 +23,42 @@
     protected function __construct(
         #[Serializer\XmlAttribute]
         #[Serializer\SerializedName('payloadID')]
-        public string $payloadId,
+        readonly public string $payloadId,
         #[Serializer\XmlAttribute]
-        public DateTimeInterface $timestamp,
+        readonly public DateTimeInterface $timestamp,
         #[Serializer\SerializedName('Request')]
-        public ?Request $request = null,
+        readonly public ?Request $request = null,
         #[Serializer\SerializedName('Response')]
-        public ?Response $response = null,
+        readonly public ?Response $response = null,
         #[Serializer\SerializedName('Message')]
-        public ?Message $message = null,
+        readonly public ?Message $message = null,
         #[Serializer\SerializedName('Header')]
-        public ?Header $header = null,
+        readonly public ?Header $header = null,
         #[Serializer\XmlAttribute(namespace: 'http://www.w3.org/XML/1998/namespace')]
-        public ?string $lang = null,
+        readonly public ?string $lang = null,
+        #[Serializer\Exclude]
+        public string $dtdUri = 'http://xml.cxml.org/schemas/cXML/1.2.063/cXML.dtd',
     ) {
     }
 
-    public static function forMessage(PayloadIdentity $payloadIdentity, Message $message, Header $header, ?string $lang = null): self
+    public function setDtdUri(string $dtdUri): void
     {
-        return new self($payloadIdentity->payloadId, $payloadIdentity->timestamp, null, null, $message, $header, $lang);
+        $this->dtdUri = $dtdUri;
     }
 
-    public static function forRequest(PayloadIdentity $payloadIdentity, Request $request, Header $header, ?string $lang = null): self
+    public static function forMessage(PayloadIdentity $payloadIdentity, Message $message, Header $header, ?string $lang = null, string $dtdUri = 'http://xml.cxml.org/schemas/cXML/1.2.063/cXML.dtd'): self
     {
-        return new self($payloadIdentity->payloadId, $payloadIdentity->timestamp, $request, null, null, $header, $lang);
+        return new self($payloadIdentity->payloadId, $payloadIdentity->timestamp, null, null, $message, $header, $lang, $dtdUri);
     }
 
-    public static function forResponse(PayloadIdentity $payloadIdentity, Response $response, ?string $lang = null): self
+    public static function forRequest(PayloadIdentity $payloadIdentity, Request $request, Header $header, ?string $lang = null, string $dtdUri = 'http://xml.cxml.org/schemas/cXML/1.2.063/cXML.dtd'): self
     {
-        return new self($payloadIdentity->payloadId, $payloadIdentity->timestamp, null, $response, null, null, $lang);
+        return new self($payloadIdentity->payloadId, $payloadIdentity->timestamp, $request, null, null, $header, $lang, $dtdUri);
+    }
+
+    public static function forResponse(PayloadIdentity $payloadIdentity, Response $response, ?string $lang = null, string $dtdUri = 'http://xml.cxml.org/schemas/cXML/1.2.063/cXML.dtd'): self
+    {
+        return new self($payloadIdentity->payloadId, $payloadIdentity->timestamp, null, $response, null, null, $lang, $dtdUri);
     }
 
     public function __toString(): string

src/CXml/Serializer.php

@@ -28,15 +28,12 @@
 
 readonly class Serializer
 {
-    public const DOC_TYPE_VERSION = '1.2.063';
-
     private function __construct(
         private SerializerInterface $jmsSerializer,
-        private string $dtdUri,
     ) {
     }
 
-    public static function create(string $dtdUri = 'http://xml.cxml.org/schemas/cXML/' . self::DOC_TYPE_VERSION . '/cXML.dtd'): self
+    public static function create(): self
     {
         $jmsSerializer = SerializerBuilder::create()
             ->configureListeners(static function (EventDispatcherInterface $dispatcher): void {
@@ -57,27 +54,35 @@ public static function create(string $dtdUri = 'http://xml.cxml.org/schemas/cXML
             )
             ->build();
 
-        return new self($jmsSerializer, $dtdUri);
+        return new self($jmsSerializer);
     }
 
     public function deserialize(string $xml): CXml
     {
-        // remove doctype (if exists), as it would throw a JMS\Serializer\Exception\InvalidArgumentException
-        $xml = preg_replace('/<!doctype[^>]+?>/i', '', $xml);
+        $dtdUri = 'http://xml.cxml.org/schemas/cXML/1.2.063/cXML.dtd';
+        if (preg_match('/<!doctype.+"(.+)"[^>]*>/i', $xml, $matches) !== false) {
+            $dtdUri = $matches[1];
+
+            // remove doctype from xml (if exists), as it would throw a JMS\Serializer\Exception\InvalidArgumentException
+            $xml = preg_replace('/<!doctype[^>]+?>/i', '', $xml);
+        }
 
-        if (null === $xml || '' === trim($xml)) {
+        if ('' === trim($xml ?? '')) {
             throw new RuntimeException('Cannot deserialize empty string');
         }
 
-        /* @phpstan-ignore-next-line */
-        return $this->jmsSerializer->deserialize($xml, CXml::class, 'xml');
+        /** @var CXml $cXml */
+        $cXml = $this->jmsSerializer->deserialize((string)$xml, CXml::class, 'xml');
+        $cXml->setDtdUri($dtdUri);
+
+        return $cXml;
     }
 
     public function serialize(CXml $cxml): string
     {
         $xml = $this->jmsSerializer->serialize($cxml, 'xml');
 
-        $docType = '<!DOCTYPE cXML SYSTEM "' . $this->dtdUri . '">';
+        $docType = '<!DOCTYPE cXML SYSTEM "' . $cxml->dtdUri . '">';
         $xmlPrefix = '<?xml version="1.0" encoding="UTF-8"?>';
 
         // add doctype, as it is mandatory in cXML