Class: wsdl

Source Location: /lodel/scripts/nusoap.php

Class wsdl

Class Overview

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

Located in /lodel/scripts/nusoap.php [line 3227]

nusoap_base
   |
   --wsdl

Author(s):

Dietrich Ayala <dietrich@ganx4.com>

API Tags:

Access:

public

Information Tags:

Version:

$Id: nusoap.php 3705 2006-09-14 16:06:29Z cenou $

Properties

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From nusoap_base

nusoap_base::$charencoding

nusoap_base::$debug_str

nusoap_base::$error_str

nusoap_base::$namespaces

nusoap_base::$revision

nusoap_base::$soap_defencoding

nusoap_base::$title

nusoap_base::$typemap

nusoap_base::$usedNamespaces

nusoap_base::$version

nusoap_base::$xmlEntities

nusoap_base::$XMLSchemaVersion

Inherited From nusoap_base

nusoap_base::appendDebug()

adds debug data to the instance debug string without formatting

nusoap_base::clearDebug()

clears the current debug data for this instance

nusoap_base::contractQname()

contracts a qualified name

nusoap_base::debug()

adds debug data to the instance debug string with formatting

nusoap_base::expandEntities()

expands entities, e.g. changes '<' to '<'.

nusoap_base::expandQname()

expands a qualified name

nusoap_base::formatDump()

nusoap_base::getDebug()

gets the current debug data for this instance

nusoap_base::getDebugAsXMLComment()

gets the current debug data for this instance as an XML comment this may change the contents of the debug data

nusoap_base::getError()

returns error string if present

nusoap_base::getLocalPart()

returns the local part of a prefixed string returns the original string, if not prefixed

nusoap_base::getmicrotime()

returns the time in ODBC canonical form with microseconds

nusoap_base::getNamespaceFromPrefix()

pass it a prefix, it returns a namespace returns false if no namespace registered with the given prefix

nusoap_base::getPrefix()

returns the prefix part of a prefixed string returns false, if not prefixed

nusoap_base::getPrefixFromNamespace()

returns the prefix for a given namespace (or prefix) or false if no prefixes registered for the given namespace

nusoap_base::isArraySimpleOrStruct()

detect if array is a simple array or a struct (associative array)

nusoap_base::serializeEnvelope()

serialize message

nusoap_base::serialize_val()

serializes PHP values in accordance w/ section 5. Type information is not serialized if $use == 'literal'.

nusoap_base::setError()

sets error string

nusoap_base::varDump()

[ Top ]

Property Summary

mixed	$bindings
mixed	$complexTypes
mixed	$currentBinding
mixed	$currentMessage
mixed	$currentOperation
mixed	$currentPort
mixed	$currentPortType
mixed	$currentSchema
mixed	$depth
mixed	$depth_array
mixed	$documentation
mixed	$endpoint
mixed	$import
mixed	$message
mixed	$messages
mixed	$opData
mixed	$parser
mixed	$ports
mixed	$portTypes
mixed	$position
mixed	$proxyhost
mixed	$proxypassword
mixed	$proxyport
mixed	$proxyusername
mixed	$response_timeout
mixed	$schemas
mixed	$status
mixed	$timeout
mixed	$wsdl

[ Top ]

Method Summary

wsdl	wsdl()	constructor
void	addComplexType()	adds an XML Schema complex type to the WSDL types
void	addOperation()	register a service with the server
void	addSimpleType()	adds an XML Schema simple type to the WSDL types
void	character_data()	element content handler
void	end_element()	end-element handler
void	getBindingData()
array	getOperationData()	returns an associative array of data necessary for calling an operation
array	getOperations()	returns an assoc array of operation names => operation data
mixed	getTypeDef()	returns an array of information about a given type returns false if no type exists by the given name
void	parseWSDL()	parses the wsdl document
string	serialize()	serialize the parsed wsdl
mixed	serializeParameters()	serialize a PHP value according to a WSDL message definition
mixed	serializeRPCParameters()	serialize a PHP value according to a WSDL message definition
string	serializeType()	serializes a PHP value according a given type definition
void	start_element()	start-element handler
void	webDescription()	prints html description of services

