Introduce a way to encode+decode CDATA

php-soap · Jun 6, 2024 · d0ac7fd · d0ac7fd
1 parent 5a86b18
commit d0ac7fd
Show file tree

Hide file tree

Showing 6 changed files with 129 additions and 7 deletions.
diff --git a/src/Encoder/ElementEncoder.php b/src/Encoder/ElementEncoder.php
@@ -28,15 +28,14 @@ public function __construct(
     public function iso(Context $context): Iso
     {
         $typeEncoder = $this->typeEncoder;
-        $typeIso = $typeEncoder->iso($context);
 
         return new Iso(
             /**
              * @psalm-param mixed $raw
              */
             static fn (mixed $raw): string => (new XsdTypeXmlElementWriter())(
                 $context,
-                (new ElementValueBuilder($context, $typeIso, $raw))
+                (new ElementValueBuilder($context, $typeEncoder, $raw))
             ),
             /**
              * @psalm-param non-empty-string $xml

diff --git a/src/Encoder/Feature/CData.php b/src/Encoder/Feature/CData.php
@@ -0,0 +1,8 @@
+<?php
+declare(strict_types=1);
+
+namespace Soap\Encoding\Encoder\Feature;
+
+interface CData
+{
+}
diff --git a/src/Encoder/SimpleType/CDataTypeEncoder.php b/src/Encoder/SimpleType/CDataTypeEncoder.php
@@ -0,0 +1,28 @@
+<?php
+declare(strict_types=1);
+
+namespace Soap\Encoding\Encoder\SimpleType;
+
+use Soap\Encoding\Encoder\Context;
+use Soap\Encoding\Encoder\Feature;
+use Soap\Encoding\Encoder\XmlEncoder;
+use VeeWee\Reflecta\Iso\Iso;
+
+/**
+ * This encoder works exactly the same as the string encoder.
+ * However, it implements the CData feature.
+ * When writing the data to the XML element, it will be wrapped in a CDATA section.
+ *
+ * @psalm-suppress UnusedClass
+ * @implements XmlEncoder<string, string>
+ */
+final class CDataTypeEncoder implements Feature\CData, XmlEncoder
+{
+    /**
+     * @return Iso<string, string>
+     */
+    public function iso(Context $context): Iso
+    {
+        return (new StringTypeEncoder())->iso($context);
+    }
+}
diff --git a/src/Xml/Writer/ElementValueBuilder.php b/src/Xml/Writer/ElementValueBuilder.php
@@ -5,22 +5,24 @@
 
 use Generator;
 use Soap\Encoding\Encoder\Context;
+use Soap\Encoding\Encoder\Feature\CData;
+use Soap\Encoding\Encoder\XmlEncoder;
 use Soap\Encoding\TypeInference\XsiTypeDetector;
 use Soap\WsdlReader\Model\Definitions\BindingUse;
-use VeeWee\Reflecta\Iso\Iso;
 use XMLWriter;
+use function VeeWee\Xml\Writer\Builder\cdata;
 use function VeeWee\Xml\Writer\Builder\children;
 use function VeeWee\Xml\Writer\Builder\value;
 
 final class ElementValueBuilder
 {
     /**
-     * @param Iso<mixed, string> $iso
+     * @param XmlEncoder<mixed, string> $encoder
      * @psalm-param mixed $value
      */
     public function __construct(
         private readonly Context $context,
-        private readonly Iso $iso,
+        private readonly XmlEncoder $encoder,
         private readonly mixed $value
     ) {
     }
@@ -32,7 +34,7 @@ public function __invoke(XMLWriter $writer): Generator
     {
         yield from children([
             $this->buildXsiType(...),
-            value($this->iso->to($this->value))
+            $this->buildValue(...),
         ])($writer);
     }
 
@@ -51,4 +53,19 @@ private function buildXsiType(XMLWriter $writer): Generator
             includeXsiTargetNamespace:  !$this->context->type->getMeta()->isQualified()->unwrapOr(false)
         ))($writer);
     }
+
+    /**
+     * @return Generator<bool>
+     */
+    private function buildValue(XMLWriter $writer): Generator
+    {
+        $encoded = $this->encoder->iso($this->context)->to($this->value);
+
+        $builder = match (true) {
+            $this->encoder instanceof CData => cdata(value($encoded)),
+            default => value($encoded)
+        };
+
+        yield from $builder($writer);
+    }
 }
