Zend_Soap_Wsdl_Strategy_ArrayOfTypeComplex Class Reference

Inheritance diagram for Zend_Soap_Wsdl_Strategy_ArrayOfTypeComplex:

Public Member Functions
	addComplexType ($type)
Public Member Functions inherited from Zend_Soap_Wsdl_Strategy_DefaultComplexType
	addComplexType ($type)
Public Member Functions inherited from Zend_Soap_Wsdl_Strategy_Abstract
	setContext (Zend_Soap_Wsdl $context)
	getContext ()

Protected Member Functions
	_addArrayOfComplexType ($singularType, $type)
	_getXsdComplexTypeName ($type)
	_getSingularPhpType ($type)
	_getNestedCount ($type)

Protected Attributes
	$_inProcess = array()
Protected Attributes inherited from Zend_Soap_Wsdl_Strategy_Abstract
	$_context

Detailed Description

Definition at line 37 of file ArrayOfTypeComplex.php.

Member Function Documentation

_addArrayOfComplexType()

_addArrayOfComplexType (   $singularType,   $type  )

protected

Definition at line 90 of file ArrayOfTypeComplex.php.

    {
        $dom = $this->getContext()->toDomDocument();

        $xsdComplexTypeName = $this->_getXsdComplexTypeName($singularType);

        if(!in_array($xsdComplexTypeName, $this->getContext()->getTypes())) {
            $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', 'soap-enc:Array');
            $complexContent->appendChild($xsdRestriction);

            $xsdAttribute = $dom->createElement("xsd:attribute");
            $xsdAttribute->setAttribute("ref", "soap-enc:arrayType");
            $xsdAttribute->setAttribute("wsdl:arrayType", sprintf("tns:%s[]", $singularType));
            $xsdRestriction->appendChild($xsdAttribute);

            $this->getContext()->getSchema()->appendChild($complexType);
            $this->getContext()->addType($xsdComplexTypeName);
        }

        return $xsdComplexTypeName;
    }

_getNestedCount()

_getNestedCount (   $type )

protected

Return the array nesting level based on the type name

Parameters

string

$type

Returns

integer

Definition at line 141 of file ArrayOfTypeComplex.php.

    {
        return substr_count($type, "[]");
    }

_getSingularPhpType()

_getSingularPhpType (   $type )

protected

From a nested definition with type[], get the singular PHP Type

Parameters

string

$type

Returns

string

Definition at line 130 of file ArrayOfTypeComplex.php.

    {
        return str_replace("[]", "", $type);
    }

_getXsdComplexTypeName()

_getXsdComplexTypeName (   $type )

protected

Definition at line 119 of file ArrayOfTypeComplex.php.

    {
        return sprintf('ArrayOf%s', $type);
    }

addComplexType()

addComplexType

(

$type

)

Add an ArrayOfType based on the xsd:complexType syntax if type[] is detected in return value doc comment.

Parameters

string

$type

Returns

string tns:xsd-type

Implements Zend_Soap_Wsdl_Strategy_Interface.

Definition at line 47 of file ArrayOfTypeComplex.php.

    {
        if (in_array($type, $this->_inProcess)) {
            return "tns:" . $type;
        }
        $this->_inProcess[$type] = $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:
        if(!in_array($singularType, $this->getContext()->getTypes())) {
            parent::addComplexType($singularType);
        }

        unset($this->_inProcess[$type]);
        return "tns:".$xsdComplexTypeName;
    }

Field Documentation

$_inProcess

$_inProcess = array()

protected

Definition at line 39 of file ArrayOfTypeComplex.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/zendframework1/library/Zend/Soap/Wsdl/Strategy/ArrayOfTypeComplex.php