Documentation TYPO3 par Ameos

wsdl Class Reference

Inheritance diagram for wsdl:
[legend]
Collaboration diagram for wsdl:
[legend]
List of all members.

Public Member Functions

 wsdl ($wsdl= '', $proxyhost=false, $proxyport=false, $proxyusername=false, $proxypassword=false, $timeout=0, $response_timeout=30)
 parseWSDL ($wsdl= '')
 start_element ($parser, $name, $attrs)
 end_element ($parser, $name)
 character_data ($parser, $data)
 getBindingData ($binding)
 getOperations ($bindingType= 'soap')
 getOperationData ($operation, $bindingType= 'soap')
 getOperationDataForSoapAction ($soapAction, $bindingType= 'soap')
 getTypeDef ($type, $ns)
 webDescription ()
 serialize ($debug=0)
 serializeRPCParameters ($operation, $direction, $parameters)
 serializeParameters ($operation, $direction, $parameters)
 serializeType ($name, $type, $value, $use='encoded', $encodingStyle=false, $unqualified=false)
 serializeComplexTypeAttributes ($typeDef, $value, $ns, $uqType)
 serializeComplexTypeElements ($typeDef, $value, $ns, $uqType, $use='encoded', $encodingStyle=false)
 addComplexType ($name, $typeClass='complexType', $phpType='array', $compositor='', $restrictionBase='', $elements=array(), $attrs=array(), $arrayType='')
 addSimpleType ($name, $restrictionBase='', $typeClass='simpleType', $phpType='scalar', $enumeration=array())
 addElement ($attrs)
 addOperation ($name, $in=false, $out=false, $namespace=false, $soapaction=false, $style= 'rpc', $use= 'encoded', $documentation= '', $encodingStyle= '')

Public Attributes

 $wsdl
 $schemas = array()
 $currentSchema
 $message = array()
 $complexTypes = array()
 $messages = array()
 $currentMessage
 $currentOperation
 $portTypes = array()
 $currentPortType
 $bindings = array()
 $currentBinding
 $ports = array()
 $currentPort
 $opData = array()
 $status = ''
 $documentation = false
 $endpoint = ''
 $import = array()
 $parser
 $position = 0
 $depth = 0
 $depth_array = array()
 $proxyhost = ''
 $proxyport = ''
 $proxyusername = ''
 $proxypassword = ''
 $timeout = 0
 $response_timeout = 30

Detailed Description

parses a WSDL file, allows access to it's data, other utility methods

Author:
Dietrich Ayala <dietrich@ganx4.com>
Version:
Id
class.nusoap.php 1421 2006-04-10 09:27:15Z mundaun
public

Definition at line 3021 of file class.nusoap.php.


Member Function Documentation

wsdl::wsdl ( wsdl = '',
proxyhost = false,
proxyport = false,
proxyusername = false,
proxypassword = false,
timeout = 0,
response_timeout = 30 
)

constructor

Parameters:
string $wsdl WSDL document URL
string $proxyhost
string $proxyport
string $proxyusername
string $proxypassword
integer $timeout set the connection timeout
integer $response_timeout set the response timeout public

Definition at line 3069 of file class.nusoap.php.

References $proxyhost, $proxypassword, $proxyport, $proxyusername, $response_timeout, $timeout, $wsdl, nusoap_base::debug(), and parseWSDL().

wsdl::parseWSDL ( wsdl = ''  ) 

parses the wsdl document

Parameters:
string $wsdl path or URL private

Definition at line 3179 of file class.nusoap.php.

References $wsdl, nusoap_base::appendDebug(), character_data(), nusoap_base::debug(), end_element(), nusoap_base::getDebug(), nusoap_base::getError(), nusoap_base::setError(), and start_element().

Referenced by wsdl().

wsdl::start_element ( parser,
name,
attrs 
)

start-element handler

Parameters:
string $parser XML parser object
string $name element name
string $attrs associative array of attributes private

Definition at line 3279 of file class.nusoap.php.

References $depth, $parser, nusoap_base::appendDebug(), nusoap_base::debug(), nusoap_base::expandQname(), nusoap_base::getLocalPart(), and nusoap_base::getPrefixFromNamespace().

Referenced by parseWSDL().

wsdl::end_element ( parser,
name 
)

end-element handler

Parameters:
string $parser XML parser object
string $name element name private

Definition at line 3492 of file class.nusoap.php.

Referenced by parseWSDL().

wsdl::character_data ( parser,
data 
)

element content handler

Parameters:
string $parser XML parser object
string $data element content private

Definition at line 3522 of file class.nusoap.php.

Referenced by parseWSDL().

wsdl::getOperations ( bindingType = 'soap'  ) 

returns an assoc array of operation names => operation data

Parameters:
string $bindingType eg: soap, smtp, dime (only soap is currently supported)
Returns:
array public

Definition at line 3547 of file class.nusoap.php.

wsdl::getOperationData ( operation,
bindingType = 'soap' 
)

returns an associative array of data necessary for calling an operation

Parameters:
string $operation , name of operation
string $bindingType , type of binding eg: soap
Returns:
array public

Definition at line 3577 of file class.nusoap.php.

wsdl::getOperationDataForSoapAction ( soapAction,
bindingType = 'soap' 
)

returns an associative array of data necessary for calling an operation

Parameters:
string $soapAction soapAction for operation
string $bindingType type of binding eg: soap
Returns:
array public

Definition at line 3607 of file class.nusoap.php.

wsdl::getTypeDef ( type,
ns 
)

