feature #58599 [Serializer] Add xml context option to ignore empty attributes (qdequippe)

fabpot · fabpot · commit 56c211e9f73b · 2025-01-17T08:28:38.000+01:00
This PR was squashed before being merged into the 7.3 branch. Discussion ---------- [Serializer] Add xml context option to ignore empty attributes | Q | A | ------------- | --- | Branch? | 7.2 | Bug fix? |no | New feature? | yes | Deprecations? | no | Issues | | License | MIT Sometimes XML attributes are optional and should not be present in the serialized data. This PR adds the option to skip empty attributes (null or empty) during encoding. Commits ------- d011981 [Serializer] Add xml context option to ignore empty attributes
diff --git a/src/Symfony/Component/Serializer/Context/Encoder/XmlEncoderContextBuilder.php b/src/Symfony/Component/Serializer/Context/Encoder/XmlEncoderContextBuilder.php
@@ -160,4 +160,12 @@ public function withCdataWrappingPattern(?string $cdataWrappingPattern): static
     {
         return $this->with(XmlEncoder::CDATA_WRAPPING_PATTERN, $cdataWrappingPattern);
     }
+
+    /**
+     * Configures whether to ignore empty attributes.
+     */
+    public function withIgnoreEmptyAttributes(?bool $ignoreEmptyAttributes): static
+    {
+        return $this->with(XmlEncoder::IGNORE_EMPTY_ATTRIBUTES, $ignoreEmptyAttributes);
+    }
 }
diff --git a/src/Symfony/Component/Serializer/Encoder/XmlEncoder.php b/src/Symfony/Component/Serializer/Encoder/XmlEncoder.php
@@ -60,6 +60,7 @@ class XmlEncoder implements EncoderInterface, DecoderInterface, NormalizationAwa
     public const VERSION = 'xml_version';
     public const CDATA_WRAPPING = 'cdata_wrapping';
     public const CDATA_WRAPPING_PATTERN = 'cdata_wrapping_pattern';
+    public const IGNORE_EMPTY_ATTRIBUTES = 'ignore_empty_attributes';
 
     private array $defaultContext = [
         self::AS_COLLECTION => false,
@@ -72,6 +73,7 @@ class XmlEncoder implements EncoderInterface, DecoderInterface, NormalizationAwa
         self::TYPE_CAST_ATTRIBUTES => true,
         self::CDATA_WRAPPING => true,
         self::CDATA_WRAPPING_PATTERN => '/[<>&]/',
+        self::IGNORE_EMPTY_ATTRIBUTES => false,
     ];
 
     public function __construct(array $defaultContext = [])
@@ -355,6 +357,13 @@ private function buildXml(\DOMNode $parentNode, mixed $data, string $format, arr
                     if (\is_bool($data)) {
                         $data = (int) $data;
                     }
+
+                    if ($context[self::IGNORE_EMPTY_ATTRIBUTES] ?? $this->defaultContext[self::IGNORE_EMPTY_ATTRIBUTES]) {
+                        if (null === $data || '' === $data) {
+                            continue;
+                        }
+                    }
+
                     $parentNode->setAttribute($attributeName, $data);
                 } elseif ('#' === $key) {
                     $append = $this->selectNodeType($parentNode, $data, $format, $context);
diff --git a/src/Symfony/Component/Serializer/Tests/Context/Encoder/XmlEncoderContextBuilderTest.php b/src/Symfony/Component/Serializer/Tests/Context/Encoder/XmlEncoderContextBuilderTest.php
@@ -47,6 +47,7 @@ public function testWithers(array $values)
             ->withVersion($values[XmlEncoder::VERSION])
             ->withCdataWrapping($values[XmlEncoder::CDATA_WRAPPING])
             ->withCdataWrappingPattern($values[XmlEncoder::CDATA_WRAPPING_PATTERN])
+            ->withIgnoreEmptyAttributes($values[XmlEncoder::IGNORE_EMPTY_ATTRIBUTES])
             ->toArray();
 
         $this->assertSame($values, $context);
@@ -69,6 +70,7 @@ public static function withersDataProvider(): iterable
             XmlEncoder::VERSION => '1.0',
             XmlEncoder::CDATA_WRAPPING => false,
             XmlEncoder::CDATA_WRAPPING_PATTERN => '/[<>&"\']/',
+            XmlEncoder::IGNORE_EMPTY_ATTRIBUTES => true,
         ]];
 
         yield 'With null values' => [[
@@ -86,6 +88,7 @@ public static function withersDataProvider(): iterable
             XmlEncoder::VERSION => null,
             XmlEncoder::CDATA_WRAPPING => null,
             XmlEncoder::CDATA_WRAPPING_PATTERN => null,
+            XmlEncoder::IGNORE_EMPTY_ATTRIBUTES => null,
         ]];
     }
 }
diff --git a/src/Symfony/Component/Serializer/Tests/Encoder/XmlEncoderTest.php b/src/Symfony/Component/Serializer/Tests/Encoder/XmlEncoderTest.php
@@ -1004,4 +1004,17 @@ private function createXmlWithDateTimeField(): string
 <response><foo dateTime="%s"/></response>
 ', $this->exampleDateTimeString);
     }
+
+    public function testEncodeIgnoringEmptyAttribute()
+    {
+        $expected = <<<'XML'
+<?xml version="1.0"?>
+<response>Test</response>
+
+XML;
+
+        $data = ['#' => 'Test', '@attribute' => '', '@attribute2' => null];
+
+        $this->assertEquals($expected, $this->encoder->encode($data, 'xml', ['ignore_empty_attributes' => true]));
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -160,4 +160,12 @@ public function withCdataWrappingPattern(?string $cdataWrappingPattern): static`
`160`	`160`	`{`
`161`	`161`	`return $this->with(XmlEncoder::CDATA_WRAPPING_PATTERN, $cdataWrappingPattern);`
`162`	`162`	`}`
	`163`	`+`
	`164`	`+ /**`
	`165`	`+ * Configures whether to ignore empty attributes.`
	`166`	`+ */`
	`167`	`+ public function withIgnoreEmptyAttributes(?bool $ignoreEmptyAttributes): static`
	`168`	`+ {`
	`169`	`+ return $this->with(XmlEncoder::IGNORE_EMPTY_ATTRIBUTES, $ignoreEmptyAttributes);`
	`170`	`+ }`
`163`	`171`	`}`