Soap/Wsdl.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Soap
version: $Id: Wsdl.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Soap_Wsdl

Description

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.

Zend_Soap_Wsdl
jump to top

category: Zend
package: Zend_Soap
Properties: $_dom; $_wsdl; $_uri; $_schema; $_includedTypes; $_strategy
Methods: __construct; setUri; setComplexTypeStrategy; getComplexTypeStrategy; addMessage; addPortType; addPortOperation; addBinding; addBindingOperation; addSoapBinding; addSoapOperation; addService; addDocumentation; addTypes; addType; getTypes; getSchema; toXML; toDomDocument; dump; getType; addSchemaTypeSection; addComplexType; _parseElement; addElement

Description

Zend_Soap_Wsdl

Properties

$_dom
jump to class

object $_dom = ''

Details

$_dom: object
DomDocument Instance
visibility: private
default
final: false
static: false

$_includedTypes
jump to class

array $_includedTypes = 'array'

Types defined on schema

Details

$_includedTypes: array
visibility: private
default: array
final: false
static: false

$_schema
jump to class

DOMElement $_schema = 'null'

Details

$_schema: DOMElement
visibility: private
default: null
final: false
static: false

$_strategy
jump to class

$_strategy = 'null'

Strategy for detection of complex types

Details

visibility: protected
default: null
final: false
static: false

$_uri
jump to class

string $_uri = ''

Details

$_uri: string
URI where the WSDL will be available
visibility: private
default
final: false
static: false

$_wsdl
jump to class

object $_wsdl = ''

Details

$_wsdl: object
WSDL Root XML_Tree_Node
visibility: private
default
final: false
static: false

Methods

__construct
jump to class

__construct(
          string $name, string $uri, boolean|string|Zend_Soap_Wsdl_Strategy_Interface $strategy
              =
              true
          )
        
        :

Constructor

Arguments

$name: string
Name of the Web Service being Described
$uri: string
URI where the WSDL will be available
$strategy: booleanstringZend_Soap_Wsdl_Strategy_Interface

Details

visibility: public
final: false
static: false

_parseElement
jump to class

_parseElement(
          array $element
          )
        
        :
        DOMElement

Parse an xsd:element represented as an array into a DOMElement.

Arguments

$element: array
an xsd:element represented as an array

Output

DOMElement: parsed element

Details

visibility: private
final: false
static: false

addBinding
jump to class

addBinding(
          string $name,  $portType
          )
        
        :
        object

