Changeset 1389

Timestamp:

02/29/08 15:57:54 (3 months ago)

Author:

mikey

Message:

implemented enhancement #128: improved performance of XMLSerializer
Serializing a list of instances of the same object is much faster now.

Files:

• trunk/src/main/php/net/stubbles/xml/serializer/annotations/stubXMLMatcherAnnotation.php (modified) (2 diffs)
• trunk/src/main/php/net/stubbles/xml/serializer/annotations/stubXMLMethodsAnnotation.php (modified) (1 diff)
• trunk/src/main/php/net/stubbles/xml/serializer/annotations/stubXMLPropertiesAnnotation.php (modified) (1 diff)
• trunk/src/main/php/net/stubbles/xml/serializer/matcher/stubXMLSerializerMethodPropertyMatcher.php (modified) (2 diffs)
• trunk/src/main/php/net/stubbles/xml/serializer/stubXMLSerializer.php (modified) (10 diffs)
• trunk/src/main/php/net/stubbles/xml/serializer/stubXMLSerializerObjectData.php (added)
• trunk/src/test/php/net/stubbles/xml/serializer/annotations/stubXMLMatcherAnnotationTestCase.php (modified) (6 diffs)
• trunk/src/test/php/net/stubbles/xml/serializer/stubXMLSerializerTestCase.php (modified) (15 diffs)

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

@@ -48 +48 @@
-     *
-     * @param   stubReflectionProperty  $property
-     * @param   mixed                   $propertyValue
-     * @return  string|false
-     * @throws  stubXMLException
-     */
-, $propertyValue
+
-    {
-        $matches = array();
@@ -75 +74 @@
-     *
-     * @param   stubReflectionMethod  $method
-     * @param   mixed                 $returnValue
-     * @return  string|bool
-     * @throws  stubXMLException
-     */
-, $returnValue
+
-    {
-        $matches = array();

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

@@ -24 +24 @@
-     *
-     * @param   stubReflectionMethod  $method
-     * @param   mixed                 $returnValue
-     * @return  string|false
-     */
-, $returnValue
+
-}
-?>

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

@@ -24 +24 @@
-     *
-     * @param   stubReflectionProperty  $property
-     * @param   mixed                   $propertyValue
-     * @return  string|false
-     */
-, $propertyValue
+
-}
-?>

trunk/src/main/php/net/stubbles/xml/serializer/matcher/stubXMLSerializerMethodPropertyMatcher.php

@@ -26 +26 @@
-    public function matchesMethod(ReflectionMethod $method)
-    {
-
+ || $method->isStatic() === true
-            return false;
-        }
@@ -64 +64 @@
-    public function matchesProperty(ReflectionProperty $property)
-    {
-
+
+
+
+
+
-    }
-

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

