Changeset 717

Timestamp:

06/08/07 20:10:12 (1 year ago)

Author:

schst

Message:

Fixed bug #66: Do not serialize empty attributes, unless specified

Files:

• trunk/src/main/php/net/stubbles/xml/serializer/annotations/stubXMLAttributeAnnotation.php (modified) (3 diffs)
• trunk/src/main/php/net/stubbles/xml/serializer/stubXMLSerializer.php (modified) (2 diffs)
• trunk/src/test/php/net/stubbles/xml/stubXMLSerializerTestCase.php (modified) (2 diffs)

trunk/src/main/php/net/stubbles/xml/serializer/annotations/stubXMLAttributeAnnotation.php

@@ -31 +31 @@
-
-    /**
+     * Whether an empty value should be skipped
+     *
+     * @var boolean
+     */
+    protected $skipEmpty = true;
+
+    /**
-     * Set the attribute name
-     *
@@ -37 +44 @@
-    public function setAttributeName($attributeName) {
-        $this->attributeName = $attributeName;
+    }
+
+    /**
+     * Set the skipEmpty behaviour
+     *
+     * @param boolean $skipEmpty
+     */
+    public function setSkipEmpty($skipEmpty) {
+        $this->skipEmpty = $skipEmpty;
-    }
-
@@ -49 +65 @@
-
-    /**
+     * Check, whether empty values should be skipped
+     *
+     * @return boolean
+     */
+    public function shouldSkipEmpty() {
+        return $this->skipEmpty;
+    }
+
+    /**
-     * Returns the target of the annotation as bitmap.
-     *

trunk/src/main/php/net/stubbles/xml/serializer/stubXMLSerializer.php

@@ -150 +150 @@
-            if ($property->hasAnnotation('XMLAttribute')) {
-                $xmlAttribute = $property->getAnnotation('XMLAttribute');
+                if ((string)$propValue === '' && $xmlAttribute->shouldSkipEmpty()) {
+                    continue;
+                }
-                $xmlWriter->writeAttribute($xmlAttribute->getAttributeName(), (string)$propValue);
-                continue;
@@ -221 +224 @@
-            if ($method->hasAnnotation('XMLAttribute')) {
-                $xmlAttribute = $method->getAnnotation('XMLAttribute');
+                if ((string)$returnValue === '' && $xmlAttribute->shouldSkipEmpty()) {
+                    continue;
+                }
-                $xmlWriter->writeAttribute($xmlAttribute->getAttributeName(), (string)$returnValue);
-                continue;

trunk/src/test/php/net/stubbles/xml/stubXMLSerializerTestCase.php

@@ -161 +161 @@
-     */
-    public $xml2 = '<foo>bar</foo>';
+}
+
+/**
+ * Class to test empty attributes
+ *
+ * @XMLTag(tagName='test')
+ */
+class XMLSerializerAttributeTest {
+
+    /**
+     * Empty property
+     *
+     * @var mixed
+     * @XMLAttribute(attributeName='emptyProp')
+     */
+    public $emptyProp;
+
+    /**
+     * Empty property
+     *
+     * @var mixed
+     * @XMLAttribute(attributeName='emptyProp2', skipEmpty=false)
+     */
+    public $emptyProp2;
+
+    /**
+     * Empty return value
+     *
+     * @return mixed
+     * @XMLAttribute(attributeName='emptyMethod')
+     */
+    public function getEmpty() {
+        return null;
+    }
+
+    /**
+     * Empty return value
+     *
+     * @return mixed
+     * @XMLAttribute(attributeName='emptyMethod2', skipEmpty=false)
+     */
+    public function getEmpty2() {
+        return null;
+    }
-}
-
@@ -342 +386 @@
-
-    /**
+     * Test serializing an object with empty attributes
+     */
+    public function testObjectEmptyAttributes() {
+        $writer = new stubDomXMLStreamWriter();
+        $obj = new XMLSerializerAttributeTest();
+        $this->serializer->serialize($obj, $writer);
+        $this->assertEqual('<?xml version="1.0" encoding="ISO-8859-1"?>' . "\n" . '<test emptyProp2="" emptyMethod2=""/>', $writer->asXML());
+    }
+
+    /**
-     * Test serializing an object with a method matcher
-     */