Zend_Soap_Wsdl Class Reference

Public Member Functions
	__construct ($name, $uri, $strategy=true)
	setUri ($uri)
	setComplexTypeStrategy ($strategy)
	getComplexTypeStrategy ()
	addMessage ($name, $parts)
	addPortType ($name)
	addPortOperation ($portType, $name, $input=false, $output=false, $fault=false)
	addBinding ($name, $portType)
	addBindingOperation ($binding, $name, $input=false, $output=false, $fault=false)
	addSoapBinding ($binding, $style='document', $transport='http://schemas.xmlsoap.org/soap/http')
	addSoapOperation ($binding, $soap_action)
	addService ($name, $port_name, $binding, $location)
	addDocumentation ($input_node, $documentation)
	addTypes ($types)
	addType ($type)
	getTypes ()
	getSchema ()
	toXML ()
	toDomDocument ()
	dump ($filename=false)
	getType ($type)
	addSchemaTypeSection ()
	addComplexType ($type)
	addElement ($element)

Protected Attributes
	$_strategy = null

Detailed Description

Definition at line 41 of file Wsdl.php.

Constructor & Destructor Documentation

__construct()

__construct	(		$name,
			$uri,
			$strategy = true
	)

Constructor

Parameters

string	$name	Name of the Web Service being Described
string	$uri	URI where the WSDL will be available
boolean | string | Zend_Soap_Wsdl_Strategy_Interface	$strategy

Todo:

change DomDocument object creation from cparsing to construxting using API It also should authomatically escape $name and $uri values if necessary

Definition at line 83 of file Wsdl.php.

    {
        if ($uri instanceof Zend_Uri_Http) {
            $uri = $uri->getUri();
        }
        $this->_uri = $uri;

        $wsdl = "<?xml version='1.0' ?>
                <definitions name='$name' targetNamespace='$uri'
                    xmlns='http://schemas.xmlsoap.org/wsdl/'
                    xmlns:tns='$uri'
                    xmlns:soap='http://schemas.xmlsoap.org/wsdl/soap/'
                    xmlns:xsd='http://www.w3.org/2001/XMLSchema'
                    xmlns:soap-enc='http://schemas.xmlsoap.org/soap/encoding/'
                    xmlns:wsdl='http://schemas.xmlsoap.org/wsdl/'></definitions>";
        $this->_dom = new DOMDocument();
        if (!$this->_dom = Zend_Xml_Security::scan($wsdl, $this->_dom)) {
            #require_once 'Zend/Server/Exception.php';
            throw new Zend_Server_Exception('Unable to create DomDocument');
        }
        $this->_wsdl = $this->_dom->documentElement;

        $this->setComplexTypeStrategy($strategy);
    }

Member Function Documentation

addBinding()

addBinding	(		$name,
			$portType
	)

Add a binding element to WSDL

Parameters

string	$name	Name of the Binding
string	$type	name of the portType to bind

Returns

object The new binding's XML_Tree_Node for use with addBindingOperation and addDocumentation

Definition at line 275 of file Wsdl.php.

    {
        $binding = $this->_dom->createElement('binding');
        $binding->setAttribute('name', $name);
        $binding->setAttribute('type', $portType);

        $this->_wsdl->appendChild($binding);

        return $binding;
    }

addBindingOperation()

addBindingOperation	(		$binding,
			$name,
			$input = false,
			$output = false,
			$fault = false
	)

Add an operation to a binding element

Parameters

object	$binding	A binding XML_Tree_Node returned by addBinding
array	$input	An array of attributes for the input element, allowed keys are: 'use', 'namespace', 'encodingStyle'. More Information
array	$output	An array of attributes for the output element, allowed keys are: 'use', 'namespace', 'encodingStyle'. More Information
array	$fault	An array of attributes for the fault element, allowed keys are: 'name', 'use', 'namespace', 'encodingStyle'. More Information

