import v1.0.0-RC4 | 2009-05-20

libs/Zend/Soap/Wsdl/Strategy/Abstract.php

@@ -0,0 +1,27 @@
+<?php
+
+abstract class Zend_Soap_Wsdl_Strategy_Abstract implements Zend_Soap_Wsdl_Strategy_Interface
+{
+    protected $_context;
+
+    /**
+     * Set the Zend_Soap_Wsdl Context object this strategy resides in.
+     *
+     * @param Zend_Soap_Wsdl $context
+     * @return void
+     */
+    public function setContext(Zend_Soap_Wsdl $context)
+    {
+        $this->_context = $context;
+    }
+
+    /**
+     * Return the current Zend_Soap_Wsdl context object
+     *
+     * @return Zend_Soap_Wsdl
+     */
+    public function getContext()
+    {
+        return $this->_context;
+    }
+}

libs/Zend/Soap/Wsdl/Strategy/AnyType.php

@@ -0,0 +1,45 @@
+<?php
+/**
+ * Zend Framework
+ *
+ * LICENSE
+ *
+ * This source file is subject to the new BSD license that is bundled
+ * with this package in the file LICENSE.txt.
+ * It is also available through the world-wide-web at this URL:
+ * http://framework.zend.com/license/new-bsd
+ * If you did not receive a copy of the license and are unable to
+ * obtain it through the world-wide-web, please send an email
+ * to license@zend.com so we can send you a copy immediately.
+ *
+ * @category   Zend
+ * @package    Zend_Soap
+ * @subpackage Wsdl
+ * @copyright  Copyright (c) 2005-2008 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license    http://framework.zend.com/license/new-bsd     New BSD License
+ * @version    $Id$
+ */
+
+class Zend_Soap_Wsdl_Strategy_AnyType implements Zend_Soap_Wsdl_Strategy_Interface
+{
+    /**
+     * Not needed in this strategy.
+     *
+     * @param Zend_Soap_Wsdl $context
+     */
+    public function setContext(Zend_Soap_Wsdl $context)
+    {
+        
+    }
+
+    /**
+     * Returns xsd:anyType regardless of the input.
+     *
+     * @param string $type
+     * @return string
+     */
+    public function addComplexType($type)
+    {
+        return 'xsd:anyType';
+    }
+}

libs/Zend/Soap/Wsdl/Strategy/ArrayOfTypeComplex.php