@@ -4 +4 @@
- *
- * @author      Stephan Schmidt <schst@stubbles.net>
+ * @author      Frank Kleine <mikey@stubbles.net>
- * @package     stubbles
- * @subpackage  xml_serializer
- */
-
-
-
-
-
-
-
-
-
-
+
+
-);
-/**
@@ -35 +28 @@
-    const OPT_STRATEGY     = 'strategy';
-    /**
-     * Option to define the strategy
-     */
-    const OPT_STATIC       = 'static';
-    /**
-     * Do not export any properties or methods
-     */
@@ -60 +49 @@
-     */
-    private $defaultOpts = array(self::OPT_ROOT_TAG => null,
-
-
+
-                           );
-    /**
@@ -69 +57 @@
-     */
-    private $opts;
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
-     * @param  array                $opts       Options to influence the serializing
-     */
-
+array 
-    {
-        // set the currently used options
@@ -99 +73 @@
-
-    /**
-S
-
-The 
-The 
-The 
+s
+
+
+
+
-     */
-    protected function serializeDispatcher($data, stubXMLStreamWriter $xmlWriter, $tagName = null)
@@ -109 +83 @@
-        switch (gettype($data)) {
-            case 'NULL':
-$tagName === null
+null === $tagName
-                    $tagName = 'null';
-                }
@@ -120 +94 @@
-            
-            case 'boolean':
-$tagName === null
+null === $tagName
-                    $tagName = 'boolean';
-                }
@@ -132 +106 @@
-            case 'integer':
-            case 'double':
-$tagName === null
+null === $tagName
-                    $tagName = gettype($data);
-                }
@@ -150 +124 @@
-            
-            default:
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
-     */
-    protected function serializeObject($object, stubXMLStreamWriter $xmlWriter, $tagName)
-    {
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-        if (null === $tagName) {
-            if ($clazz->hasAnnotation('XMLTag') === true) {
-                $tagName = $clazz->getAnnotation('XMLTag')->getTagName();
-            } else {
-                $tagName = get_class($object);
-            }
-        }
-
-        $xmlWriter->writeStartElement($tagName);
-        if ($clazz->hasAnnotation('XMLStrategy')) {
-            $strategy = $clazz->getAnnotation('XMLStrategy')->getValue();
-        } else {
-            $strategy = $this->opts[self::OPT_STRATEGY];
-        }
-
-        // export props
-        $properties = $clazz->getPropertiesByMatcher($this->methodAndPropertyMatcher);
-        $matcher    = null;
-        // get the property-matcher
-        if ($clazz->hasAnnotation('XMLProperties')) {
-            $matcher = $clazz->getAnnotation('XMLProperties');
-        }
-
-        foreach ($properties as $property) {
-            $propValue = $property->getValue($object);
-            if ($this->writeAnnotatedElement($property, $xmlWriter, $propValue) === true) {
-                continue;
-            }
-            
-            if ($property->hasAnnotation('XMLTag') === true) {
-                $xmlTag      = $property->getAnnotation('XMLTag');
-                $tagName     = $xmlTag->getTagName();
-                $elementName = $xmlTag->getElementTagName();
-            } else {
-                if (null !== $matcher) {
-                    $tagName = $matcher->getTagnameForProperty($property, $propValue);
-                    if (false === $tagName) {
-                        continue;
-                    }
-                } else {
-                    if (($strategy & self::STRATEGY_PROPS) === 0) {
-                        continue;
-                    }
-                    
-                    if ($this->opts[self::OPT_STATIC] === false && $property->isStatic() === true) {
-                        continue;
-                    }
-                    
-                    $tagName = $property->getName();
-                }
-                $elementName = null;
-            }
-            
-            if (is_array($propValue) === true) {
-                $this->serializeArray($propValue, $xmlWriter, $tagName, $elementName);
-            } else {
-                $this->serializeDispatcher($propValue, $xmlWriter, $tagName);
-            }
-        }
-
-        // export methods
-        $methods = $clazz->getMethodsByMatcher($this->methodAndPropertyMatcher);
-        $matcher = null;
-        // get the method-matcher
-        if ($clazz->hasAnnotation('XMLMethods')) {
-            $matcher = $clazz->getAnnotation('XMLMethods');
-        }
-        
-        foreach ($methods as $method) {
-            $returnValue = $method->invoke($object);
-            if ($this->writeAnnotatedElement($method, $xmlWriter, $returnValue) === true) {
-                continue;
-            }
-            
-            if ($method->hasAnnotation('XMLTag') === true) {
-                $xmlTag      = $method->getAnnotation('XMLTag');
-                $tagName     = $xmlTag->getTagName();
-                $elementName = $xmlTag->getElementTagName();
-            } else {
-                if (null !== $matcher) {
-                    $tagName = $matcher->getTagnameForMethod($method, $returnValue);
-                    if (false === $tagName) {
-                        continue;
-                    }
-                } else {
-                    if (($strategy & self::STRATEGY_METHODS) === 0) {
-                        continue;
-                    }
-                    
-                    if ($this->opts[self::OPT_STATIC] === false && $method->isStatic() === true) {
-                        continue;
-                    }
-
-                    $tagName = $method->getName();
-                }
-                
-                $elementName = null;
-            }
-
-            if (is_array($returnValue) === true) {
-                $this->serializeArray($returnValue, $xmlWriter, $tagName, $elementName);
-            } else {
-                $this->serializeDispatcher($returnValue, $xmlWriter, $tagName);
-            }
-        }
-        
-        $xmlWriter->writeEndElement();
-    }
-
-    /**
-     * serializes annotated element
-     *
-     * Returns true if element was serialized, else false.
-     *
-     * @param   stubAnnotatable      $annotatable  the annotatable element to serialize
-     * @param   stubXMLStreamWriter  $xmlWriter    the xml writer to use
-     * @param   mixed                $value        the value to serialize
-     * @return  bool
-     */
-    protected function writeAnnotatedElement(stubAnnotatable $annotatable, stubXMLStreamWriter $xmlWriter, $value)
-    {
-        if ($annotatable->hasAnnotation('XMLAttribute') === true) {
-            $xmlAttribute = $annotatable->getAnnotation('XMLAttribute');
-            if ('' === (string) $value && $xmlAttribute->shouldSkipEmpty() === true) {
-                return true;
-            }
-            
-            $xmlWriter->writeAttribute($xmlAttribute->getAttributeName(), (string) $value);
-            return true;
-        } elseif ($annotatable->hasAnnotation('XMLFragment') === true) {
-            $tagName = $annotatable->getAnnotation('XMLFragment')->getTagName();
-            if (null != $tagName) {
-                $xmlWriter->writeStartElement($tagName);
-                $xmlWriter->writeXmlFragment($value);
-                $xmlWriter->writeEndElement();
-            } else {
-                $xmlWriter->writeXmlFragment($value);
-            }
-            
-            return true;
-        }
-        
-        return false;
-    }
-
-    /**
-     * Serialize an array
-     *
-     * @param  array                $array
-     * @param  stubXMLStreamWriter  $xmlWriter
-     * @param  string               $tagName     The 'root' name for the array
-     * @param  string               $defaultTag  The default tag for indexed arrays
-     */
-    protected function serializeArray($array, stubXMLStreamWriter $xmlWriter, $tagName, $defaultTag = null)
-    {
-        if ($tagName === null) {
-            $tagName = 'array';
-        }
-        
-$tagName !== fals
+false !== $tagNam
-            $xmlWriter->writeStartElement($tagName);
-        }
-        
-        foreach ($array as $key => $value) {
-
+ === true
-                if (null === $defaultTag) {
-                    $this->serializeDispatcher($value, $xmlWriter);
@@ -340 +223 @@
-        }
-        
-$tagName !== fals
+false !== $tagNam
-            $xmlWriter->writeEndElement();
-        }