Returns

object The new Operation's XML_Tree_Node for use with addSoapOperation and addDocumentation

Note. Do we really need name attribute to be also set at wsdl:fault node??? W3C standard doesn't mention it (http://www.w3.org/TR/wsdl#_soap:fault) But some real world WSDLs use it, so it may be required for compatibility reasons.

Definition at line 295 of file Wsdl.php.

    {
        $operation = $this->_dom->createElement('operation');
        $operation->setAttribute('name', $name);

        if (is_array($input)) {
            $node = $this->_dom->createElement('input');
            $soap_node = $this->_dom->createElement('soap:body');
            foreach ($input as $name => $value) {
                $soap_node->setAttribute($name, $value);
            }
            $node->appendChild($soap_node);
            $operation->appendChild($node);
        }

        if (is_array($output)) {
            $node = $this->_dom->createElement('output');
            $soap_node = $this->_dom->createElement('soap:body');
            foreach ($output as $name => $value) {
                $soap_node->setAttribute($name, $value);
            }
            $node->appendChild($soap_node);
            $operation->appendChild($node);
        }

        if (is_array($fault)) {
            $node = $this->_dom->createElement('fault');
            if (isset($fault['name'])) {
                $node->setAttribute('name', $fault['name']);
            }

            $soap_node = $this->_dom->createElement('soap:fault');
            foreach ($fault as $name => $value) {
                $soap_node->setAttribute($name, $value);
            }
            $node->appendChild($soap_node);
            $operation->appendChild($node);
        }

        $binding->appendChild($operation);

        return $operation;
    }

addComplexType()

addComplexType

(

$type

)

Add a types data type definition

Parameters

string

$type

Name of the class to be specified

Returns

string XSD Type for the given PHP type

Definition at line 597 of file Wsdl.php.

    {
        if (in_array($type, $this->getTypes())) {
            return "tns:$type";
        }
        $this->addSchemaTypeSection();

        $strategy = $this->getComplexTypeStrategy();
        $strategy->setContext($this);
        // delegates the detection of a complex type to the current strategy
        return $strategy->addComplexType($type);
    }

addDocumentation()

addDocumentation	(		$input_node,
			$documentation
	)

Add a documentation element to any element in the WSDL.

Note that the WSDL specification uses 'document', but the WSDL schema uses 'documentation' instead. The WS-I Basic Profile 1.1 recommends using 'documentation'.

Parameters

object	$input_node	An XML_Tree_Node returned by another method to add the documentation to
string	$documentation	Human readable documentation for the node

Returns

DOMElement The documentation element

Definition at line 426 of file Wsdl.php.

    {
        if ($input_node === $this) {
            $node = $this->_dom->documentElement;
        } else {
            $node = $input_node;
        }

        $doc = $this->_dom->createElement('documentation');
        $doc_cdata = $this->_dom->createTextNode(str_replace(array("\r\n", "\r"), "\n", $documentation));
        $doc->appendChild($doc_cdata);

        if($node->hasChildNodes()) {
            $node->insertBefore($doc, $node->firstChild);
        } else {
            $node->appendChild($doc);
        }

        return $doc;
    }

addElement()

addElement

(

$element

)

Add an xsd:element represented as an array to the schema.

Array keys represent attribute names and values their respective value. The 'sequence', 'all' and 'choice' keys must have an array of elements as their value, to add them to a nested complexType.

Example: array( 'name' => 'MyElement', 'sequence' => array( array('name' => 'myString', 'type' => 'string'), array('name' => 'myInteger', 'type' => 'int') ) ); Resulting XML: <xsd:element name="MyElement"><xsd:complexType><xsd:sequence> <xsd:element name="myString" type="string"/> <xsd:element name="myInteger" type="int"/> </xsd:sequence></xsd:complexType></xsd:element>

Parameters

array

$element

an xsd:element represented as an array

Returns

string xsd:element for the given element array

