added popo serializer/deserializer and Service shorthand

CHANGELOG.md

@@ -4,6 +4,8 @@ ChangeLog
 1.3.0 (????-??-??)
 ------------------
 
+* The `Service` class adds a new `mapValueObject` method which provides basic
+  capabilities to map between ValueObjects and XML.
 * #61: You can now specify serializers for specific classes, allowing you
   separate the object you want to serialize from the serializer. This uses the
   `$classMap` property which is defined on both the `Service` and `Writer`.

composer.json

@@ -28,7 +28,10 @@
         "psr-4" : {
             "Sabre\\Xml\\" : "lib/"
         },
-        "files": ["lib/deserializers.php"]
+        "files": [
+            "lib/deserializers.php",
+            "lib/serializers.php"
+        ]
     },
     "bin" : [
     ],

lib/Service.php

@@ -189,6 +189,30 @@ function write($rootElementName, $value, $contextUri = null) {
 
     }
 
+    /**
+     * Maps the given value-object to the given rootElementName within the given namespace.
+     *
+     * The $rootElement must be specified in clark notation.
+     *
+     * The $className refernces a regular php class which must provide a __construct() without arguments.
+     * This methods creates instances of this class which later on picks up all xml child elements as public properties.
+     *
+     * @param string $rootElementName
+     * @param object $className
+     * @param string $namespace
+     */
+    function mapValueObject($rootElementName, $className, $namespace) {
+        if (!class_exists($className)) {
+            throw new \InvalidArgumentException('class "' . $className . '" does not exist');
+        }
+
+        $this->elementMap['{' . $namespace . '}' . $rootElementName] = function(Reader $reader) use ($className, $namespace) {
+            return \Sabre\Xml\Deserializer\valueObject($reader, new $className(), $namespace);
+        };
+        $this->classMap[$className] = function(Writer $writer, $valueObject) use ($namespace) {
+            return \Sabre\Xml\Serializer\valueObject($writer, $valueObject, $namespace);
+        };
+    }
 
     /**
      * Parses a clark-notation string, and returns the namespace and element
@@ -212,6 +236,4 @@ static function parseClarkNotation($str) {
         ];
 
     }
-
-
 }

lib/deserializers.php

@@ -161,3 +161,31 @@ function elementList(Reader $reader, $namespace = null) {
     return $values;
 
 }
+
+/**
+ * @param Reader $reader
+ * @param object $valueObject
+ * @param string $namespace
+ * @return null|$valueObject
+ */
+function valueObject(Reader $reader, $valueObject, $namespace) {
+    if ($reader->isEmptyElement) {
+        $reader->next();
+        return null;
+    }
+
+    $reader->read();
+    do {
+
+        if ($reader->nodeType === Reader::ELEMENT && $reader->namespaceURI == $namespace) {
+
+            $valueObject->{$reader->localName} = $reader->parseCurrentElement()['value'];
+        } else {
+            $reader->read();
+        }
+    } while ($reader->nodeType !== Reader::END_ELEMENT);
+
+    $reader->read();
+
+    return $valueObject;
+}

lib/serializers.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace Sabre\Xml\Serializer;
+
+use Sabre\Xml\Writer;
+
+/**
+ * This file provides a number of 'serializer' helper functions.
+ * These can be used to easily specify custom serializers for specific
+ * PHP objects/values.
+ */
+
+/**
+ * @param Writer $writer
+ * @param object $valueObject
+ * @param string $namespace
+ */
+function valueObject(Writer $writer, $valueObject, $namespace) {
+    foreach (get_object_vars($valueObject) as $key => $val) {
+        $writer->writeElement('{' . $namespace . '}' . $key, $val);
+    }
+}

tests/Sabre/Xml/ServiceTest.php

@@ -198,6 +198,43 @@ function testWrite() {
 
     }
 
+    function testMapValueObject() {
+
+        $input = <<<XML
+<?xml version="1.0"?>
+<order xmlns="http://sabredav.org/ns">
+ <id>1234</id>
+ <amount>99.99</amount>
+ <description>black friday deal</description>
+ <status>
+  <id>5</id>
+  <label>processed</label>
+ </status>
+</order>
+
+XML;
+
+        $ns = 'http://sabredav.org/ns';
+        $orderService = new \Sabre\Xml\Service();
+        $orderService->mapValueObject('order', 'Sabre\Xml\Order', $ns);
+        $orderService->mapValueObject('status', 'Sabre\Xml\OrderStatus', $ns);
+        $orderService->namespaceMap[$ns] = null;
+
+        $order = $orderService->parse($input);
+        $expected = new Order();
+        $expected->id = 1234;
+        $expected->amount = 99.99;
+        $expected->description = 'black friday deal';
+        $expected->status = new OrderStatus();
+        $expected->status->id = 5;
+        $expected->status->label = 'processed';
+
+        $this->assertEquals($expected, $order);
+
+        $writtenXml = $orderService->write('{http://sabredav.org/ns}order', $order);
+        $this->assertEquals($input, $writtenXml);
+    }
+
     function testParseClarkNotation() {
 
         $this->assertEquals([
@@ -217,3 +254,23 @@ function testParseClarkNotationFail() {
     }
 
 }
+
+/**
+ * asset for testMapValueObject()
+ * @internal
+ */
+class Order {
+    public $id;
+    public $amount;
+    public $description;
+    public $status;
+}
+
+/**
+ * asset for testMapValueObject()
+ * @internal
+ */
+class OrderStatus {
+    public $id;
+    public $label;
+}