added support for xml-attributes as discriminators

doc/reference/annotations.rst

@@ -419,6 +419,68 @@ Resulting XML:
         <name><![CDATA[Johannes]]></name>
     </result>
 
+
+@XmlDiscriminator
+~~~~~~~~~~~~~~~~~
+This annotation allows to modify the behaviour of @Discriminator regarding handling of XML.
+
+
+Available Options:
+
++-------------------------------------+--------------------------------------------------+
+| Type                                | Description                                      |
++=====================================+==================================================+
+| attribute                           | use an attribute instead of a child node         |
++-------------------------------------+--------------------------------------------------+
+| cdata                               | render child node content with or without cdata  |
++-------------------------------------+--------------------------------------------------+
+
+Example for "attribute":
+.. code-block :: php
+
+    <?php
+
+    use JMS\Serializer\Annotation\Discriminator;
+    use JMS\Serializer\Annotation\XmlDiscriminator;
+
+    /**
+     * @Discriminator(field = "type", map = {"car": "Car", "moped": "Moped"}, groups={"foo", "bar"})
+     * @XmlDiscriminator(attribute=true)
+     */
+    abstract class Vehicle { }
+    class Car extends Vehicle { }
+
+Resulting XML:
+
+.. code-block :: xml
+
+    <vehicle type="car" />
+
+
+Example for "cdata":
+
+.. code-block :: php
+    <?php
+
+    use JMS\Serializer\Annotation\Discriminator;
+    use JMS\Serializer\Annotation\XmlDiscriminator;
+
+
+
+    /**
+     * @Discriminator(field = "type", map = {"car": "Car", "moped": "Moped"}, groups={"foo", "bar"})
+     * @XmlDiscriminator(attribute=true)
+     */
+    abstract class Vehicle { }
+    class Car extends Vehicle { }
+
+Resulting XML:
+
+.. code-block :: xml
+
+    <vehicle><type>car</type></vehicle>
+
+
 @XmlValue
 ~~~~~~~~~
 This allows you to mark properties which should be set as the value of the

doc/reference/xml_reference.rst

@@ -9,6 +9,7 @@ XML Reference
             accessor-order="custom" custom-accessor-order="propertyName1,propertyName2,...,propertyNameN"
             access-type="public_method" discriminator-field-name="type"  read-only="false">
             <xml-namespace prefix="atom" uri="http://www.w3.org/2005/Atom"/>
+            <xml-discriminator attribute="true" cdata="false"/>
             <discriminator-class value="some-value">ClassName</discriminator-class>
             <discriminator-groups>
                 <group>foo</group>

doc/reference/yml_reference.rst

@@ -7,6 +7,9 @@ YAML Reference
         exclusion_policy: ALL
         xml_root_name: foobar
         xml_root_namespace: http://your.default.namespace
+        xml_discriminator:
+            attribute: true
+            cdata: false
         exclude: true
         read_only: false
         access_type: public_method # defaults to property

src/JMS/Serializer/Annotation/XmlDiscriminator.php

@@ -0,0 +1,37 @@
+<?php
+
+/*
+ * Copyright 2016 Björn Bösel <[email protected]>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+namespace JMS\Serializer\Annotation;
+
+
+/**
+ * @Annotation
+ * @Target("CLASS")
+ */
+class XmlDiscriminator
+{
+    /**
+     * @var boolean
+     */
+    public $attribute = false;
+
+    /**
+     * @var boolean
+     */
+    public $cdata = true;
+}

src/JMS/Serializer/GraphNavigator.php

@@ -261,6 +261,11 @@ private function resolveMetadata($data, ClassMetadata $metadata)
                 $typeValue = (string) $data->{$metadata->discriminatorFieldName};
                 break;
 
