Class: wsdl

nusoap_base::nusoap_base(): constructor
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::formatDump(): formats a string to be inserted into an HTML stream
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::getDebugLevel(): gets the debug level for this instance
nusoap_base::getError(): returns error string if present
nusoap_base::getGlobalDebugLevel(): gets the global debug level, which applies to future instances
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
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::serializeEnvelope(): serializes a message
nusoap_base::serialize_val(): serializes PHP values in accordance w/ section 5. Type information is not serialized if $use == 'literal'.
nusoap_base::setDebugLevel(): sets the debug level for this instance
nusoap_base::setGlobalDebugLevel(): sets the global debug level, which applies to future instances
nusoap_base::varDump(): Returns a string with the output of var_dump
nusoap_base::__toString(): represents the object as a string

Class Details

[line 4494]
parses a WSDL file, allows access to it's data, other utility methods.

also builds WSDL structures programmatically.

Tags:

author:	Scott Nichol <snichol@users.sourceforge.net>
author:	Dietrich Ayala <dietrich@ganx4.com>
version:	$Id$
access:	public

[ Top ]

Class Variables

$authtype = ''

[line 4534]

Type:

mixed

[ Top ]

$bindings = array()

[line 4507]

Type:

mixed

[ Top ]

$certRequest = array()

[line 4535]

Type:

mixed

[ Top ]

$complexTypes = array()

[line 4501]

Type:

mixed

[ Top ]

$curl_options = array()

[line 4529]

Type:

mixed

[ Top ]

$currentBinding =

[line 4508]

Type:

mixed

[ Top ]

$currentMessage =

[line 4503]

Type:

mixed

[ Top ]

$currentOperation =

[line 4504]

Type:

mixed

[ Top ]

$currentPort =

[line 4510]

Type:

mixed

[ Top ]

$currentPortType =

[line 4506]

Type:

mixed

[ Top ]

$currentSchema =

[line 4499]

Type:

mixed

[ Top ]

$depth = 0

[line 4520]

Type:

mixed

[ Top ]

$depth_array = array()

[line 4521]

Type:

mixed

[ Top ]

$documentation = false

[line 4513]

Type:

mixed

[ Top ]

$endpoint = ''

[line 4514]

Type:

mixed

[ Top ]

$import = array()

[line 4516]

Type:

mixed

[ Top ]

$message = array()

[line 4500]

Type:

mixed

[ Top ]

$messages = array()

[line 4502]

Type:

mixed

[ Top ]

$opData = array()

[line 4511]

Type:

mixed

[ Top ]

$parser =

[line 4518]

Type:

mixed

[ Top ]

$password = ''

[line 4533]

Type:

mixed

[ Top ]

$ports = array()

[line 4509]

Type:

mixed

[ Top ]

$portTypes = array()

[line 4505]

Type:

mixed

[ Top ]

$position = 0

[line 4519]

Type:

mixed

[ Top ]

$proxyhost = ''

[line 4523]

Type:

mixed

[ Top ]

$proxypassword = ''

[line 4526]

Type:

mixed

[ Top ]

$proxyport = ''

[line 4524]

Type:

mixed

[ Top ]

$proxyusername = ''

[line 4525]

Type:

mixed

[ Top ]

$response_timeout = 30

[line 4528]

Type:

mixed

[ Top ]

$schemas = array()

[line 4498]

Type:

mixed

[ Top ]

$status = ''

[line 4512]

Type:

mixed

[ Top ]

$timeout = 0

[line 4527]

Type:

mixed

[ Top ]

$username = ''

[line 4532]

Type:

mixed

[ Top ]

$use_curl = false

[line 4530]

Type:

mixed

[ Top ]

$wsdl =

[line 4496]

Type:

mixed

[ Top ]

Class Methods

constructor wsdl [line 4551]

wsdl wsdl(
[string
$wsdl = ''], [string
$proxyhost = false], [string
$proxyport = false], [string
$proxyusername = false], [string
$proxypassword = false], [integer
$timeout = 0], [integer
$response_timeout = 30], [array
$curl_options = null], [boolean
$use_curl = false])

constructor

Tags:

access:

public

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
array	$curl_options	user-specified cURL options
boolean	$use_curl	try to use cURL

[ Top ]

method addComplexType [line 6227]

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

adds an XML Schema complex type to the WSDL types