Definition at line 663 of file Wsdl.php.

    {
        $schema = $this->getSchema();
        $elementXml = $this->_parseElement($element);
        $schema->appendChild($elementXml);
        return 'tns:' . $element['name'];
    }

addMessage()

addMessage	(		$name,
			$parts
	)

Add a message element to the WSDL

Parameters

string	$name	Name for the message
array	$parts	An array of parts The array is constructed like: 'name of part' => 'part xml schema data type' or 'name of part' => array('type' => 'part xml schema type') or 'name of part' => array('element' => 'part xml element name')

Returns

object The new message's XML_Tree_Node for use in addDocumentation

Definition at line 191 of file Wsdl.php.

    {
        $message = $this->_dom->createElement('message');

        $message->setAttribute('name', $name);

        if (sizeof($parts) > 0) {
            foreach ($parts as $name => $type) {
                $part = $this->_dom->createElement('part');
                $part->setAttribute('name', $name);
                if (is_array($type)) {
                    foreach ($type as $key => $value) {
                        $part->setAttribute($key, $value);
                    }
                } else {
                    $part->setAttribute('type', $type);
                }
                $message->appendChild($part);
            }
        }

        $this->_wsdl->appendChild($message);

        return $message;
    }

addPortOperation()

addPortOperation	(		$portType,
			$name,
			$input = false,
			$output = false,
			$fault = false
	)

Add an operation element to a portType element

Parameters

object	$portType	a portType XML_Tree_Node, from addPortType
string	$name	Operation name
string	$input	Input Message
string	$output	Output Message
string	$fault	Fault Message

Returns

object The new operation's XML_Tree_Node for use in addDocumentation

Definition at line 242 of file Wsdl.php.

    {
        $operation = $this->_dom->createElement('operation');
        $operation->setAttribute('name', $name);

        if (is_string($input) && (strlen(trim($input)) >= 1)) {
            $node = $this->_dom->createElement('input');
            $node->setAttribute('message', $input);
            $operation->appendChild($node);
        }
        if (is_string($output) && (strlen(trim($output)) >= 1)) {
            $node= $this->_dom->createElement('output');
            $node->setAttribute('message', $output);
            $operation->appendChild($node);
        }
        if (is_string($fault) && (strlen(trim($fault)) >= 1)) {
            $node = $this->_dom->createElement('fault');
            $node->setAttribute('message', $fault);
            $operation->appendChild($node);
        }

        $portType->appendChild($operation);

        return $operation;
    }

addPortType()

addPortType

(

$name

)

Add a portType element to the WSDL

Parameters

string

$name

portType element's name

Returns

object The new portType's XML_Tree_Node for use in addPortOperation and addDocumentation

Definition at line 223 of file Wsdl.php.

    {
        $portType = $this->_dom->createElement('portType');
        $portType->setAttribute('name', $name);
        $this->_wsdl->appendChild($portType);

        return $portType;
    }

addSchemaTypeSection()

addSchemaTypeSection

(

)

This function makes sure a complex types section and schema additions are set.

Returns

Zend_Soap_Wsdl

Definition at line 579 of file Wsdl.php.

    {
        if ($this->_schema === null) {
            $this->_schema = $this->_dom->createElement('xsd:schema');
            $this->_schema->setAttribute('targetNamespace', $this->_uri);
            $types = $this->_dom->createElement('types');
            $types->appendChild($this->_schema);
            $this->_wsdl->appendChild($types);
        }
        return $this;
    }

addService()

addService	(		$name,
			$port_name,
			$binding,
			$location
	)

Add a service element to the WSDL

Parameters

string	$name	Service Name
string	$port_name	Name of the port for the service
string	$binding	Binding for the port
string	$location	SOAP Address for the service

Returns

object The new service's XML_Tree_Node for use with addDocumentation

