Changeset 860

Timestamp:

08/21/07 17:45:19 (1 year ago)

Author:

mikey

Message:

added possibility to retrieve the full qualified class name of a xml stream writer

Files:

• trunk/src/main/php/net/stubbles/xml/stubXMLStreamWriterFactory.php (modified) (4 diffs)
• trunk/src/test/php/net/stubbles/xml/stubXMLStreamWriterFactoryTestCase.php (modified) (5 diffs)

trunk/src/main/php/net/stubbles/xml/stubXMLStreamWriterFactory.php

@@ -35 +35 @@
-    public static function create($type)
-    {
-
-
-
+
+
+
+
-        }
-
-c
+nqC
-        return $xmlStreamWriter;
-    }
@@ -47 +48 @@
-     * creates a xml stream writer depending on available xml extensions
-     *
-
+
+
+
+
+
-     *
-     * @param   array                $order     optional  extensions in order to use
-     * @param   array                $features  optional  features the implementation must provide
-     * @return  stubXMLStreamWriter
+     * @throws  stubXMLException
-     */
-
+array 
-    {
-        if (null == $order) {
@@ -60 +66 @@
-
-        foreach ($order as $xmlExtension) {
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
-            }
-        }
@@ -78 +79 @@
-        throw new stubXMLException('Not any single xml extension available that provides the requested features, can not create a xml stream writer!');
-    }
+
+    /**
+     * returns full qualified class name for the xml stream writer of the given type
+     *
+     * @param   string  $type  concrete type of stream writer
+     * @return  string
+     */
+    public static function getFqClassName($type)
+    {
+        return 'net.stubbles.xml.stub' . $type . 'XMLStreamWriter';
+    }
+
+    /**
+     * returns full qualified class name for the xml stream writer depending on available xml extensions
+     * 
+     * If an order is submitted it will use this order, else it uses the default
+     * order.
+     * Warning: if a list of features is provided an instance of every possible
+     * xml stream writer will be created to check the feature list until a
+     * sufficient xml stream writer class was found.
+     *
+     * @param   array   $order     optional  extensions in order to use
+     * @param   array   $features  optional  features the implementation must provide
+     * @return  string
+     * @throws  stubXMLException
+     */
+    public static function getFqClassNameAsAvailable(array $order = null, array $features = array())
+    {
+        if (null == $order) {
+            $order = array_keys(self::$types);
+        }
+        
+        foreach ($order as $xmlExtension) {
+            $name = self::checkExtension($xmlExtension);
+            if (null === $name) {
+                continue;
+            }
+            
+            if (count($features) == 0) {
+                return self::getFqClassName($name);
+            }
+            
+            $xmlStreamWriter = self::checkFeatures($name, $features);
+            if (null !== $xmlStreamWriter) {
+                return $xmlStreamWriter->getClassName();
+            }
+        }
+        
+        throw new stubXMLException('Not any single xml extension available that provides the requested features, can not return a class name for a xml stream writer!');
+    }
+
+    /**
+     * checks given extension and returns their type name
+     * 
+     * If extension is not loaded the return value will be null.
+     *
+     * @param   string  $xmlExtension  name of the extension to check
+     * @return  string
+     */
+    protected static function checkExtension($xmlExtension)
+    {
+        if (extension_loaded($xmlExtension) === false) {
+            return null;
+        }
+        
+        return ((isset(self::$types[$xmlExtension]) === true) ? (self::$types[$xmlExtension]) : ($xmlExtension));
+    }
+
+    /**
+     * method to check if a given type of xml stream writer has requested features
+     * 
+     * Returns an instance of the xml stream writer if it has the requested
+     * features, else null.
+     *
+     * @param   string               $type      type of stream writer to check
+     * @param   array                $features  features the implementation must provide
+     * @return  stubXMLStreamWriter
+     */
+    protected static function checkFeatures($type, array $features)
+    {
+        $writer = self::create($type);
+        foreach ($features as $feature) {
+            if ($writer->hasFeature($feature) === false) {
+                return null;
+            }
+        }
+        
+        return $writer;
+    }
-}
-?>

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

@@ -1 +1 @@
-<?php
-/**
-
+.
- *
- * @author      Frank Kleine <mikey@stubbles.net>
@@ -12 +12 @@
-Mock::generate('stubXMLStreamWriter', 'stubMockXMLStreamWriter');
-/**
-
+.
- *
- * @package     stubbles
@@ -20 +20 @@
-{
-    /**
-T
+t
-     */
-    public function testCreate()
@@ -29 +29 @@
-
-    /**
-T
+t
-     */
-    public function testCreateAsAvailable()
@@ -39 +39 @@
-       stubXMLStreamWriterFactory::createAsAvailable(array('ExtensionDoesNotExist'));
-    }
+
+    /**
+     * test the finding class name of a xml stream writer with given order of extensions
+     */
+    public function testGetFqClassNameAsAvailable()
+    {
+       $this->assertEqual(stubXMLStreamWriterFactory::getFqClassNameAsAvailable(), 'net.stubbles.xml.stubDomXMLStreamWriter');
+       $this->assertEqual(stubXMLStreamWriterFactory::getFqClassNameAsAvailable(array('xmlwriter', 'Dom')), 'net.stubbles.xml.stubLibXmlXMLStreamWriter');
+       $this->assertEqual(stubXMLStreamWriterFactory::getFqClassNameAsAvailable(array('xmlwriter', 'Dom'), array(stubXMLStreamWriter::FEATURE_IMPORT_WRITER)), 'net.stubbles.xml.stubDomXMLStreamWriter');
+       $this->expectException('stubXMLException');
+       stubXMLStreamWriterFactory::getFqClassNameAsAvailable(array('ExtensionDoesNotExist'));
+    }
-}
-?>