returns an array of information about a given type returns false if no type exists by the given name

typeDef = array( 'elements' => array(), // refs to elements array 'restrictionBase' => '', 'phpType' => '', 'order' => '(sequence|all)', 'attrs' => array() // refs to attributes array )

Parameters:
$type string the type
$ns string namespace (not prefix) of the type
Returns:
mixed public
See also:
xmlschema

Definition at line 3643 of file class.nusoap.php.

wsdl::webDescription (  ) 

prints html description of services

private

Definition at line 3690 of file class.nusoap.php.

wsdl::serialize ( debug = 0  ) 

serialize the parsed wsdl

Parameters:
mixed $debug whether to put debug=1 in endpoint URL
Returns:
string serialization of WSDL public

Definition at line 3823 of file class.nusoap.php.

wsdl::serializeRPCParameters ( operation,
direction,
parameters 
)

serialize PHP values according to a WSDL message definition

TODO

Parameters:
string $operation operation name
string $direction (input|output)
mixed $parameters parameter value(s)
Returns:
mixed parameters serialized as XML or false on error (e.g. operation not found) public

Definition at line 3962 of file class.nusoap.php.

wsdl::serializeParameters ( operation,
direction,
parameters 
)

serialize a PHP value according to a WSDL message definition

TODO

Parameters:
string $ type name
mixed $ param value
Returns:
mixed new param or false if initial value didn't validate public
Deprecated:

Definition at line 4041 of file class.nusoap.php.

wsdl::serializeType ( name,
type,
value,
use = 'encoded',
encodingStyle = false,
unqualified = false 
)

serializes a PHP value according a given type definition

Parameters:
string $name name of value (part or element)
string $type XML schema type of value (type or element)
mixed $value a native PHP value (parameter value)
string $use use for part (encoded|literal)
string $encodingStyle SOAP encoding style for the value (if different than the enclosing style)
boolean $unqualified a kludge for what should be XML namespace form handling
Returns:
string value serialized as an XML string private

Definition at line 4120 of file class.nusoap.php.

wsdl::serializeComplexTypeAttributes ( typeDef,
value,
ns,
uqType 
)

serializes the attributes for a complexType

Parameters:
array $typeDef our internal representation of an XML schema type (or element)
mixed $value a native PHP value (parameter value)
string $ns the namespace of the type
string $uqType the local part of the type
Returns:
string value serialized as an XML string private

Definition at line 4417 of file class.nusoap.php.

wsdl::serializeComplexTypeElements ( typeDef,
value,
ns,
uqType,
use = 'encoded',
encodingStyle = false 
)

serializes the elements for a complexType

Parameters:
array $typeDef our internal representation of an XML schema type (or element)
mixed $value a native PHP value (parameter value)
string $ns the namespace of the type
string $uqType the local part of the type
string $use use for part (encoded|literal)
string $encodingStyle SOAP encoding style for the value (if different than the enclosing style)
Returns:
string value serialized as an XML string private

Definition at line 4479 of file class.nusoap.php.

wsdl::addComplexType ( name,
typeClass = 'complexType',
phpType = 'array',
compositor = '',
restrictionBase = '',
elements = array(),
attrs = array(),
arrayType = '' 
)

adds an XML Schema complex type to the WSDL types

Parameters:
string name
string typeClass (complexType|simpleType|attribute)
string phpType: currently supported are array and struct (php assoc array)
string compositor (all|sequence|choice)
string restrictionBase namespace:name (http://schemas.xmlsoap.org/soap/encoding/:Array)
array elements = array ( name => array(name=>'',type=>'') )
array attrs = array(array('ref'=>'SOAP-ENC:arrayType','wsdl:arrayType'=>'xsd:string[]'))
string arrayType: namespace:name (xsd:string)
See also:
xmlschema public

Definition at line 4581 of file class.nusoap.php.

wsdl::addSimpleType ( name,
restrictionBase = '',
typeClass = 'simpleType',
phpType = 'scalar',
enumeration = array() 
)

adds an XML Schema simple type to the WSDL types

Parameters:
string $name
string $restrictionBase namespace:name (http://schemas.xmlsoap.org/soap/encoding/:Array)
string $typeClass (should always be simpleType)
string $phpType (should always be scalar)
array $enumeration array of values
See also:
xmlschema public

Definition at line 4626 of file class.nusoap.php.

wsdl::addElement ( attrs  ) 

adds an element to the WSDL types

Parameters:
array $attrs attributes that must include name and type
See also:
xmlschema public

Definition at line 4640 of file class.nusoap.php.

wsdl::addOperation ( name,
in = false,
out = false,
namespace = false,
soapaction = false,
style = 'rpc',
use = 'encoded',
documentation = '',
encodingStyle = '' 
)

register an operation with the server

Parameters:
string $name operation (method) name
array $in assoc array of input values: key = param name, value = param type
array $out assoc array of output values: key = param name, value = param type
string $namespace optional The namespace for the operation
string $soapaction optional The soapaction for the operation
string $style (rpc|document) optional The style for the operation Note: when 'document' is specified, parameter and return wrappers are created for you automatically
string $use (encoded|literal) optional The use for the parameters (cannot mix right now)
string $documentation optional The description to include in the WSDL
string $encodingStyle optional (usually 'http://schemas.xmlsoap.org/soap/encoding/' for encoded) public

Definition at line 4659 of file class.nusoap.php.


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


Généré par TYPO3 Ameos avec  doxygen 1.4.6