Add a {@link http://www.w3.org/TR/wsdl#_bindings binding} element to WSDL

Arguments

$name: string
Name of the Binding
$portType

Output

object: The new binding's XML_Tree_Node for use with {@link function addBindingOperation} and {@link function addDocumentation}

Details

visibility: public
final: false
static: false

addBindingOperation
jump to class

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

Add an operation to a binding element

Arguments

$binding: object
A binding XML_Tree_Node returned by {@link function addBinding}
$name
$input: array
An array of attributes for the input element, allowed keys are: 'use', 'namespace', 'encodingStyle'. {@link http://www.w3.org/TR/wsdl#_soap:body More Information}
$output: array
An array of attributes for the output element, allowed keys are: 'use', 'namespace', 'encodingStyle'. {@link http://www.w3.org/TR/wsdl#_soap:body More Information}
$fault: array
An array of attributes for the fault element, allowed keys are: 'name', 'use', 'namespace', 'encodingStyle'. {@link http://www.w3.org/TR/wsdl#_soap:body More Information}

Output

object: The new Operation's XML_Tree_Node for use with {@link function addSoapOperation} and {@link function addDocumentation}

Details

visibility: public
final: false
static: false

addComplexType
jump to class

addComplexType(
          string $type
          )
        
        :
        string

Add a {@link http://www.w3.org/TR/wsdl#_types types} data type definition

Arguments

$type: string
Name of the class to be specified

Output

string: XSD Type for the given PHP type

Details

visibility: public
final: false
static: false

addDocumentation
jump to class

addDocumentation(
          object $input_node, string $documentation
          )
        
        :
        DOMElement

Add a documentation element to any element in the WSDL.

Note that the WSDL {@link http://www.w3.org/TR/wsdl#_documentation specification} uses 'document', but the WSDL {@link http://schemas.xmlsoap.org/wsdl/ schema} uses 'documentation' instead. The {@link http://www.ws-i.org/Profiles/BasicProfile-1.1-2004-08-24.html#WSDL_documentation_Element WS-I Basic Profile 1.1} recommends using 'documentation'.

Arguments

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

Output

DOMElement: The documentation element

Details

visibility: public
final: false
static: false

addElement
jump to class

addElement(
          array $element
          )
        
        :
        string

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:

Arguments

$element: array
an xsd:element represented as an array

Output

string: xsd:element for the given element array

Details

visibility: public
final: false
static: false

addMessage
jump to class

addMessage(
          string $name, array $parts
          )
        
        :
        object

Add a {@link http://www.w3.org/TR/wsdl#_messages message} element to the WSDL

Arguments

$name: string
Name for the {@link http://www.w3.org/TR/wsdl#_messages message}
$parts: array
An array of {@link http://www.w3.org/TR/wsdl#_message 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')

Output

object: The new message's XML_Tree_Node for use in {@link function addDocumentation}

Details

visibility: public
final: false
static: false

addPortOperation
jump to class

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

Add an {@link http://www.w3.org/TR/wsdl#_request-response operation} element to a portType element

Arguments

$portType: object
a portType XML_Tree_Node, from {@link function addPortType}
$name: string
Operation name
$input: string
Input Message
$output: string
Output Message
$fault: string
Fault Message

Output

object: The new operation's XML_Tree_Node for use in {@link function addDocumentation}

Details

visibility: public
final: false
static: false

addPortType
jump to class

addPortType(
          string $name
          )
        
        :
        object

Add a {@link http://www.w3.org/TR/wsdl#_porttypes portType} element to the WSDL

Arguments

$name: string
portType element's name

Output

object: The new portType's XML_Tree_Node for use in {@link function addPortOperation} and {@link function addDocumentation}

Details

visibility: public
final: false
static: false

addSchemaTypeSection
jump to class

addSchemaTypeSection(
          
          )
        
        :
        Zend_Soap_Wsdl

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

Output

Zend_Soap_Wsdl

Details

visibility: public
final: false
static: false

addService
jump to class

addService(
          string $name, string $port_name, string $binding, string $location
          )
        
        :
        object

Add a {@link http://www.w3.org/TR/wsdl#_services service} element to the WSDL

Arguments

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

Output

object: The new service's XML_Tree_Node for use with {@link function addDocumentation}

Details

visibility: public
final: false
static: false

addSoapBinding
jump to class

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

Add a {@link http://www.w3.org/TR/wsdl#_soap:binding SOAP binding} element to a Binding element

Arguments

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

Output

boolean

Details

visibility: public
final: false
static: false

addSoapOperation
jump to class

addSoapOperation(
           $binding, string $soap_action
          )
        
        :
        boolean

Add a {@link http://www.w3.org/TR/wsdl#_soap:operation SOAP operation} to an operation element

Arguments

$binding
$soap_action: string
SOAP Action

Output

boolean

Details

visibility: public
final: false
static: false

addType
jump to class

addType(
          string $type
          )
        
        :
        Zend_Soap_Wsdl

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

Arguments

$type: string

Output

Zend_Soap_Wsdl

Details

visibility: public
final: false
static: false

addTypes
jump to class

addTypes(
          object $types
          )
        
        :

Add WSDL Types element

Arguments

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

Details

visibility: public
final: false
static: false

dump
jump to class

dump(
           $filename
              =
              false
          )
        
        :
        boolean

Echo the WSDL as XML

Arguments

$filename

Output

boolean

Details

visibility: public
final: false
static: false

getComplexTypeStrategy
jump to class

getComplexTypeStrategy(
          
          )
        
        :
        Zend_Soap_Wsdl_Strategy_Interface

Get the current complex type strategy

Output

Zend_Soap_Wsdl_Strategy_Interface

Details

visibility: public
final: false
static: false

getSchema
jump to class

getSchema(
          
          )
        
        :
        DOMElement

Return the Schema node of the WSDL

Output

DOMElement

Details

visibility: public
final: false
static: false

getType
jump to class

getType(
          string $type
          )
        
        :
        string

Returns an XSD Type for the given PHP type

Arguments

$type: string
PHP Type to get the XSD type for

Output

string

Details

visibility: public
final: false
static: false

getTypes
jump to class

getTypes(
          
          )
        
        :
        array

Return an array of all currently included complex types

Output

array

Details

visibility: public
final: false
static: false

setComplexTypeStrategy
jump to class

setComplexTypeStrategy(
          boolean|string|Zend_Soap_Wsdl_Strategy_Interface $strategy
          )
        
        :
        Zend_Soap_Wsdl

Set a strategy for complex type detection and handling

Arguments

$strategy: booleanstringZend_Soap_Wsdl_Strategy_Interface

Output

Zend_Soap_Wsdl

Details

visibility: public
final: false
static: false
todo: Boolean is for backwards compability with extractComplexType object var. Remove it in later versions.

setUri
jump to class

setUri(
          string|Zend_Uri_Http $uri
          )
        
        :
        Zend_Server_Wsdl

Set a new uri for this WSDL

Arguments

$uri: stringZend_Uri_Http

Output

Zend_Server_Wsdl

Details

visibility: public
final: false
static: false

toDomDocument
jump to class

toDomDocument(
          
          )
        
        :
        object

Return DOM Document

Output

object: DomDocum ent

Details

visibility: public
final: false
static: false

toXML
jump to class

toXML(
          
          )
        
        :
        string

Return the WSDL as XML

Output

string: WSDL as XML

Details

visibility: public
final: false
static: false

API Documentation

Soap/Wsdl.php

Description

Zend_Soap_Wsdljump to top

Description

Properties

$_domjump to class

Details

$_includedTypesjump to class

Details

$_schemajump to class

Details

$_strategyjump to class

Details

$_urijump to class

Details

$_wsdljump to class

Details

Methods

__constructjump to class

Arguments

Details

_parseElementjump to class

Arguments

Output

Details

addBindingjump to class

Arguments

Output

Details

addBindingOperationjump to class

Arguments

Output

Details

addComplexTypejump to class

Arguments

Output

Details

addDocumentationjump to class

Arguments

Output

Details

addElementjump to class

Arguments

Output

Details

addMessagejump to class

Arguments

Output

Details

addPortOperationjump to class

Arguments

Output

Details

addPortTypejump to class

Arguments

Output

Details

addSchemaTypeSectionjump to class

Output

Details

addServicejump to class

Arguments

Output

Details

addSoapBindingjump to class

Arguments

Output

Details

addSoapOperationjump to class

Arguments

Output

Details

addTypejump to class

Arguments

Output

Details

addTypesjump to class

Arguments

Details

Zend_Soap_Wsdl
jump to top

$_dom
jump to class

$_includedTypes
jump to class

$_schema
jump to class

$_strategy
jump to class

$_uri
jump to class

$_wsdl
jump to class

__construct
jump to class

_parseElement
jump to class

addBinding
jump to class

addBindingOperation
jump to class

addComplexType
jump to class

addDocumentation
jump to class

addElement
jump to class

addMessage
jump to class

addPortOperation
jump to class

addPortType
jump to class

addSchemaTypeSection
jump to class

addService
jump to class

addSoapBinding
jump to class

addSoapOperation
jump to class

addType
jump to class

addTypes
jump to class

dump
jump to class

getComplexTypeStrategy
jump to class

getSchema
jump to class

getType
jump to class

getTypes
jump to class

setComplexTypeStrategy
jump to class

setUri
jump to class

toDomDocument
jump to class

toXML
jump to class