@@ -0,0 +1,133 @@
+<?php
+/**
+ * Zend Framework
+ *
+ * LICENSE
+ *
+ * This source file is subject to the new BSD license that is bundled
+ * with this package in the file LICENSE.txt.
+ * It is also available through the world-wide-web at this URL:
+ * http://framework.zend.com/license/new-bsd
+ * If you did not receive a copy of the license and are unable to
+ * obtain it through the world-wide-web, please send an email
+ * to license@zend.com so we can send you a copy immediately.
+ *
+ * @category   Zend
+ * @package    Zend_Soap
+ * @subpackage Wsdl
+ * @copyright  Copyright (c) 2005-2008 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license    http://framework.zend.com/license/new-bsd     New BSD License
+ * @version    $Id$
+ */
+
+require_once "Zend/Soap/Wsdl/Strategy/DefaultComplexType.php";
+
+class Zend_Soap_Wsdl_Strategy_ArrayOfTypeComplex extends Zend_Soap_Wsdl_Strategy_Abstract
+{
+    /**
+     * Add an ArrayOfType based on the xsd:complexType syntax if type[] is detected in return value doc comment.
+     *
+     * @param string $type
+     * @return string tns:xsd-type
+     */
+    public function addComplexType($type)
+    {
+        $nestingLevel = $this->_getNestedCount($type);
+
+        if($nestingLevel > 1) {
+            require_once "Zend/Soap/Wsdl/Exception.php";
+            throw new Zend_Soap_Wsdl_Exception(
+                "ArrayOfTypeComplex cannot return nested ArrayOfObject deeper than ".
+                "one level. Use array object properties to return deep nested data.
+            ");
+        }
+
+        $singularType = $this->_getSingularPhpType($type);
+
+        if(!class_exists($singularType)) {
+            require_once "Zend/Soap/Wsdl/Exception.php";
+            throw new Zend_Soap_Wsdl_Exception(sprintf(
+                "Cannot add a complex type %s that is not an object or where ".
+                "class could not be found in 'DefaultComplexType' strategy.", $type
+            ));
+        }
+
+        if($nestingLevel == 1) {
+            // The following blocks define the Array of Object structure
+            $xsdComplexTypeName = $this->_addArrayOfComplexType($singularType, $type);
+        } else {
+            $xsdComplexTypeName = $singularType;
+        }
+
+        // The array for the objects has been created, now build the object definition:
+        $this->_addObjectComplexType($singularType);
+
+        return "tns:".$xsdComplexTypeName;
+    }
+
+    protected function _addArrayOfComplexType($singularType, $type)
+    {
+        $dom = $this->getContext()->toDomDocument();
+
+        $xsdComplexTypeName = $this->_getXsdComplexTypeName($singularType);
+        $complexType = $dom->createElement('xsd:complexType');
+        $complexType->setAttribute('name', $xsdComplexTypeName);
+
+        $complexContent = $dom->createElement("xsd:complexContent");
+        $complexType->appendChild($complexContent);
+
+        $xsdRestriction = $dom->createElement("xsd:restriction");
+        $xsdRestriction->setAttribute('base', 'soapenc:Array');
+        $complexContent->appendChild($xsdRestriction);
+
+        $xsdAttribute = $dom->createElement("xsd:attribute");
+        $xsdAttribute->setAttribute("ref", "soapenc:arrayType");
+        $xsdAttribute->setAttribute("wsdl:arrayType", sprintf("tns:%s[]", $singularType));
+        $xsdRestriction->appendChild($xsdAttribute);
+
+        $this->getContext()->getSchema()->appendChild($complexType);
+        $this->getContext()->addType($type);
+
+        return $xsdComplexTypeName;
+    }
+
+    protected function _addObjectComplexType($singularType)
+    {
+        $complexStrategy = $this->getContext()->getComplexTypeStrategy();
+
+        // Override strategy to stay DRY
+        $objectStrategy = new Zend_Soap_Wsdl_Strategy_DefaultComplexType();
+        $this->getContext()->setComplexTypeStrategy($objectStrategy);
+        $this->getContext()->addComplexType($singularType);
+
+        // Reset strategy
+        $this->getContext()->setComplexTypeStrategy($complexStrategy);
+    }
+
+    protected function _getXsdComplexTypeName($type)
+    {
+        return sprintf('ArrayOf%s', $type);
+    }
+
+    /**
+     * From a nested defintion with type[], get the singular PHP Type
+     *
+     * @param  string $type
+     * @return string
+     */
+    protected function _getSingularPhpType($type)
+    {
+        return str_replace("[]", "", $type);
+    }
+
+    /**
+     * Return the array nesting level based on the type name
+     *
+     * @param  string $type
+     * @return integer
+     */
+    protected function _getNestedCount($type)
+    {
+        return substr_count($type, "[]");
+    }
+}

libs/Zend/Soap/Wsdl/Strategy/ArrayOfTypeSequence.php

@@ -0,0 +1,148 @@
+<?php
+/**
+ * Zend Framework
+ *
+ * LICENSE
+ *
+ * This source file is subject to the new BSD license that is bundled
+ * with this package in the file LICENSE.txt.
+ * It is also available through the world-wide-web at this URL:
+ * http://framework.zend.com/license/new-bsd
+ * If you did not receive a copy of the license and are unable to
+ * obtain it through the world-wide-web, please send an email
+ * to license@zend.com so we can send you a copy immediately.
+ *
+ * @category   Zend
+ * @package    Zend_Soap
+ * @copyright  Copyright (c) 2005-2008 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license    http://framework.zend.com/license/new-bsd     New BSD License
+ * @version    $Id$
+ */
+
+class Zend_Soap_Wsdl_Strategy_ArrayOfTypeSequence extends Zend_Soap_Wsdl_Strategy_Abstract
+{
+    /**
+     * Add an unbounded ArrayOfType based on the xsd:sequence syntax if type[] is detected in return value doc comment.
+     *
+     * @param string $type
+     * @return string tns:xsd-type
+     */
+    public function addComplexType($type)
+    {
+        $nestedCounter = $this->_getNestedCount($type);
+
+        if($nestedCounter > 0) {
+            $singularType = $this->_getSingularType($type);
+
+            for($i = 1; $i <= $nestedCounter; $i++) {
+                $complexTypeName = $this->_getTypeNameBasedOnNestingLevel($singularType, $i);
+                $childTypeName = $this->_getTypeNameBasedOnNestingLevel($singularType, $i-1);
+
+                $this->_addElementFromWsdlAndChildTypes($complexTypeName, $childTypeName);
+            }
+            // adding the PHP type which is resolved to a nested XSD type. therefore add only once.
+            $this->getContext()->addType($type);
+
+            return "tns:$complexTypeName";
+        } else {
+            require_once "Zend/Soap/Wsdl/Exception.php";
+            throw new Zend_Soap_Wsdl_Exception(sprintf(
+                'ArrayOfTypeSequence Strategy does not allow for complex types that are not in @return type[] syntax. "%s" type was specified.', $type
+            ));
+        }
+    }
+
+    /**
+     * Return the ArrayOf or simple type name based on the singular xsdtype and the nesting level
+     *
+     * @param  string $singularType
+     * @param  int    $level
+     * @return string
+     */
+    protected function _getTypeNameBasedOnNestingLevel($singularType, $level)
+    {
+        if($level == 0) {
+            // This is not an Array anymore, return the xsd simple type
+            return $singularType;
+        } else {
+            $prefix = str_repeat("ArrayOf", $level);
+            $xsdType = $this->_getStrippedXsdType($singularType);
+            $arrayType = $prefix.$xsdType;
+            return $arrayType;
+        }
+    }
+
+    /**
+     * Strip the xsd: from a singularType and Format it nice for ArrayOf<Type> naming
+     *
+     * @param  string $singularType
+     * @return string
+     */
+    protected function _getStrippedXsdType($singularType)
+    {
+        return ucfirst(substr(strtolower($singularType), 4));
+    }
+
+    /**
+     * From a nested defintion with type[], get the singular xsd:type
+     *
+     * @throws Zend_Soap_Wsdl_Exception When no xsd:simpletype can be detected.
+     * @param  string $type
+     * @return string
+     */
+    protected function _getSingularType($type)
+    {
+        $singulartype = $this->getContext()->getType(str_replace("[]", "", $type));
+
+        if(substr($singulartype, 0, 4) != "xsd:") {
+            require_once "Zend/Soap/Wsdl/Exception.php";
+            throw new Zend_Soap_Wsdl_Exception(sprintf(
+                'ArrayOfTypeSequence Strategy works only with arrays of simple types like int, string, boolean, not with "%s".'.
+                'You may use Zend_Soap_Wsdl_Strategy_ArrayOfTypeComplex for more complex types.', $type
+            ));
+        }
+        return $singulartype;
+    }
+
+    /**
+     * Return the array nesting level based on the type name
+     *
+     * @param  string $type
+     * @return integer
+     */
+    protected function _getNestedCount($type)
+    {
+        return substr_count($type, "[]");
+    }
+
+    /**
+     * Append the complex type definition to the WSDL via the context access
+     *
+     * @param  string $arrayType
+     * @param  string $childTypeName
+     * @return void
+     */
+    protected function _addElementFromWsdlAndChildTypes($arrayType, $childTypeName)
+    {
+        if (!in_array($arrayType, $this->getContext()->getTypes())) {
+            $dom = $this->getContext()->toDomDocument();
+
+            $complexType = $dom->createElement('xsd:complexType');
+            $complexType->setAttribute('name', $arrayType);
+
+            $sequence = $dom->createElement('xsd:sequence');
+
+            $element = $dom->createElement('xsd:element');
+            $element->setAttribute('name',      'item');
+            $element->setAttribute('type',      $childTypeName);
+            $element->setAttribute('minOccurs', 0);
+            $element->setAttribute('maxOccurs', 'unbounded');
+            $sequence->appendChild($element);
+
+            $complexType->appendChild($sequence);
+
+            $this->getContext()->getSchema()->appendChild($complexType);
+            $this->getContext()->addType($arrayType);
+        }
+    }
+}

libs/Zend/Soap/Wsdl/Strategy/DefaultComplexType.php

@@ -0,0 +1,69 @@
+<?php
+/**
+ * Zend Framework
+ *
+ * LICENSE
+ *
+ * This source file is subject to the new BSD license that is bundled
+ * with this package in the file LICENSE.txt.
+ * It is also available through the world-wide-web at this URL:
+ * http://framework.zend.com/license/new-bsd
+ * If you did not receive a copy of the license and are unable to
+ * obtain it through the world-wide-web, please send an email
+ * to license@zend.com so we can send you a copy immediately.
+ *
+ * @category   Zend
+ * @package    Zend_Soap
+ * @subpackage Wsdl
+ * @copyright  Copyright (c) 2005-2008 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license    http://framework.zend.com/license/new-bsd     New BSD License
+ * @version    $Id$
+ */
+
+class Zend_Soap_Wsdl_Strategy_DefaultComplexType extends Zend_Soap_Wsdl_Strategy_Abstract
+{
+    /**
+     * Add a complex type by recursivly using all the class properties fetched via Reflection.
+     *
+     * @param  string $type Name of the class to be specified
+     * @return string XSD Type for the given PHP type
+     */
+    public function addComplexType($type)
+    {
+        if(!class_exists($type)) {
+            require_once "Zend/Soap/Wsdl/Exception.php";
+            throw new Zend_Soap_Wsdl_Exception(sprintf(
+                "Cannot add a complex type %s that is not an object or where ".
+                "class could not be found in 'DefaultComplexType' strategy.", $type
+            ));
+        }
+
+        $dom = $this->getContext()->toDomDocument();
+        $class = new ReflectionClass($type);
+
+        $complexType = $dom->createElement('xsd:complexType');
+        $complexType->setAttribute('name', $type);
+
+        $all = $dom->createElement('xsd:all');
+
+        foreach ($class->getProperties() as $property) {
+            if (preg_match_all('/@var\s+([^\s]+)/m', $property->getDocComment(), $matches)) {
+
+                /**
+                 * @todo check if 'xsd:element' must be used here (it may not be compatible with using 'complexType'
+                 * node for describing other classes used as attribute types for current class
+                 */
+                $element = $dom->createElement('xsd:element');
+                $element->setAttribute('name', $property->getName());
+                $element->setAttribute('type', $this->getContext()->getType(trim($matches[1][0])));
+                $all->appendChild($element);
+            }
+        }
+
+        $complexType->appendChild($all);
+        $this->getContext()->getSchema()->appendChild($complexType);
+        $this->getContext()->addType($type);
+
+        return "tns:$type";
+    }
+}

libs/Zend/Soap/Wsdl/Strategy/Interface.php

@@ -0,0 +1,35 @@
+<?php
+/**
+ * Zend Framework
+ *
+ * LICENSE
+ *
+ * This source file is subject to the new BSD license that is bundled
+ * with this package in the file LICENSE.txt.
+ * It is also available through the world-wide-web at this URL:
+ * http://framework.zend.com/license/new-bsd
+ * If you did not receive a copy of the license and are unable to
+ * obtain it through the world-wide-web, please send an email
+ * to license@zend.com so we can send you a copy immediately.
+ *
+ * @category   Zend
+ * @package    Zend_Soap
+ * @subpackage Wsdl
+ * @copyright  Copyright (c) 2005-2008 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license    http://framework.zend.com/license/new-bsd     New BSD License
+ * @version    $Id$
+ */
+
+
+interface Zend_Soap_Wsdl_Strategy_Interface
+{
+    public function setContext(Zend_Soap_Wsdl $context);
+
+    /**
+     * Create a complex type based on a strategy
+     *
+     * @param  string $type
+     * @return string XSD type
+     */
+    public function addComplexType($type);
+}