Definition at line 392 of file Wsdl.php.

    {
        if ($location instanceof Zend_Uri_Http) {
            $location = $location->getUri();
        }
        $service = $this->_dom->createElement('service');
        $service->setAttribute('name', $name);

        $port = $this->_dom->createElement('port');
        $port->setAttribute('name', $port_name);
        $port->setAttribute('binding', $binding);

        $soap_address = $this->_dom->createElement('soap:address');
        $soap_address->setAttribute('location', $location);

        $port->appendChild($soap_address);
        $service->appendChild($port);

        $this->_wsdl->appendChild($service);

        return $service;
    }

addSoapBinding()

addSoapBinding	(		$binding,
			$style = 'document',
			$transport = 'http://schemas.xmlsoap.org/soap/http'
	)

Add a SOAP binding element to a Binding element

Parameters

object	$binding	A binding XML_Tree_Node returned by addBinding
string	$style	binding style, possible values are "rpc" (the default) and "document"
string	$transport	Transport method (defaults to HTTP)

Returns

boolean

Definition at line 352 of file Wsdl.php.

                                                                                    ://schemas.xmlsoap.org/soap/http')
    {
        $soap_binding = $this->_dom->createElement('soap:binding');
        $soap_binding->setAttribute('style', $style);
        $soap_binding->setAttribute('transport', $transport);

        $binding->appendChild($soap_binding);

        return $soap_binding;
    }

addSoapOperation()

addSoapOperation	(		$binding,
			$soap_action
	)

Add a SOAP operation to an operation element

Parameters

object	$operation	An operation XML_Tree_Node returned by addBindingOperation
string	$soap_action	SOAP Action

Returns

boolean

Definition at line 370 of file Wsdl.php.

    {
        if ($soap_action instanceof Zend_Uri_Http) {
            $soap_action = $soap_action->getUri();
        }
        $soap_operation = $this->_dom->createElement('soap:operation');
        $soap_operation->setAttribute('soapAction', $soap_action);

        $binding->insertBefore($soap_operation, $binding->firstChild);

        return $soap_operation;
    }

addType()

addType

(

$type

)

Add a complex type name that is part of this WSDL and can be used in signatures.

Parameters

string

$type

Returns

Zend_Soap_Wsdl

Definition at line 469 of file Wsdl.php.

    {
        if(!in_array($type, $this->_includedTypes)) {
            $this->_includedTypes[] = $type;
        }
        return $this;
    }

addTypes()

addTypes

(

$types

)

Add WSDL Types element

Parameters

object

$types

A DomDocument|DomNode|DomElement|DomDocumentFragment with all the XML Schema types defined in it

Definition at line 452 of file Wsdl.php.

    {
        if ($types instanceof DomDocument) {
            $dom = $this->_dom->importNode($types->documentElement);
            $this->_wsdl->appendChild($types->documentElement);
        } elseif ($types instanceof DomNode || $types instanceof DomElement || $types instanceof DomDocumentFragment ) {
            $dom = $this->_dom->importNode($types);
            $this->_wsdl->appendChild($dom);
        }
    }

dump()

dump

(

$filename = false

)

Echo the WSDL as XML

Returns

boolean

Definition at line 526 of file Wsdl.php.

    {
        if (!$filename) {
            echo $this->toXML();
            return true;
        } else {
            return file_put_contents($filename, $this->toXML());
        }
    }

getComplexTypeStrategy()

getComplexTypeStrategy

(

)

Get the current complex type strategy

Returns

Zend_Soap_Wsdl_Strategy_Interface

Definition at line 176 of file Wsdl.php.

    {
        return $this->_strategy;
    }

getSchema()

getSchema

(

)

Return the Schema node of the WSDL

Returns

DOMElement

Definition at line 492 of file Wsdl.php.

    {
        if($this->_schema == null) {
            $this->addSchemaTypeSection();
        }

        return $this->_schema;
    }

getType()

getType

(

$type

)

Returns an XSD Type for the given PHP type