[ Top ]

Properties

mixed $bindings = array() [line 3240]

[ Top ]

mixed $complexTypes = array() [line 3234]

[ Top ]

mixed $currentBinding [line 3241]

[ Top ]

mixed $currentMessage [line 3236]

[ Top ]

mixed $currentOperation [line 3237]

[ Top ]

mixed $currentPort [line 3243]

[ Top ]

mixed $currentPortType [line 3239]

[ Top ]

mixed $currentSchema [line 3232]

[ Top ]

mixed $depth = 0 [line 3253]

[ Top ]

mixed $depth_array = array() [line 3254]

[ Top ]

mixed $documentation = false [line 3246]

[ Top ]

mixed $endpoint = '' [line 3247]

[ Top ]

mixed $import = array() [line 3249]

[ Top ]

mixed $message = array() [line 3233]

[ Top ]

mixed $messages = array() [line 3235]

[ Top ]

mixed $opData = array() [line 3244]

[ Top ]

mixed $parser [line 3251]

[ Top ]

mixed $ports = array() [line 3242]

[ Top ]

mixed $portTypes = array() [line 3238]

[ Top ]

mixed $position = 0 [line 3252]

[ Top ]

mixed $proxyhost = '' [line 3256]

[ Top ]

mixed $proxypassword = '' [line 3259]

[ Top ]

mixed $proxyport = '' [line 3257]

[ Top ]

mixed $proxyusername = '' [line 3258]

[ Top ]

mixed $response_timeout = 30 [line 3261]

[ Top ]

mixed $schemas = array() [line 3231]

[ Top ]

mixed $status = '' [line 3245]

[ Top ]

mixed $timeout = 0 [line 3260]

[ Top ]

mixed $wsdl [line 3229]

[ Top ]

Methods

Constructor wsdl [line 3275]