diff --git a/tests/Unit/Encoder/SimpleType/CDataTypeEncoderTest.php b/tests/Unit/Encoder/SimpleType/CDataTypeEncoderTest.php
@@ -0,0 +1,51 @@
+<?php
+declare(strict_types=1);
+
+namespace Soap\Encoding\Test\Unit\Encoder\SimpleType;
+
+use PHPUnit\Framework\Attributes\CoversClass;
+use Soap\Encoding\Encoder\ElementEncoder;
+use Soap\Encoding\Encoder\SimpleType\CDataTypeEncoder;
+use Soap\Encoding\Test\Unit\Encoder\AbstractEncoderTests;
+use Soap\Engine\Metadata\Model\XsdType;
+
+#[CoversClass(CDataTypeEncoder::class)]
+final class CDataTypeEncoderTest extends AbstractEncoderTests
+{
+    public static function provideIsomorphicCases(): iterable
+    {
+        $baseConfig = [
+            'encoder' => $encoder = new CDataTypeEncoder(),
+            'context' => $context = self::createContext(
+                XsdType::guess('string')
+                    ->withXmlTargetNodeName('root')
+            ),
+        ];
+
+        yield 'simple' => [
+            ...$baseConfig,
+            'xml' => 'hello',
+            'data' => 'hello',
+        ];
+        yield 'special-chars' => [
+            ...$baseConfig,
+            'xml' => 'hëllo\'"<>',
+            'data' => 'hëllo\'"<>',
+        ];
+
+        $elementEncoder = new ElementEncoder($encoder);
+        yield 'element-wrapped' => [
+            ...$baseConfig,
+            'encoder' => $elementEncoder,
+            'xml' => '<root><![CDATA[hello]]></root>',
+            'data' => 'hello',
+
+        ];
+        yield 'element-wrapped-special-chars' => [
+            ...$baseConfig,
+            'encoder' => $elementEncoder,
+            'xml' => '<root><![CDATA[hëllo\'"<>]]></root>',
+            'data' => 'hëllo\'"<>',
+        ];
+    }
+}
diff --git a/tests/Unit/Encoder/SimpleType/StringTypeEncoderTest.php b/tests/Unit/Encoder/SimpleType/StringTypeEncoderTest.php
@@ -4,6 +4,7 @@
 namespace Soap\Encoding\Test\Unit\Encoder\SimpleType;
 
 use PHPUnit\Framework\Attributes\CoversClass;
+use Soap\Encoding\Encoder\ElementEncoder;
 use Soap\Encoding\Encoder\SimpleType\StringTypeEncoder;
 use Soap\Encoding\Test\Unit\Encoder\AbstractEncoderTests;
 use Soap\Engine\Metadata\Model\XsdType;
@@ -15,7 +16,10 @@ public static function provideIsomorphicCases(): iterable
     {
         $baseConfig = [
             'encoder' => $encoder = new StringTypeEncoder(),
-            'context' => $context = self::createContext(XsdType::guess('string')),
+            'context' => $context = self::createContext(
+                XsdType::guess('string')
+                    ->withXmlTargetNodeName('root')
+            ),
         ];
 
         yield 'simple' => [
@@ -28,5 +32,20 @@ public static function provideIsomorphicCases(): iterable
             'xml' => 'hëllo\'"<>',
             'data' => 'hëllo\'"<>',
         ];
+
+        $elementEncoder = new ElementEncoder($encoder);
+        yield 'element-wrapped' => [
+            ...$baseConfig,
+            'encoder' => $elementEncoder,
+            'xml' => '<root>hello</root>',
+            'data' => 'hello',
+
+        ];
+        yield 'element-wrapped-special-chars' => [
+            ...$baseConfig,
+            'encoder' => $elementEncoder,
+            'xml' => '<root>hëllo\'&quot;&lt;&gt;</root>',
+            'data' => 'hëllo\'"<>',
+        ];
     }
 }