+            // Check XML attribute for discriminatorFieldName
+            case is_object($data) && $metadata->xmlDiscriminatorAttribute && isset($data[$metadata->discriminatorFieldName]):
+                $typeValue = (string) $data[$metadata->discriminatorFieldName];
+                break;
+
             default:
                 throw new \LogicException(sprintf(
                     'The discriminator field name "%s" for base-class "%s" was not found in input data.',

src/JMS/Serializer/Metadata/ClassMetadata.php

@@ -58,6 +58,9 @@ class ClassMetadata extends MergeableClassMetadata
     public $discriminatorMap = array();
     public $discriminatorGroups = array();
 
+    public $xmlDiscriminatorAttribute = false;
+    public $xmlDiscriminatorCData = true;
+
     public function setDiscriminator($fieldName, array $map, array $groups = array())
     {
         if (empty($fieldName)) {
@@ -203,6 +206,7 @@ public function merge(MergeableInterface $object)
                 $this->discriminatorGroups
             );
             $discriminatorProperty->serializedName = $this->discriminatorFieldName;
+            $discriminatorProperty->xmlAttribute = $this->xmlDiscriminatorAttribute;
             $this->propertyMetadata[$this->discriminatorFieldName] = $discriminatorProperty;
         }
 
@@ -249,6 +253,8 @@ public function serialize()
             $this->discriminatorGroups,
             parent::serialize(),
             'discriminatorGroups' => $this->discriminatorGroups,
+            'xmlDiscriminatorAttribute' => $this->xmlDiscriminatorAttribute,
+            'xmlDiscriminatorCData' => $this->xmlDiscriminatorCData,
         ));
     }
 
@@ -279,6 +285,14 @@ public function unserialize($str)
             $this->discriminatorGroups = $deserializedData['discriminatorGroups'];
         }
 
+        if (isset($deserializedData['xmlDiscriminatorAttribute'])) {
+            $this->xmlDiscriminatorAttribute = $deserializedData['xmlDiscriminatorAttribute'];
+        }
+
+        if (isset($deserializedData['xmlDiscriminatorCData'])) {
+            $this->xmlDiscriminatorCData = $deserializedData['xmlDiscriminatorCData'];
+        }
+
         parent::unserialize($parentStr);
     }
 

src/JMS/Serializer/Metadata/Driver/AnnotationDriver.php

@@ -19,6 +19,7 @@
 namespace JMS\Serializer\Metadata\Driver;
 
 use JMS\Serializer\Annotation\Discriminator;
+use JMS\Serializer\Annotation\XmlDiscriminator;
 use JMS\Serializer\GraphNavigator;
 use JMS\Serializer\Annotation\HandlerCallback;
 use JMS\Serializer\Annotation\AccessorOrder;
@@ -99,6 +100,9 @@ public function loadMetadataForClass(\ReflectionClass $class)
                 } else {
                     $classMetadata->setDiscriminator($annot->field, $annot->map, $annot->groups);
                 }
+            } elseif ($annot instanceof XmlDiscriminator) {
+                $classMetadata->xmlDiscriminatorAttribute = $annot->attribute;
+                $classMetadata->xmlDiscriminatorCData = $annot->cdata;
             }
         }
 

src/JMS/Serializer/Metadata/Driver/XmlDriver.php

@@ -104,6 +104,15 @@ protected function loadMetadataFromFile(\ReflectionClass $class, $path)
             $metadata->registerNamespace((string) $xmlNamespace->attributes()->uri, $prefix);
         }
 