wsdl wsdl(
[string
$wsdl = ''], [string
$proxyhost = false], [string
$proxyport = false], [string
$proxyusername = false], [string
$proxypassword = false], [integer
$timeout = 0], [integer
$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

API Tags:

Access:

public

[ Top ]

addComplexType [line 4539]

void addComplexType(
name
$name, [typeClass
$typeClass = 'complexType'], [phpType:
$phpType = 'array'], [compositor
$compositor = ''], [restrictionBase
$restrictionBase = ''], [elements
$elements = array()], [attrs
$attrs = array()], [arrayType:
$arrayType = ''] 
)

adds an XML Schema complex type to the WSDL types

Parameters:

name	$name:
typeClass	$typeClass:	(complexType\|simpleType\|attribute)
phpType:	$phpType:	currently supported are array and struct (php assoc array)
compositor	$compositor:	(all\|sequence\|choice)
restrictionBase	$restrictionBase:	namespace:name (http://schemas.xmlsoap.org/soap/encoding/:Array)
elements	$elements:	= array ( name = array(name=>'',type=>'') )
attrs	$attrs:	= array( array( 'ref' => "http://schemas.xmlsoap.org/soap/encoding/:arrayType", "http://schemas.xmlsoap.org/wsdl/:arrayType" => "string[]" ) )
arrayType:	$arrayType:	namespace:name (http://www.w3.org/2001/XMLSchema:string)

API Tags:

See:

xmlschema

[ Top ]

addOperation [line 4603]

void addOperation(

$name, [string
$in = false], [string
$out = false], [string
$namespace = false], [string
$soapaction = false], [string
$style = 'rpc'], [string
$use = 'encoded'], [string
$documentation = ''], string
$methodname 
)

register a service with the server

Parameters:

string	$methodname:
string	$in:	assoc array of input values: key = param name, value = param type
string	$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
string	$use:	(encoded\|literal) optional The use for the parameters (cannot mix right now)
string	$documentation:	optional The description to include in the WSDL
	$name:

API Tags:

Access:

public

[ Top ]

addSimpleType [line 4583]

void addSimpleType(
name
$name, [restrictionBase
$restrictionBase = ''], [typeClass
$typeClass = 'simpleType'], [phpType:
$phpType = 'scalar'] 
)

adds an XML Schema simple type to the WSDL types

Parameters:

name	$name:
restrictionBase	$restrictionBase:	namespace:name (http://schemas.xmlsoap.org/soap/encoding/:Array)
typeClass	$typeClass:	(simpleType)
phpType:	$phpType:	(scalar)

API Tags:

See:

xmlschema

[ Top ]

character_data [line 3721]

void character_data(
string
$parser, string
$data 
)

element content handler

Parameters:

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

API Tags:

Access:

private

[ Top ]

end_element [line 3693]

void end_element(
string
$parser, string
$name 
)

end-element handler

Parameters:

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

API Tags:

Access:

private

[ Top ]

getBindingData [line 3732]

void getBindingData(

$binding 
)

Parameters:

$binding:

[ Top ]

getOperationData [line 3776]

array getOperationData(
string
$operation, [string
$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

API Tags:

Access:

public

[ Top ]

getOperations [line 3746]

array getOperations(
[string
$bindingType = 'soap'] 
)

returns an assoc array of operation names => operation data

Parameters:

string

$bindingType:

eg: soap, smtp, dime (only soap is currently supported)

API Tags:

Access:

public

[ Top ]

getTypeDef [line 3815]

mixed getTypeDef(
$type
$type, $ns
$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	$type:	string
$ns	$ns:	string

API Tags:

See:	xmlschema
Access:	public

[ Top ]

parseWSDL [line 3384]

void parseWSDL(
[string
$wsdl = ''] 
)

parses the wsdl document

Parameters:

string

$wsdl:

path or URL

API Tags:

Access:

private

[ Top ]

serialize [line 3965]

string serialize(
[$debug
$debug = 0] 
)

serialize the parsed wsdl

Parameters:

$debug

$debug:

mixed whether to put debug=1 in endpoint URL

API Tags:

Return:	, serialization of WSDL
Access:	public

[ Top ]

serializeParameters [line 4170]

mixed serializeParameters(

$operation, 
$direction, 
$parameters, mixed
$ 
)

serialize a PHP value according to a WSDL message definition

TODO

multi-ref serialization
validate PHP values against type definitions, return errors if invalid

Parameters:

mixed	$:	param value
	$operation:
	$direction:
	$parameters:

API Tags:

Return:

new param or false if initial value didn't validate

[ Top ]

serializeRPCParameters [line 4094]

mixed serializeRPCParameters(

$operation, 
$direction, 
$parameters, mixed
$ 
)

serialize a PHP value according to a WSDL message definition

TODO

multi-ref serialization
validate PHP values against type definitions, return errors if invalid

Parameters:

mixed	$:	param value
	$operation:
	$direction:
	$parameters:

API Tags:

Return:

new param or false if initial value didn't validate

[ Top ]

serializeType [line 4247]

string serializeType(
string
$name, string
$type, mixed
$value, [string
$use = 'encoded'], [string
$encodingStyle = false] 
)

serializes a PHP value according a given type definition

Parameters:

string	$name:	, name of type (part)
string	$type:	, type of type, heh (type or element)
mixed	$value:	, a native PHP value (parameter value)
string	$use:	, use for part (encoded\|literal)
string	$encodingStyle:	, use to add encoding changes to serialisation

API Tags:

Return:	serialization
Access:	public

[ Top ]

start_element [line 3484]

void start_element(
string
$parser, string
$name, string
$attrs 
)

start-element handler

Parameters:

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

API Tags:

Access:

private

[ Top ]

webDescription [line 3842]

void webDescription(
)

prints html description of services

API Tags:

Access:

private

[ Top ]

Documentation generated on Wed, 19 Sep 2007 05:07:19 +0200 by phpDocumentor 1.4.0a2

	default

[ class tree: default ] [ index: default ] [ all elements ]