trunk/src/test/php/net/stubbles/xml/serializer/annotations/stubXMLMatcherAnnotationTestCase.php

@@ -43 +43 @@
-        $matcher->setPattern('/.+/');
-
-, 'foo'
+
-        $this->assertEquals('bar', $tagName);
-    }
@@ -57 +57 @@
-        $matcher->setPattern('/^get(.+)/');
-
-, 'foo'
+
-        $this->assertEquals('bar', $tagName);
-    }
@@ -71 +71 @@
-        $matcher->setPattern('/^[0-9]+$/');
-
-, 'foo'
+
-        $this->assertFalse($tagName);
-    }
@@ -85 +85 @@
-        $matcher->setPattern('/^getFoo/');
-
-, 'foo'
+
-        $this->assertFalse($tagName);
-    }
@@ -100 +100 @@
-        $matcher->setPattern('/foo');
-
-, 'foo'
+
-    }
-
@@ -114 +114 @@
-        $matcher->setPattern('/foo');
-
-, 'foo'
+
-    }
-}

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

@@ -279 +279 @@
-        $this->serializer->serialize(null, $writer, array(stubXMLSerializer::OPT_ROOT_TAG => 'root'));
-        $this->assertEquals('<?xml version="1.0" encoding="UTF-8"?>' . "\n" . '<root><null/></root>', $writer->asXML());
+        $writer = new stubDomXMLStreamWriter();
+        $this->serializer->serialize(null, $writer);
+        $this->assertEquals('<?xml version="1.0" encoding="UTF-8"?>' . "\n" . '<null><null/></null>', $writer->asXML());
-    }
-
@@ -327 +330 @@
-        $this->serializer->serialize(true, $writer, array(stubXMLSerializer::OPT_ROOT_TAG => 'root'));
-        $this->assertEquals('<?xml version="1.0" encoding="UTF-8"?>' . "\n" . '<root>true</root>', $writer->asXML());
+        $writer = new stubDomXMLStreamWriter();
+        $this->serializer->serialize(true, $writer);
+        $this->assertEquals('<?xml version="1.0" encoding="UTF-8"?>' . "\n" . '<boolean>true</boolean>', $writer->asXML());
-    }
-
@@ -336 +342 @@
-    public function assocArray()
-    {
-
-
-
-
-
+
+
+
+
-        $this->serializer->serialize($array, $writer, array(stubXMLSerializer::OPT_ROOT_TAG => 'root'));
-        $this->assertEquals('<?xml version="1.0" encoding="UTF-8"?>' . "\n" . '<root><one>two</one><three>four</three></root>', $writer->asXML());
+        $writer = new stubDomXMLStreamWriter();
+        $this->serializer->serialize($array, $writer);
+        $this->assertEquals('<?xml version="1.0" encoding="UTF-8"?>' . "\n" . '<array><one>two</one><three>four</three></array>', $writer->asXML());
-    }
-
@@ -352 +360 @@
-    public function indexedArray()
-    {
-writer = new stubDomXMLStreamWriter(
-array = array('one', 'two', 'three'
+array  = array('one', 'two', 'three'
+writer = new stubDomXMLStreamWriter(
-        $this->serializer->serialize($array, $writer, array(stubXMLSerializer::OPT_ROOT_TAG => 'root'));
-        $this->assertEquals('<?xml version="1.0" encoding="UTF-8"?>' . "\n" . '<root><string>one</string><string>two</string><string>three</string></root>', $writer->asXML());
+        $writer = new stubDomXMLStreamWriter();
+        $this->serializer->serialize($array, $writer);
+        $this->assertEquals('<?xml version="1.0" encoding="UTF-8"?>' . "\n" . '<array><string>one</string><string>two</string><string>three</string></array>', $writer->asXML());
-    }
-
@@ -366 +377 @@
-    {
-        $writer = new stubDomXMLStreamWriter();
-
-
-
-
+
+
+
-        $this->serializer->serialize($array, $writer, array(stubXMLSerializer::OPT_ROOT_TAG => 'root'));
-        $this->assertEquals('<?xml version="1.0" encoding="UTF-8"?>' . "\n" . '<root><one>two</one><three><four>five</four></three></root>', $writer->asXML());
@@ -382 +392 @@
-    {
-        $writer = new stubDomXMLStreamWriter();
-
+   
-        $this->serializer->serialize($obj, $writer);
-        $this->assertEquals('<?xml version="1.0" encoding="UTF-8"?>' . "\n" . '<foo bar="test"><bar>42</bar></foo>', $writer->asXML());
@@ -394 +404 @@
-    public function nestedObject()
-    {
-
-
+  
+     
-        $obj->bar = new XMLSerializerFoo();
-        $this->serializer->serialize($obj, $writer);
@@ -414 +424 @@
-
-        $writer = new stubDomXMLStreamWriter();
-
+   
-        $this->serializer->serialize($obj, $writer);
-        $this->assertEquals('<?xml version="1.0" encoding="UTF-8"?>' . "\n" . '<container><item>one</item><item>two</item><item>three</item></container>', $writer->asXML());
@@ -427 +437 @@
-    {
-        $writer = new stubDomXMLStreamWriter();
-
+   
-        $this->serializer->serialize($obj, $writer);
-        $this->assertEquals('<?xml version="1.0" encoding="UTF-8"?>' . "\n" . '<class method="returned"/>', $writer->asXML());
@@ -440 +450 @@
-    {
-        $writer = new stubDomXMLStreamWriter();
-
+   
-        $this->serializer->serialize($obj, $writer);
-        $this->assertEquals('<?xml version="1.0" encoding="UTF-8"?>' . "\n" . '<testObject><one>one</one><two>two</two></testObject>', $writer->asXML());
@@ -453 +463 @@
-    {
-        $writer = new stubDomXMLStreamWriter();
-
+   
-        $this->serializer->serialize($obj, $writer);
-        $this->assertEquals('<?xml version="1.0" encoding="UTF-8"?>' . "\n" . '<testObject><foo>foo</foo></testObject>', $writer->asXML());
@@ -466 +476 @@
-    {
-        $writer = new stubDomXMLStreamWriter();
-
+   
-        $this->serializer->serialize($obj, $writer);
-        $this->assertEquals('<?xml version="1.0" encoding="UTF-8"?>' . "\n" . '<test><xml><foo>bar</foo></xml><foo>bar</foo></test>', $writer->asXML());
@@ -479 +489 @@
-    {
-        $writer = new stubDomXMLStreamWriter();
-
+   
-        $this->serializer->serialize($obj, $writer);
-        $this->assertEquals('<?xml version="1.0" encoding="UTF-8"?>' . "\n" . '<test emptyProp2="" emptyMethod2=""/>', $writer->asXML());
@@ -492 +502 @@
-    {
-        $writer = new stubDomXMLStreamWriter();
-
-
-
-
-
+
-        $this->serializer->serialize($obj, $writer);
-        $this->assertEquals('<?xml version="1.0" encoding="UTF-8"?>' . "\n" . '<stubXMLSerializerTestCase_Static/>', $writer->asXML());
@@ -509 +515 @@
-    {
-        $writer = new stubDomXMLStreamWriter();
-
+   
-        $this->serializer->serialize($obj, $writer);
-        $this->assertEquals('<?xml version="1.0" encoding="UTF-8"?>' . "\n" . utf8_encode('<test bar="Hühnchen"><foo>Hähnchen</foo></test>'), $writer->asXML());
-    }
+
+    /**
+     * a resource can not be serialized
+     *
+     * @test
+     */
+    public function resource()
+    {
+        $writer = new stubDomXMLStreamWriter();
+        $fp     = fopen(__FILE__, 'rb');
+        $this->serializer->serialize($fp, $writer);
+        $this->assertEquals('<?xml version="1.0" encoding="UTF-8"?>', $writer->asXML());
+        fclose($fp);
+    }
+
+    /**
+     * object data container can only be created for objects
+     *
+     * @test
+     * @expectedException  stubIllegalArgumentException
+     */
+    public function objectDataConstructionOnlyForObjects()
+    {
+        $serializerData = new stubXMLSerializerObjectData('foo');
+    }
+
+    /**
+     * object data container can only be created for objects
+     *
+     * @test
+     * @expectedException  stubIllegalArgumentException
+     */
+    public function objectDataOnlyForObjects()
+    {
+        $serializerData = stubXMLSerializerObjectData::fromObject('foo');
+    }
-}
-?>