Moodle  2.2.1
http://www.collinsharper.com
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 38 of file Wsdl.php.


Constructor & Destructor Documentation

__construct ( name,
uri,
strategy = true 
)

Constructor

Parameters:
string$nameName of the Web Service being Described
string$uriURI 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 80 of file Wsdl.php.

Here is the call graph for this function:


Member Function Documentation

addBinding ( name,
portType 
)

Add a binding element to WSDL

Parameters:
string$nameName of the Binding
string$typename of the portType to bind
Returns:
object The new binding's XML_Tree_Node for use with addBindingOperation and addDocumentation

Definition at line 273 of file Wsdl.php.

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

Add an operation to a binding element

Parameters:
object$bindingA binding XML_Tree_Node returned by addBinding
array$inputAn array of attributes for the input element, allowed keys are: 'use', 'namespace', 'encodingStyle'. More Information
array$outputAn array of attributes for the output element, allowed keys are: 'use', 'namespace', 'encodingStyle'. More Information
array$faultAn 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

Definition at line 293 of file Wsdl.php.

addComplexType ( type)

Add a types data type definition

Parameters:
string$typeName of the class to be specified
Returns:
string XSD Type for the given PHP type

Definition at line 593 of file Wsdl.php.

Here is the call graph for this function:

Here is the caller graph for this function:

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_nodeAn XML_Tree_Node returned by another method to add the documentation to
string$documentationHuman readable documentation for the node
Returns:
DOMElement The documentation element

Definition at line 418 of file Wsdl.php.

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$elementan xsd:element represented as an array
Returns:
string xsd:element for the given element array

Definition at line 659 of file Wsdl.php.

Here is the call graph for this function:

addMessage ( name,
parts 
)

Add a message element to the WSDL

Parameters:
string$nameName for the message
array$partsAn 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 189 of file Wsdl.php.

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

Add an operation element to a portType element

Parameters:
object$portTypea portType XML_Tree_Node, from addPortType
string$nameOperation name
string$inputInput Message
string$outputOutput Message
string$faultFault Message
Returns:
object The new operation's XML_Tree_Node for use in addDocumentation

Definition at line 240 of file Wsdl.php.

addPortType ( name)

Add a portType element to the WSDL

Parameters:
string$nameportType element's name
Returns:
object The new portType's XML_Tree_Node for use in addPortOperation and addDocumentation

Definition at line 221 of file Wsdl.php.

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

Returns:
Zend_Soap_Wsdl

Definition at line 575 of file Wsdl.php.

Here is the caller graph for this function:

addService ( name,
port_name,
binding,
location 
)

Add a service element to the WSDL

Parameters:
string$nameService Name
string$port_nameName of the port for the service
string$bindingBinding for the port
string$locationSOAP Address for the service
Returns:
object The new service's XML_Tree_Node for use with addDocumentation

Definition at line 384 of file Wsdl.php.

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

Add a SOAP binding element to a Binding element

Parameters:
object$bindingA binding XML_Tree_Node returned by addBinding
string$stylebinding style, possible values are "rpc" (the default) and "document"
string$transportTransport method (defaults to HTTP)
Returns:
boolean

Definition at line 344 of file Wsdl.php.

addSoapOperation ( binding,
soap_action 
)

Add a SOAP operation to an operation element

Parameters:
object$operationAn operation XML_Tree_Node returned by addBindingOperation
string$soap_actionSOAP Action
Returns:
boolean

Definition at line 362 of file Wsdl.php.

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 461 of file Wsdl.php.

addTypes ( types)

Add WSDL Types element

Parameters:
object$typesA DomDocument|DomNode|DomElement|DomDocumentFragment with all the XML Schema types defined in it

Definition at line 444 of file Wsdl.php.

dump ( filename = false)

Echo the WSDL as XML

Returns:
boolean

Definition at line 518 of file Wsdl.php.

Here is the call graph for this function:

Get the current complex type strategy

Returns:
Zend_Soap_Wsdl_Strategy_Interface

Definition at line 174 of file Wsdl.php.

Here is the caller graph for this function:

getSchema ( )

Return the Schema node of the WSDL

Returns:
DOMElement

Definition at line 484 of file Wsdl.php.

Here is the call graph for this function:

Here is the caller graph for this function:

getType ( type)

Returns an XSD Type for the given PHP type

Parameters:
string$typePHP Type to get the XSD type for
Returns:
string

Definition at line 534 of file Wsdl.php.

Here is the call graph for this function:

getTypes ( )

Return an array of all currently included complex types

Returns:
array

Definition at line 474 of file Wsdl.php.

Here is the caller graph for this function:

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 142 of file Wsdl.php.

Here is the caller graph for this function:

setUri ( uri)

Set a new uri for this WSDL

Parameters:
string | Zend_Uri_Http$uri
Returns:
Zend_Server_Wsdl

Definition at line 116 of file Wsdl.php.

Return DOM Document

Returns:
object DomDocum ent

Definition at line 508 of file Wsdl.php.

toXML ( )

Return the WSDL as XML

Returns:
string WSDL as XML

Definition at line 498 of file Wsdl.php.

Here is the caller graph for this function:


Field Documentation

$_strategy = null [protected]

Strategy for detection of complex types

Definition at line 70 of file Wsdl.php.


The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Enumerations