+        foreach ($elem->xpath('./xml-discriminator') as $xmlDiscriminator) {
+            if (isset($xmlDiscriminator->attributes()->attribute)) {
+                $metadata->xmlDiscriminatorAttribute = (string) $xmlDiscriminator->attributes()->attribute === 'true';
+            }
+            if (isset($xmlDiscriminator->attributes()->cdata)) {
+                $metadata->xmlDiscriminatorCData = (string) $xmlDiscriminator->attributes()->cdata === 'true';
+            }
+        }
+
         foreach ($elem->xpath('./virtual-property') as $method) {
             if ( ! isset($method->attributes()->method)) {
                 throw new RuntimeException('The method attribute must be set for all virtual-property elements.');

src/JMS/Serializer/Metadata/Driver/YamlDriver.php

@@ -257,6 +257,15 @@ private function addClassProperties(ClassMetadata $metadata, array $config)
             $metadata->xmlRootNamespace = (string) $config['xml_root_namespace'];
         }
 
+        if (isset($config['xml_discriminator'])) {
+            if (isset($config['xml_discriminator']['attribute'])) {
+                $metadata->xmlDiscriminatorAttribute = $config['xml_discriminator']['attribute'];
+            }
+            if (isset($config['xml_discriminator']['cdata'])) {
+                $metadata->xmlDiscriminatorCData = $config['xml_discriminator']['cdata'];
+            }
+        }
+
         if (array_key_exists('xml_namespaces', $config)) {
 
             foreach ($config['xml_namespaces'] as $prefix => $uri) {

tests/JMS/Serializer/Tests/Fixtures/Discriminator/ObjectWithXmlAttributeDiscriminatorChild.php

@@ -0,0 +1,23 @@
+<?php
+
+/*
+ * Copyright 2016 Björn Bösel <[email protected]>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+namespace JMS\Serializer\Tests\Fixtures\Discriminator;
+
+class ObjectWithXmlAttributeDiscriminatorChild extends ObjectWithXmlAttributeDiscriminatorParent
+{
+}

tests/JMS/Serializer/Tests/Fixtures/Discriminator/ObjectWithXmlAttributeDiscriminatorParent.php

@@ -0,0 +1,32 @@
+<?php
+
+/*
+ * Copyright 2016 Björn Bösel <[email protected]>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+namespace JMS\Serializer\Tests\Fixtures\Discriminator;
+
+use JMS\Serializer\Annotation as Serializer;
+
+/**
+ * @Serializer\Discriminator(field = "type", map = {
+ *    "child": "JMS\Serializer\Tests\Fixtures\Discriminator\ObjectWithXmlAttributeDiscriminatorChild"
+ * })
+ * @Serializer\XmlDiscriminator(attribute=true, cdata=false)
+ */
+class ObjectWithXmlAttributeDiscriminatorParent
+{
+
+}

tests/JMS/Serializer/Tests/Metadata/Driver/BaseDriverTest.php

@@ -22,6 +22,8 @@
 use JMS\Serializer\Metadata\ClassMetadata;
 use JMS\Serializer\Metadata\PropertyMetadata;
 use JMS\Serializer\Metadata\VirtualPropertyMetadata;
+use JMS\Serializer\Tests\Fixtures\Discriminator\ObjectWithXmlAttributeDiscriminatorChild;
+use JMS\Serializer\Tests\Fixtures\Discriminator\ObjectWithXmlAttributeDiscriminatorParent;
 use Metadata\Driver\DriverInterface;
 
 abstract class BaseDriverTest extends \PHPUnit_Framework_TestCase
@@ -171,6 +173,24 @@ public function testLoadDiscriminator()
         );
     }
 
+    public function testLoadXmlDiscriminator()
+    {
+        /** @var $m ClassMetadata */
+        $m = $this->getDriver()->loadMetadataForClass(new \ReflectionClass(ObjectWithXmlAttributeDiscriminatorParent::class));
+
+        $this->assertNotNull($m);
+        $this->assertEquals('type', $m->discriminatorFieldName);
+        $this->assertEquals($m->name, $m->discriminatorBaseClass);
+        $this->assertEquals(
+            array(
+                'child' => ObjectWithXmlAttributeDiscriminatorChild::class,
+            ),
+            $m->discriminatorMap
+        );
+        $this->assertTrue($m->xmlDiscriminatorAttribute);
+        $this->assertFalse($m->xmlDiscriminatorCData);
+    }
+
     public function testLoadDiscriminatorWithGroup()
     {
         /** @var $m ClassMetadata */

tests/JMS/Serializer/Tests/Metadata/Driver/php/Discriminator.ObjectWithXmlAttributeDiscriminatorParent.php

@@ -0,0 +1,12 @@
+<?php
+
+use JMS\Serializer\Metadata\ClassMetadata;
+use JMS\Serializer\Metadata\PropertyMetadata;
+
+$metadata = new ClassMetadata('JMS\Serializer\Tests\Fixtures\Discriminator\ObjectWithXmlAttributeDiscriminatorParent');
+$metadata->setDiscriminator('type', array(
+    'child' => 'JMS\Serializer\Tests\Fixtures\Discriminator\ObjectWithXmlAttributeDiscriminatorChild'
+));
+$metadata->xmlDiscriminatorAttribute = true;
+$metadata->xmlDiscriminatorCData = false;
+return $metadata;

tests/JMS/Serializer/Tests/Metadata/Driver/xml/Discriminator.ObjectWithXmlAttributeDiscriminatorParent.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<serializer>
+    <class name="JMS\Serializer\Tests\Fixtures\Discriminator\ObjectWithXmlAttributeDiscriminatorParent"
+           discriminator-field-name="type"
+           xml-discriminator-attribute="true"
+    >
+        <discriminator-class value="child">JMS\Serializer\Tests\Fixtures\Discriminator\ObjectWithXmlAttributeDiscriminatorChild</discriminator-class>
+        <xml-discriminator attribute="true" cdata="false" />
+    </class>
+</serializer>

tests/JMS/Serializer/Tests/Metadata/Driver/yml/Discriminator.ObjectWithXmlAttributeDiscriminatorParent.yml

@@ -0,0 +1,8 @@
+JMS\Serializer\Tests\Fixtures\Discriminator\ObjectWithXmlAttributeDiscriminatorParent:
+    discriminator:
+        field_name: type
+        map:
+            child: JMS\Serializer\Tests\Fixtures\Discriminator\ObjectWithXmlAttributeDiscriminatorChild
+    xml_discriminator:
+        attribute: true
+        cdata: false

tests/JMS/Serializer/Tests/Serializer/XmlSerializationTest.php

@@ -25,6 +25,7 @@
 use JMS\Serializer\Naming\SerializedNameAnnotationStrategy;
 use JMS\Serializer\SerializationContext;
 use JMS\Serializer\Serializer;
+use JMS\Serializer\Tests\Fixtures\Discriminator\ObjectWithXmlAttributeDiscriminatorParent;
 use JMS\Serializer\Tests\Fixtures\InvalidUsageOfXmlValue;
 use JMS\Serializer\Exception\InvalidArgumentException;
 use JMS\Serializer\Tests\Fixtures\PersonCollection;
@@ -40,6 +41,7 @@
 use JMS\Serializer\Tests\Fixtures\ObjectWithNamespacesAndList;
 use JMS\Serializer\XmlSerializationVisitor;
 use PhpCollection\Map;
+use JMS\Serializer\Tests\Fixtures\Discriminator\ObjectWithXmlAttributeDiscriminatorChild;
 
 class XmlSerializationTest extends BaseSerializationTest
 {
@@ -361,6 +363,20 @@ public function testWithoutFormatedOutputByXmlSerializationVisitor()
         $this->assertXmlStringEqualsXmlString($this->getContent('simple_class_object_minified'), $stringXml);
     }
 
+    public function testDiscriminatorAsXmlAttribute()
+    {
+        $xml = simplexml_load_string($this->serialize(new ObjectWithXmlAttributeDiscriminatorChild()));
+        $this->assertEquals('type="child"', trim($xml->xpath('//result/@type')[0]->saveXML()));
+
+        $this->assertInstanceOf(
+            ObjectWithXmlAttributeDiscriminatorChild::class,
+            $this->deserialize(
+                $xml->asXML(),
+                ObjectWithXmlAttributeDiscriminatorParent::class
+            )
+        );
+    }
+
     private function xpathFirstToString(\SimpleXMLElement $xml, $xpath)
     {
         $nodes = $xml->xpath($xpath);