Tags:

see:	nusoap_xmlschema
access:	public

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	e.g. array ( name => array(name=>'',type=>'') )
array	$attrs	e.g. array(array('ref'=>'SOAP-ENC:arrayType','wsdl:arrayType'=>'xsd:string[]'))
string	$arrayType	as namespace:name (xsd:string)

[ Top ]

method addElement [line 6288]

void addElement(
array
$attrs)

adds an element to the WSDL types

Tags:

see:	nusoap_xmlschema
access:	public

Parameters:

array

$attrs

attributes that must include name and type

[ Top ]

method addOperation [line 6307]

void addOperation(
string
$name, [array
$in = false], [array
$out = false], [string
$namespace = false], [string
$soapaction = false], [string
$style = 'rpc'], [string
$use = 'encoded'], [string
$documentation = ''], [string
$encodingStyle = ''])

Tags:

access:

public

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)

[ Top ]

method addSimpleType [line 6274]

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

adds an XML Schema simple type to the WSDL types

Tags:

see:	nusoap_xmlschema
access:	public

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

[ Top ]

method fetchWSDL [line 4571]

void fetchWSDL(

$wsdl)

fetches the WSDL document and parses it

Tags:

access:

public

Parameters:

$wsdl

[ Top ]

method getBindingData [line 5050]

void getBindingData(

$binding)

Parameters:

$binding

[ Top ]

method getOperationData [line 5095]

array getOperationData(
string
$operation, [string
$bindingType = 'soap'])

returns an associative array of data necessary for calling an operation

Tags:

access:

public

Parameters:

string	$operation	name of operation
string	$bindingType	type of binding eg: soap, soap12

[ Top ]

method getOperationDataForSoapAction [line 5127]

array getOperationDataForSoapAction(
string
$soapAction, [string
$bindingType = 'soap'])

returns an associative array of data necessary for calling an operation

Tags:

access:

public

Parameters:

string	$soapAction	soapAction for operation
string	$bindingType	type of binding eg: soap, soap12

[ Top ]

method getOperations [line 5064]

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

returns an assoc array of operation names => operation data

Tags:

access:

public

Parameters:

string

$bindingType

eg: soap, smtp, dime (only soap and soap12 are currently supported)

[ Top ]

method getTypeDef [line 5165]

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

Tags:

see:	nusoap_xmlschema
access:	public

Parameters:

string	$type	the type
string	$ns	namespace (not prefix) of the type

[ Top ]

method serialize [line 5354]

string serialize(
[mixed
$debug = 0])

serialize the parsed wsdl

Tags:

return:	serialization of WSDL
access:	public

Parameters:

mixed

$debug

whether to put debug=1 in endpoint URL

[ Top ]

method serializeParameters [line 5680]

mixed serializeParameters(
string
$operation, string
$direction, mixed
$parameters)

serialize a PHP value according to a WSDL message definition

TODO

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

Tags:

return:	parameters serialized as XML or false on error (e.g. operation not found)
deprecated:
access:	public

Parameters:

string	$operation	operation name
string	$direction	(input\|output)
mixed	$parameters	parameter value(s)

[ Top ]

method serializeRPCParameters [line 5586]

mixed serializeRPCParameters(
string
$operation, string
$direction, mixed
$parameters, [string
$bindingType = 'soap'])

serialize PHP values according to a WSDL message definition contrary to the method name, this is not limited to RPC

TODO

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

Tags:

return:	parameters serialized as XML or false on error (e.g. operation not found)
access:	public

Parameters:

string	$operation	operation name
string	$direction	(input\|output)
mixed	$parameters	parameter value(s)
string	$bindingType	(soap\|soap12)

[ Top ]

method setCredentials [line 5041]

void setCredentials(
string
$username, string
$password, [string
$authtype = 'basic'], [array
$certRequest = array()])

if authenticating, set user credentials here

Tags:

access:

public

Parameters:

string	$username
string	$password
string	$authtype	(basic\|digest\|certificate\|ntlm)
array	$certRequest	(keys must be cainfofile (optional), sslcertfile, sslkeyfile, passphrase, certpassword (optional), verifypeer (optional), verifyhost (optional): see corresponding options in cURL docs)

[ Top ]

Documentation generated on Thu, 12 Feb 2009 08:00:03 +0900 by phpDocumentor 1.4.2