Parameters

string

$type

PHP Type to get the XSD type for

Returns

string

Definition at line 542 of file Wsdl.php.

    {
        switch (strtolower($type)) {
            case 'string':
            case 'str':
                return 'xsd:string';
            case 'long':
                return 'xsd:long';
            case 'int':
            case 'integer':
                return 'xsd:int';
            case 'float':
                return 'xsd:float';
            case 'double':
                return 'xsd:double';
            case 'boolean':
            case 'bool':
                return 'xsd:boolean';
            case 'array':
                return 'soap-enc:Array';
            case 'object':
                return 'xsd:struct';
            case 'mixed':
                return 'xsd:anyType';
            case 'void':
                return '';
            default:
                // delegate retrieval of complex type to current strategy
                return $this->addComplexType($type);
            }
    }

getTypes()

getTypes

(

)

Return an array of all currently included complex types

Returns

array

Definition at line 482 of file Wsdl.php.

    {
        return $this->_includedTypes;
    }

setComplexTypeStrategy()

setComplexTypeStrategy

(

$strategy

)

Set a strategy for complex type detection and handling

Todo:

Boolean is for backwards compability with extractComplexType object var. Remove it in later versions.

Parameters

boolean | string | Zend_Soap_Wsdl_Strategy_Interface

$strategy

Returns

Zend_Soap_Wsdl

Definition at line 144 of file Wsdl.php.

    {
        if($strategy === true) {
            #require_once "Zend/Soap/Wsdl/Strategy/DefaultComplexType.php";
            $strategy = new Zend_Soap_Wsdl_Strategy_DefaultComplexType();
        } else if($strategy === false) {
            #require_once "Zend/Soap/Wsdl/Strategy/AnyType.php";
            $strategy = new Zend_Soap_Wsdl_Strategy_AnyType();
        } else if(is_string($strategy)) {
            if(class_exists($strategy)) {
                $strategy = new $strategy();
            } else {
                #require_once "Zend/Soap/Wsdl/Exception.php";
                throw new Zend_Soap_Wsdl_Exception(
                    sprintf("Strategy with name '%s does not exist.", $strategy
                ));
            }
        }

        if(!($strategy instanceof Zend_Soap_Wsdl_Strategy_Interface)) {
            #require_once "Zend/Soap/Wsdl/Exception.php";
            throw new Zend_Soap_Wsdl_Exception("Set a strategy that is not of type 'Zend_Soap_Wsdl_Strategy_Interface'");
        }
        $this->_strategy = $strategy;
        return $this;
    }

setUri()

setUri

(

$uri

)

Set a new uri for this WSDL

Parameters

string | Zend_Uri_Http

$uri

Returns

Zend_Server_Wsdl

Definition at line 118 of file Wsdl.php.

    {
        if ($uri instanceof Zend_Uri_Http) {
            $uri = $uri->getUri();
        }
        $oldUri = $this->_uri;
        $this->_uri = $uri;

        if($this->_dom !== null) {
            // @todo: This is the worst hack ever, but its needed due to design and non BC issues of WSDL generation
            $xml = $this->_dom->saveXML();
            $xml = str_replace($oldUri, $uri, $xml);
            $this->_dom = new DOMDocument();
            $this->_dom = Zend_Xml_Security::scan($xml, $this->_dom);
        }

        return $this;
    }

toDomDocument()

toDomDocument

(

)

Return DOM Document

Returns

object DomDocum ent

Definition at line 516 of file Wsdl.php.

    {
        return $this->_dom;
    }

toXML()

toXML

(

)

Return the WSDL as XML

Returns

string WSDL as XML

Definition at line 506 of file Wsdl.php.

    {
           return $this->_dom->saveXML();
    }

Field Documentation

$_strategy

$_strategy = null

protected

Strategy for detection of complex types

Definition at line 73 of file Wsdl.php.

---

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

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