wsdl Class Reference

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

Inheritance diagram for wsdl:

Collaboration diagram for wsdl:

Public Member Functions
	__construct ($wsdl='', $proxyhost=false, $proxyport=false, $proxyusername=false, $proxypassword=false, $timeout=0, $response_timeout=30, $curl_options=null, $use_curl=false)
	constructor More...
	fetchWSDL ($wsdl)
	fetches the WSDL document and parses it More...
	parseWSDL ($wsdl='')
	parses the wsdl document More...
	start_element ($parser, $name, $attrs)
	start-element handler More...
	end_element ($parser, $name)
	end-element handler More...
	character_data ($parser, $data)
	element content handler More...
	setCredentials ($username, $password, $authtype='basic', $certRequest=array())
	if authenticating, set user credentials here More...
	getBindingData ($binding)
	getOperations ($bindingType='soap')
	returns an assoc array of operation names => operation data More...
	getOperationData ($operation, $bindingType='soap')
	returns an associative array of data necessary for calling an operation More...
	getOperationDataForSoapAction ($soapAction, $bindingType='soap')
	returns an associative array of data necessary for calling an operation More...
	getTypeDef ($type, $ns)
	returns an array of information about a given type returns false if no type exists by the given name More...
	webDescription ()
	prints html description of services More...
	serialize ($debug=0)
	serialize the parsed wsdl More...
	parametersMatchWrapped ($type, &$parameters)
	determine whether a set of parameters are unwrapped when they are expect to be wrapped, Microsoft-style. More...
	serializeRPCParameters ($operation, $direction, $parameters, $bindingType='soap')
	serialize PHP values according to a WSDL message definition contrary to the method name, this is not limited to RPC More...
	serializeParameters ($operation, $direction, $parameters)
	serialize a PHP value according to a WSDL message definition More...
	serializeType ($name, $type, $value, $use='encoded', $encodingStyle=false, $unqualified=false)
	serializes a PHP value according a given type definition More...
	serializeComplexTypeAttributes ($typeDef, $value, $ns, $uqType)
	serializes the attributes for a complexType More...
	serializeComplexTypeElements ($typeDef, $value, $ns, $uqType, $use='encoded', $encodingStyle=false)
	serializes the elements for a complexType More...
	addComplexType ($name, $typeClass='complexType', $phpType='array', $compositor='', $restrictionBase='', $elements=array(), $attrs=array(), $arrayType='')
	adds an XML Schema complex type to the WSDL types More...
	addSimpleType ($name, $restrictionBase='', $typeClass='simpleType', $phpType='scalar', $enumeration=array())
	adds an XML Schema simple type to the WSDL types More...
	addElement ($attrs)
	adds an element to the WSDL types More...
	addOperation ($name, $in=false, $out=false, $namespace=false, $soapaction=false, $style='rpc', $use='encoded', $documentation='', $encodingStyle='')
	register an operation with the server More...
Public Member Functions inherited from nusoap_base
	__construct ()
	constructor More...
	getGlobalDebugLevel ()
	gets the global debug level, which applies to future instances More...
	setGlobalDebugLevel ($level)
	sets the global debug level, which applies to future instances More...
	getDebugLevel ()
	gets the debug level for this instance More...
	setDebugLevel ($level)
	sets the debug level for this instance More...
	debug ($string)
	adds debug data to the instance debug string with formatting More...
	appendDebug ($string)
	adds debug data to the instance debug string without formatting More...
	clearDebug ()
	clears the current debug data for this instance More...
&	getDebug ()
	gets the current debug data for this instance More...
&	getDebugAsXMLComment ()
	gets the current debug data for this instance as an XML comment this may change the contents of the debug data More...
	expandEntities ($val)
	expands entities, e.g. More...
	getError ()
	returns error string if present More...
	setError ($str)
	sets error string More...
	isArraySimpleOrStruct ($val)
	detect if array is a simple array or a struct (associative array) More...
	serialize_val ($val, $name=false, $type=false, $name_ns=false, $type_ns=false, $attributes=false, $use='encoded', $soapval=false)
	serializes PHP values in accordance w/ section 5. More...
	serializeEnvelope ($body, $headers=false, $namespaces=array(), $style='rpc', $use='encoded', $encodingStyle='http://schemas.xmlsoap.org/soap/encoding/')
	serializes a message More...
	formatDump ($str)
	formats a string to be inserted into an HTML stream More...
	contractQname ($qname)
	contracts (changes namespace to prefix) a qualified name More...
	expandQname ($qname)
	expands (changes prefix to namespace) a qualified name More...
	getLocalPart ($str)
	returns the local part of a prefixed string returns the original string, if not prefixed More...
	getPrefix ($str)
	returns the prefix part of a prefixed string returns false, if not prefixed More...
	getNamespaceFromPrefix ($prefix)
	pass it a prefix, it returns a namespace More...
	getPrefixFromNamespace ($ns)
	returns the prefix for a given namespace (or prefix) or false if no prefixes registered for the given namespace More...
	getmicrotime ()
	returns the time in ODBC canonical form with microseconds More...
	varDump ($data)
	Returns a string with the output of var_dump. More...
	__toString ()
	represents the object as a string More...

Data Fields
	$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
	$curl_options = array()
	$use_curl = false
	$username = ''
	$password = ''
	$authtype = ''
	$certRequest = array()
Data Fields inherited from nusoap_base
	$title = 'NuSOAP'
	$version = '0.7.3'
	$revision = '$Revision$'
	$error_str = ''
	$debug_str = ''
	$charencoding = true
	$debugLevel
	$XMLSchemaVersion = 'http://www.w3.org/2001/XMLSchema'
	$soap_defencoding = 'UTF-8'
	$namespaces
	$usedNamespaces = array()
	$typemap
	$xmlEntities

Detailed Description

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

also builds WSDL structures programmatically.

Author

Dietrich Ayala dietr.nosp@m.ich@.nosp@m.ganx4.nosp@m..com

Scott Nichol snich.nosp@m.ol@u.nosp@m.sers..nosp@m.sour.nosp@m.cefor.nosp@m.ge.n.nosp@m.et

Version

$Id$ @access public

Definition at line 4617 of file nusoap.php.

Constructor & Destructor Documentation

__construct()

wsdl::__construct	(		$wsdl = '',
			$proxyhost = false,
			$proxyport = false,
			$proxyusername = false,
			$proxypassword = false,
			$timeout = 0,
			$response_timeout = 30,
			$curl_options = null,
			$use_curl = false
	)

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

Definition at line 4675 of file nusoap.php.

    {
        parent::__construct();
        $this->debug("ctor wsdl=$wsdl timeout=$timeout response_timeout=$response_timeout");
        $this->proxyhost = $proxyhost;
        $this->proxyport = $proxyport;
        $this->proxyusername = $proxyusername;
        $this->proxypassword = $proxypassword;
        $this->timeout = $timeout;
        $this->response_timeout = $response_timeout;
        if (is_array($curl_options)) {
            $this->curl_options = $curl_options;
        }
        $this->use_curl = $use_curl;
        $this->fetchWSDL($wsdl);
    }

References $curl_options, $proxyhost, $proxypassword, $proxyport, $proxyusername, $response_timeout, $timeout, $use_curl, $wsdl, ILIAS\GlobalScreen\Provider\__construct(), nusoap_base\debug(), and fetchWSDL().

Here is the call graph for this function:

Member Function Documentation

addComplexType()

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	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)

See also

nusoap_xmlschema @access public

Definition at line 6377 of file nusoap.php.

    {
        if (count($elements) > 0) {
            $eElements = array();
            foreach ($elements as $n => $e) {
                // expand each element
                $ee = array();
                foreach ($e as $k => $v) {
                    $k = strpos($k, ':') ? $this->expandQname($k) : $k;
                    $v = strpos($v, ':') ? $this->expandQname($v) : $v;
                    $ee[$k] = $v;
                }
                $eElements[$n] = $ee;
            }
            $elements = $eElements;
        }
 
        if (count($attrs) > 0) {
            foreach ($attrs as $n => $a) {
                // expand each attribute
                foreach ($a as $k => $v) {
                    $k = strpos($k, ':') ? $this->expandQname($k) : $k;
                    $v = strpos($v, ':') ? $this->expandQname($v) : $v;
                    $aa[$k] = $v;
                }
                $eAttrs[$n] = $aa;
            }
            $attrs = $eAttrs;
        }
 
        $restrictionBase = strpos($restrictionBase, ':') ? $this->expandQname($restrictionBase) : $restrictionBase;
        $arrayType = strpos($arrayType, ':') ? $this->expandQname($arrayType) : $arrayType;
 
        $typens = isset($this->namespaces['types']) ? $this->namespaces['types'] : $this->namespaces['tns'];
        $this->schemas[$typens][0]->addComplexType($name, $typeClass, $phpType, $compositor, $restrictionBase, $elements, $attrs, $arrayType);
    }

References Vendor\Package\$a, Vendor\Package\$e, $name, and nusoap_base\expandQname().

Referenced by addOperation().

Here is the call graph for this function:

Here is the caller graph for this function:

addElement()

wsdl::addElement

(

$attrs

)

adds an element to the WSDL types

Parameters

array

$attrs

attributes that must include name and type

See also

nusoap_xmlschema @access public

Definition at line 6440 of file nusoap.php.

    {
        $typens = isset($this->namespaces['types']) ? $this->namespaces['types'] : $this->namespaces['tns'];
        $this->schemas[$typens][0]->addElement($attrs);
    }

Referenced by addOperation().

Here is the caller graph for this function:

addOperation()

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) @access public

Definition at line 6460 of file nusoap.php.

    {
        if ($use == 'encoded' && $encodingStyle == '') {
            $encodingStyle = 'http://schemas.xmlsoap.org/soap/encoding/';
        }
 
        if ($style == 'document') {
            $elements = array();
            foreach ($in as $n => $t) {
                $elements[$n] = array('name' => $n, 'type' => $t);
            }
            $this->addComplexType($name . 'RequestType', 'complexType', 'struct', 'all', '', $elements);
            $this->addElement(array('name' => $name, 'type' => $name . 'RequestType'));
            $in = array('parameters' => 'tns:' . $name . '^');
 
            $elements = array();
            foreach ($out as $n => $t) {
                $elements[$n] = array('name' => $n, 'type' => $t);
            }
            $this->addComplexType($name . 'ResponseType', 'complexType', 'struct', 'all', '', $elements);
            $this->addElement(array('name' => $name . 'Response', 'type' => $name . 'ResponseType', 'form' => 'qualified'));
            $out = array('parameters' => 'tns:' . $name . 'Response' . '^');
        }
 
        // get binding
        $this->bindings[ $this->serviceName . 'Binding' ]['operations'][$name] =
        array(
        'name' => $name,
        'binding' => $this->serviceName . 'Binding',
        'endpoint' => $this->endpoint,
        'soapAction' => $soapaction,
        'style' => $style,
        'input' => array(
            'use' => $use,
            'namespace' => $namespace,
            'encodingStyle' => $encodingStyle,
            'message' => $name . 'Request',
            'parts' => $in),
        'output' => array(
            'use' => $use,
            'namespace' => $namespace,
            'encodingStyle' => $encodingStyle,
            'message' => $name . 'Response',
            'parts' => $out),
        'namespace' => $namespace,
        'transport' => 'http://schemas.xmlsoap.org/soap/http',
        'documentation' => $documentation);
        // add portTypes
        // add messages
        if ($in) {
            foreach ($in as $pName => $pType) {
                if (strpos($pType, ':')) {
                    $pType = $this->getNamespaceFromPrefix($this->getPrefix($pType)) . ":" . $this->getLocalPart($pType);
                }
                $this->messages[$name . 'Request'][$pName] = $pType;
            }
        } else {
            $this->messages[$name . 'Request']= '0';
        }
        if ($out) {
            foreach ($out as $pName => $pType) {
                if (strpos($pType, ':')) {
                    $pType = $this->getNamespaceFromPrefix($this->getPrefix($pType)) . ":" . $this->getLocalPart($pType);
                }
                $this->messages[$name . 'Response'][$pName] = $pType;
            }
        } else {
            $this->messages[$name . 'Response']= '0';
        }
        return true;
    }

References $documentation, $name, $namespace, $out, addComplexType(), addElement(), nusoap_base\getLocalPart(), nusoap_base\getNamespaceFromPrefix(), and nusoap_base\getPrefix().

Referenced by nusoap_server\register().

Here is the call graph for this function:

Here is the caller graph for this function:

addSimpleType()

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

nusoap_xmlschema @access public

Definition at line 6425 of file nusoap.php.

    {
        $restrictionBase = strpos($restrictionBase, ':') ? $this->expandQname($restrictionBase) : $restrictionBase;
 
        $typens = isset($this->namespaces['types']) ? $this->namespaces['types'] : $this->namespaces['tns'];
        $this->schemas[$typens][0]->addSimpleType($name, $restrictionBase, $typeClass, $phpType, $enumeration);
    }

References $name, and nusoap_base\expandQname().

Here is the call graph for this function:

character_data()

wsdl::character_data	(		$parser,
			$data
	)

element content handler

Parameters

string	$parser	XML parser object
string	$data	element content @access private

Definition at line 5150 of file nusoap.php.

    {
        $pos = isset($this->depth_array[$this->depth]) ? $this->depth_array[$this->depth] : 0;
        if (isset($this->message[$pos]['cdata'])) {
            $this->message[$pos]['cdata'] .= $data;
        }
        if ($this->documentation) {
            $this->documentation .= $data;
        }
    }

References $data, and $depth.

end_element()

wsdl::end_element	(		$parser,
			$name
	)

end-element handler

Parameters

string	$parser	XML parser object
string	$name	element name @access private

Definition at line 5119 of file nusoap.php.

    {
        // unset schema status
        if (/*preg_match('/types$/', $name) ||*/ preg_match('/schema$/', $name)) {
            $this->status = "";
            $this->appendDebug($this->currentSchema->getDebug());
            $this->currentSchema->clearDebug();
            $this->schemas[$this->currentSchema->schemaTargetNamespace][] = $this->currentSchema;
            $this->debug('Parsing WSDL schema done');
        }
        if ($this->status == 'schema') {
            $this->currentSchema->schemaEndElement($parser, $name);
        } else {
            // bring depth down a notch
            $this->depth--;
        }
        // end documentation
        if ($this->documentation) {
            //TODO: track the node to which documentation should be assigned; it can be a part, message, etc.
            //$this->portTypes[$this->currentPortType][$this->currentPortOperation]['documentation'] = $this->documentation;
            $this->documentation = false;
        }
    }

References $currentSchema, $name, $parser, nusoap_base\appendDebug(), and nusoap_base\debug().

Here is the call graph for this function:

fetchWSDL()

wsdl::fetchWSDL

(

$wsdl

)

fetches the WSDL document and parses it

@access public

Definition at line 4697 of file nusoap.php.

    {
        $this->debug("parse and process WSDL path=$wsdl");
        $this->wsdl = $wsdl;
        // parse wsdl file
        if ($this->wsdl != "") {
            $this->parseWSDL($this->wsdl);
        }
        // imports
        // TODO: handle imports more properly, grabbing them in-line and nesting them
        $imported_urls = array();
        $imported = 1;
        while ($imported > 0) {
            $imported = 0;
            // Schema imports
            foreach ($this->schemas as $ns => $list) {
                foreach ($list as $xs) {
                    $wsdlparts = parse_url($this->wsdl);        // this is bogusly simple!
                    foreach ($xs->imports as $ns2 => $list2) {
                        for ($ii = 0; $ii < count($list2); $ii++) {
                            if (! $list2[$ii]['loaded']) {
                                $this->schemas[$ns]->imports[$ns2][$ii]['loaded'] = true;
                                $url = $list2[$ii]['location'];
                                if ($url != '') {
                                    $urlparts = parse_url($url);
                                    if (!isset($urlparts['host'])) {
                                        $url = $wsdlparts['scheme'] . '://' . $wsdlparts['host'] . (isset($wsdlparts['port']) ? ':' . $wsdlparts['port'] : '') .
                                                substr($wsdlparts['path'], 0, strrpos($wsdlparts['path'], '/') + 1) . $urlparts['path'];
                                    }
                                    if (! in_array($url, $imported_urls)) {
                                        $this->parseWSDL($url);
                                        $imported++;
                                        $imported_urls[] = $url;
                                    }
                                } else {
                                    $this->debug("Unexpected scenario: empty URL for unloaded import");
                                }
                            }
                        }
                    }
                }
            }
            // WSDL imports
            $wsdlparts = parse_url($this->wsdl);        // this is bogusly simple!
            foreach ($this->import as $ns => $list) {
                for ($ii = 0; $ii < count($list); $ii++) {
                    if (! $list[$ii]['loaded']) {
                        $this->import[$ns][$ii]['loaded'] = true;
                        $url = $list[$ii]['location'];
                        if ($url != '') {
                            $urlparts = parse_url($url);
                            if (!isset($urlparts['host'])) {
                                $url = $wsdlparts['scheme'] . '://' . $wsdlparts['host'] . (isset($wsdlparts['port']) ? ':' . $wsdlparts['port'] : '') .
                                        substr($wsdlparts['path'], 0, strrpos($wsdlparts['path'], '/') + 1) . $urlparts['path'];
                            }
                            if (! in_array($url, $imported_urls)) {
                                $this->parseWSDL($url);
                                $imported++;
                                $imported_urls[] = $url;
                            }
                        } else {
                            $this->debug("Unexpected scenario: empty URL for unloaded import");
                        }
                    }
                }
            }
        }
        // add new data to operation data
        foreach ($this->bindings as $binding => $bindingData) {
            if (isset($bindingData['operations']) && is_array($bindingData['operations'])) {
                foreach ($bindingData['operations'] as $operation => $data) {
                    $this->debug('post-parse data gathering for ' . $operation);
                    $this->bindings[$binding]['operations'][$operation]['input'] =
                        isset($this->bindings[$binding]['operations'][$operation]['input']) ?
                        array_merge($this->bindings[$binding]['operations'][$operation]['input'], $this->portTypes[ $bindingData['portType'] ][$operation]['input']) :
                        $this->portTypes[ $bindingData['portType'] ][$operation]['input'];
                    $this->bindings[$binding]['operations'][$operation]['output'] =
                        isset($this->bindings[$binding]['operations'][$operation]['output']) ?
                        array_merge($this->bindings[$binding]['operations'][$operation]['output'], $this->portTypes[ $bindingData['portType'] ][$operation]['output']) :
                        $this->portTypes[ $bindingData['portType'] ][$operation]['output'];
                    if (isset($this->messages[ $this->bindings[$binding]['operations'][$operation]['input']['message'] ])) {
                        $this->bindings[$binding]['operations'][$operation]['input']['parts'] = $this->messages[ $this->bindings[$binding]['operations'][$operation]['input']['message'] ];
                    }
                    if (isset($this->messages[ $this->bindings[$binding]['operations'][$operation]['output']['message'] ])) {
                        $this->bindings[$binding]['operations'][$operation]['output']['parts'] = $this->messages[ $this->bindings[$binding]['operations'][$operation]['output']['message'] ];
                    }
                    // Set operation style if necessary, but do not override one already provided
                    if (isset($bindingData['style']) && !isset($this->bindings[$binding]['operations'][$operation]['style'])) {
                        $this->bindings[$binding]['operations'][$operation]['style'] = $bindingData['style'];
                    }
                    $this->bindings[$binding]['operations'][$operation]['transport'] = isset($bindingData['transport']) ? $bindingData['transport'] : '';
                    $this->bindings[$binding]['operations'][$operation]['documentation'] = isset($this->portTypes[ $bindingData['portType'] ][$operation]['documentation']) ? $this->portTypes[ $bindingData['portType'] ][$operation]['documentation'] : '';
                    $this->bindings[$binding]['operations'][$operation]['endpoint'] = isset($bindingData['endpoint']) ? $bindingData['endpoint'] : '';
                }
            }
        }
    }

References $data, $url, $wsdl, nusoap_base\debug(), and parseWSDL().

Referenced by __construct(), and nusoap_client\loadWSDL().

Here is the call graph for this function:

Here is the caller graph for this function:

getBindingData()

wsdl::getBindingData

(

$binding

)

Definition at line 5180 of file nusoap.php.

    {
        if (is_array($this->bindings[$binding])) {
            return $this->bindings[$binding];
        }
    }

getOperationData()

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, soap12

Returns

array @access public

Definition at line 5226 of file nusoap.php.

    {
        if ($bindingType == 'soap') {
            $bindingType = 'http://schemas.xmlsoap.org/wsdl/soap/';
        } elseif ($bindingType == 'soap12') {
            $bindingType = 'http://schemas.xmlsoap.org/wsdl/soap12/';
        }
        // loop thru ports
        foreach ($this->ports as $port => $portData) {
            // binding type of port matches parameter
            if ($portData['bindingType'] == $bindingType) {
                // get binding
                //foreach($this->bindings[ $portData['binding'] ]['operations'] as $bOperation => $opData) {
                foreach (array_keys($this->bindings[ $portData['binding'] ]['operations']) as $bOperation) {
                    // note that we could/should also check the namespace here
                    if ($operation == $bOperation) {
                        $opData = $this->bindings[ $portData['binding'] ]['operations'][$operation];
                        return $opData;
                    }
                }
            }
        }
    }

References $opData.

Referenced by nusoap_server\invoke_method(), serializeParameters(), serializeRPCParameters(), and nusoap_server\verify_method().

Here is the caller graph for this function:

getOperationDataForSoapAction()

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, soap12

Returns

array @access public

Definition at line 5258 of file nusoap.php.

    {
        if ($bindingType == 'soap') {
            $bindingType = 'http://schemas.xmlsoap.org/wsdl/soap/';
        } elseif ($bindingType == 'soap12') {
            $bindingType = 'http://schemas.xmlsoap.org/wsdl/soap12/';
        }
        // loop thru ports
        foreach ($this->ports as $port => $portData) {
            // binding type of port matches parameter
            if ($portData['bindingType'] == $bindingType) {
                // loop through operations for the binding
                foreach ($this->bindings[ $portData['binding'] ]['operations'] as $bOperation => $opData) {
                    if ($opData['soapAction'] == $soapAction) {
                        return $opData;
                    }
                }
            }
        }
    }

References $opData.

Referenced by nusoap_server\invoke_method().

Here is the caller graph for this function:

getOperations()

wsdl::getOperations

(

$bindingType = 'soap'

)

returns an assoc array of operation names => operation data

Parameters

string

$bindingType

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

Returns

array @access public

Definition at line 5194 of file nusoap.php.

    {
        $ops = array();
        if ($bindingType == 'soap') {
            $bindingType = 'http://schemas.xmlsoap.org/wsdl/soap/';
        } elseif ($bindingType == 'soap12') {
            $bindingType = 'http://schemas.xmlsoap.org/wsdl/soap12/';
        }
        // loop thru ports
        foreach ($this->ports as $port => $portData) {
            // binding type of port matches parameter
            if ($portData['bindingType'] == $bindingType) {
                //$this->debug("getOperations for port $port");
                //$this->debug("port data: " . $this->varDump($portData));
                //$this->debug("bindings: " . $this->varDump($this->bindings[ $portData['binding'] ]));
                // merge bindings
                if (isset($this->bindings[ $portData['binding'] ]['operations'])) {
                    $ops = array_merge($ops, $this->bindings[ $portData['binding'] ]['operations']);
                }
            }
        }
        return $ops;
    }

Referenced by nusoap_client\checkWSDL(), and webDescription().

Here is the caller graph for this function:

getTypeDef()

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

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

Returns

mixed @access public

See also

nusoap_xmlschema

Definition at line 5297 of file nusoap.php.

    {
        $this->debug("in getTypeDef: type=$type, ns=$ns");
        if ((! $ns) && isset($this->namespaces['tns'])) {
            $ns = $this->namespaces['tns'];
            $this->debug("in getTypeDef: type namespace forced to $ns");
        }
        if (!isset($this->schemas[$ns])) {
            foreach ($this->schemas as $ns0 => $schema0) {
                if (strcasecmp($ns, $ns0) == 0) {
                    $this->debug("in getTypeDef: replacing schema namespace $ns with $ns0");
                    $ns = $ns0;
                    break;
                }
            }
        }
        if (isset($this->schemas[$ns])) {
            $this->debug("in getTypeDef: have schema for namespace $ns");
            for ($i = 0; $i < count($this->schemas[$ns]); $i++) {
                $xs = &$this->schemas[$ns][$i];
                $t = $xs->getTypeDef($type);
                //$this->appendDebug($xs->getDebug());
                //$xs->clearDebug();
                if ($t) {
                    if (!isset($t['phpType'])) {
                        // get info for type to tack onto the element
                        $uqType = substr($t['type'], strrpos($t['type'], ':') + 1);
                        $ns = substr($t['type'], 0, strrpos($t['type'], ':'));
                        $etype = $this->getTypeDef($uqType, $ns);
                        if ($etype) {
                            $this->debug("found type for [element] $type:");
                            $this->debug($this->varDump($etype));
                            if (isset($etype['phpType'])) {
                                $t['phpType'] = $etype['phpType'];
                            }
                            if (isset($etype['elements'])) {
                                $t['elements'] = $etype['elements'];
                            }
                            if (isset($etype['attrs'])) {
                                $t['attrs'] = $etype['attrs'];
                            }
                        }
                    }
                    return $t;
                }
            }
        } else {
            $this->debug("in getTypeDef: do not have schema for namespace $ns");
        }
        return false;
    }

References $i, $type, nusoap_base\debug(), getTypeDef(), and nusoap_base\varDump().

Referenced by getTypeDef(), parametersMatchWrapped(), serialize(), serializeComplexTypeAttributes(), serializeComplexTypeElements(), and serializeType().

Here is the call graph for this function:

Here is the caller graph for this function:

parametersMatchWrapped()

wsdl::parametersMatchWrapped	(		$type,
		&	$parameters
	)

determine whether a set of parameters are unwrapped when they are expect to be wrapped, Microsoft-style.

Parameters

string	$type	the type (element name) of the wrapper
array	$parameters	the parameter values for the SOAP call

Returns

boolean whether they parameters are unwrapped (and should be wrapped) @access private

Definition at line 5640 of file nusoap.php.

    {
        $this->debug("in parametersMatchWrapped type=$type, parameters=");
        $this->appendDebug($this->varDump($parameters));
 
        // split type into namespace:unqualified-type
        if (strpos($type, ':')) {
            $uqType = substr($type, strrpos($type, ':') + 1);
            $ns = substr($type, 0, strrpos($type, ':'));
            $this->debug("in parametersMatchWrapped: got a prefixed type: $uqType, $ns");
            if ($this->getNamespaceFromPrefix($ns)) {
                $ns = $this->getNamespaceFromPrefix($ns);
                $this->debug("in parametersMatchWrapped: expanded prefixed type: $uqType, $ns");
            }
        } else {
            // TODO: should the type be compared to types in XSD, and the namespace
            // set to XSD if the type matches?
            $this->debug("in parametersMatchWrapped: No namespace for type $type");
            $ns = '';
            $uqType = $type;
        }
 
        // get the type information
        if (!$typeDef = $this->getTypeDef($uqType, $ns)) {
            $this->debug("in parametersMatchWrapped: $type ($uqType) is not a supported type.");
            return false;
        }
        $this->debug("in parametersMatchWrapped: found typeDef=");
        $this->appendDebug($this->varDump($typeDef));
        if (substr($uqType, -1) == '^') {
            $uqType = substr($uqType, 0, -1);
        }
        $phpType = $typeDef['phpType'];
        $arrayType = (isset($typeDef['arrayType']) ? $typeDef['arrayType'] : '');
        $this->debug("in parametersMatchWrapped: uqType: $uqType, ns: $ns, phptype: $phpType, arrayType: $arrayType");
 
        // we expect a complexType or element of complexType
        if ($phpType != 'struct') {
            $this->debug("in parametersMatchWrapped: not a struct");
            return false;
        }
 
        // see whether the parameter names match the elements
        if (isset($typeDef['elements']) && is_array($typeDef['elements'])) {
            $elements = 0;
            $matches = 0;
            $change = false;
            if ($this->isArraySimpleOrStruct($parameters) == 'arraySimple' && count($parameters) == count($typeDef['elements'])) {
                $this->debug("in parametersMatchWrapped: (wrapped return value kludge) correct number of elements in simple array, so change array and wrap");
                $change = true;
            }
            foreach ($typeDef['elements'] as $name => $attrs) {
                if ($change) {
                    $this->debug("in parametersMatchWrapped: change parameter $element to name $name");
                    $parameters[$name] = $parameters[$elements];
                    unset($parameters[$elements]);
                    $matches++;
                } elseif (isset($parameters[$name])) {
                    $this->debug("in parametersMatchWrapped: have parameter named $name");
                    $matches++;
                } else {
                    $this->debug("in parametersMatchWrapped: do not have parameter named $name");
                }
                $elements++;
            }
 
            $this->debug("in parametersMatchWrapped: $matches parameter names match $elements wrapped parameter names");
            if ($matches == 0) {
                return false;
            }
            return true;
        }
 
        // since there are no elements for the type, if the user passed no
        // parameters, the parameters match wrapped.
        $this->debug("in parametersMatchWrapped: no elements type $ns:$uqType");
        return count($parameters) == 0;
    }

References $name, $type, nusoap_base\appendDebug(), nusoap_base\debug(), nusoap_base\getNamespaceFromPrefix(), getTypeDef(), nusoap_base\isArraySimpleOrStruct(), and nusoap_base\varDump().

Referenced by serializeRPCParameters().

Here is the call graph for this function:

Here is the caller graph for this function:

parseWSDL()

wsdl::parseWSDL

(

$wsdl = ''

)

parses the wsdl document

Parameters

string

$wsdl

path or URL @access private

Definition at line 4801 of file nusoap.php.

    {
        $this->debug("parse WSDL at path=$wsdl");
 
        if ($wsdl == '') {
            $this->debug('no wsdl passed to parseWSDL()!!');
            $this->setError('no wsdl passed to parseWSDL()!!');
            return false;
        }
 
        // parse $wsdl for url format
        $wsdl_props = parse_url($wsdl);
 
        if (isset($wsdl_props['scheme']) && ($wsdl_props['scheme'] == 'http' || $wsdl_props['scheme'] == 'https')) {
            $this->debug('getting WSDL http(s) URL ' . $wsdl);
            // get wsdl
            $tr = new soap_transport_http($wsdl, $this->curl_options, $this->use_curl);
            $tr->request_method = 'GET';
            $tr->useSOAPAction = false;
            if ($this->proxyhost && $this->proxyport) {
                $tr->setProxy($this->proxyhost, $this->proxyport, $this->proxyusername, $this->proxypassword);
            }
            if ($this->authtype != '') {
                $tr->setCredentials($this->username, $this->password, $this->authtype, array(), $this->certRequest);
            }
            $tr->setEncoding('gzip, deflate');
            $wsdl_string = $tr->send('', $this->timeout, $this->response_timeout);
            //$this->debug("WSDL request\n" . $tr->outgoing_payload);
            //$this->debug("WSDL response\n" . $tr->incoming_payload);
            $this->appendDebug($tr->getDebug());
            // catch errors
            if ($err = $tr->getError()) {
                $errstr = 'HTTP ERROR: ' . $err;
                $this->debug($errstr);
                $this->setError($errstr);
                unset($tr);
                return false;
            }
            unset($tr);
            $this->debug("got WSDL URL");
        } else {
            // $wsdl is not http(s), so treat it as a file URL or plain file path
            if (isset($wsdl_props['scheme']) && ($wsdl_props['scheme'] == 'file') && isset($wsdl_props['path'])) {
                $path = isset($wsdl_props['host']) ? ($wsdl_props['host'] . ':' . $wsdl_props['path']) : $wsdl_props['path'];
            } else {
                $path = $wsdl;
            }
            $this->debug('getting WSDL file ' . $path);
            if ($fp = @fopen($path, 'r')) {
                $wsdl_string = '';
                while ($data = fread($fp, 32768)) {
                    $wsdl_string .= $data;
                }
                fclose($fp);
            } else {
                $errstr = "Bad path to WSDL file $path";
                $this->debug($errstr);
                $this->setError($errstr);
                return false;
            }
        }
        $this->debug('Parse WSDL');
        // end new code added
        // Create an XML parser.
        $this->parser = xml_parser_create();
        // Set the options for parsing the XML data.
        // xml_parser_set_option($parser, XML_OPTION_SKIP_WHITE, 1);
        xml_parser_set_option($this->parser, XML_OPTION_CASE_FOLDING, 0);
        // Set the object for the parser.
        xml_set_object($this->parser, $this);
        // Set the element handlers for the parser.
        xml_set_element_handler($this->parser, 'start_element', 'end_element');
        xml_set_character_data_handler($this->parser, 'character_data');
        // Parse the XML file.
        if (!xml_parse($this->parser, $wsdl_string, true)) {
            // Display an error message.
            $errstr = sprintf(
                'XML error parsing WSDL from %s on line %d: %s',
                $wsdl,
                xml_get_current_line_number($this->parser),
                xml_error_string(xml_get_error_code($this->parser))
            );
            $this->debug($errstr);
            $this->debug("XML payload:\n" . $wsdl_string);
            $this->setError($errstr);
            return false;
        }
        // free the parser
        xml_parser_free($this->parser);
        $this->debug('Parsing WSDL done');
        // catch wsdl parse errors
        if ($this->getError()) {
            return false;
        }
        return true;
    }

References $data, $path, $wsdl, nusoap_base\appendDebug(), nusoap_base\debug(), nusoap_base\getError(), and nusoap_base\setError().

Referenced by fetchWSDL().

Here is the call graph for this function:

Here is the caller graph for this function:

serialize()

wsdl::serialize

(

$debug = 0

)

serialize the parsed wsdl

Parameters

mixed

$debug

whether to put debug=1 in endpoint URL

Returns

string serialization of WSDL @access public

Definition at line 5496 of file nusoap.php.

    {
        $xml = '<?xml version="1.0" encoding="ISO-8859-1"?>';
        $xml .= "\n<definitions";
        foreach ($this->namespaces as $k => $v) {
            $xml .= " xmlns:$k=\"$v\"";
        }
        // 10.9.02 - add poulter fix for wsdl and tns declarations
        if (isset($this->namespaces['wsdl'])) {
            $xml .= " xmlns=\"" . $this->namespaces['wsdl'] . "\"";
        }
        if (isset($this->namespaces['tns'])) {
            $xml .= " targetNamespace=\"" . $this->namespaces['tns'] . "\"";
        }
        $xml .= '>';
        // imports
        if (sizeof($this->import) > 0) {
            foreach ($this->import as $ns => $list) {
                foreach ($list as $ii) {
                    if ($ii['location'] != '') {
                        $xml .= '<import location="' . $ii['location'] . '" namespace="' . $ns . '" />';
                    } else {
                        $xml .= '<import namespace="' . $ns . '" />';
                    }
                }
            }
        }
        // types
        if (count($this->schemas)>=1) {
            $xml .= "\n<types>\n";
            foreach ($this->schemas as $ns => $list) {
                foreach ($list as $xs) {
                    $xml .= $xs->serializeSchema();
                }
            }
            $xml .= '</types>';
        }
        // messages
        if (count($this->messages) >= 1) {
            foreach ($this->messages as $msgName => $msgParts) {
                $xml .= "\n<message name=\"" . $msgName . '">';
                if (is_array($msgParts)) {
                    foreach ($msgParts as $partName => $partType) {
                        // print 'serializing '.$partType.', sv: '.$this->XMLSchemaVersion.'<br>';
                        if (strpos($partType, ':')) {
                            $typePrefix = $this->getPrefixFromNamespace($this->getPrefix($partType));
                        } elseif (isset($this->typemap[$this->namespaces['xsd']][$partType])) {
                            // print 'checking typemap: '.$this->XMLSchemaVersion.'<br>';
                            $typePrefix = 'xsd';
                        } else {
                            foreach ($this->typemap as $ns => $types) {
                                if (isset($types[$partType])) {
                                    $typePrefix = $this->getPrefixFromNamespace($ns);
                                }
                            }
                            if (!isset($typePrefix)) {
                                die("$partType has no namespace!");
                            }
                        }
                        $ns = $this->getNamespaceFromPrefix($typePrefix);
                        $localPart = $this->getLocalPart($partType);
                        $typeDef = $this->getTypeDef($localPart, $ns);
                        if (($typeDef['typeClass'] ?? '') == 'element') {
                            $elementortype = 'element';
                            if (substr($localPart, -1) == '^') {
                                $localPart = substr($localPart, 0, -1);
                            }
                        } else {
                            $elementortype = 'type';
                        }
                        $xml .= "\n" . '  <part name="' . $partName . '" ' . $elementortype . '="' . $typePrefix . ':' . $localPart . '" />';
                    }
                }
                $xml .= '</message>';
            }
        }
        // bindings & porttypes
        if (count($this->bindings) >= 1) {
            $binding_xml = '';
            $portType_xml = '';
            foreach ($this->bindings as $bindingName => $attrs) {
                $binding_xml .= "\n<binding name=\"" . $bindingName . '" type="tns:' . $attrs['portType'] . '">';
                $binding_xml .= "\n" . '  <soap:binding style="' . $attrs['style'] . '" transport="' . $attrs['transport'] . '"/>';
                $portType_xml .= "\n<portType name=\"" . $attrs['portType'] . '">';
                foreach ($attrs['operations'] as $opName => $opParts) {
                    $binding_xml .= "\n" . '  <operation name="' . $opName . '">';
                    $binding_xml .= "\n" . '    <soap:operation soapAction="' . $opParts['soapAction'] . '" style="' . $opParts['style'] . '"/>';
                    if (isset($opParts['input']['encodingStyle']) && $opParts['input']['encodingStyle'] != '') {
                        $enc_style = ' encodingStyle="' . $opParts['input']['encodingStyle'] . '"';
                    } else {
                        $enc_style = '';
                    }
                    $binding_xml .= "\n" . '    <input><soap:body use="' . $opParts['input']['use'] . '" namespace="' . $opParts['input']['namespace'] . '"' . $enc_style . '/></input>';
                    if (isset($opParts['output']['encodingStyle']) && $opParts['output']['encodingStyle'] != '') {
                        $enc_style = ' encodingStyle="' . $opParts['output']['encodingStyle'] . '"';
                    } else {
                        $enc_style = '';
                    }
                    $binding_xml .= "\n" . '    <output><soap:body use="' . $opParts['output']['use'] . '" namespace="' . $opParts['output']['namespace'] . '"' . $enc_style . '/></output>';
                    $binding_xml .= "\n" . '  </operation>';
                    $portType_xml .= "\n" . '  <operation name="' . $opParts['name'] . '"';
                    if (isset($opParts['parameterOrder'])) {
                        $portType_xml .= ' parameterOrder="' . $opParts['parameterOrder'] . '"';
                    }
                    $portType_xml .= '>';
                    if (isset($opParts['documentation']) && $opParts['documentation'] != '') {
                        $portType_xml .= "\n" . '    <documentation>' . htmlspecialchars($opParts['documentation']) . '</documentation>';
                    }
                    $portType_xml .= "\n" . '    <input message="tns:' . $opParts['input']['message'] . '"/>';
                    $portType_xml .= "\n" . '    <output message="tns:' . $opParts['output']['message'] . '"/>';
                    $portType_xml .= "\n" . '  </operation>';
                }
                $portType_xml .= "\n" . '</portType>';
                $binding_xml .= "\n" . '</binding>';
            }
            $xml .= $portType_xml . $binding_xml;
        }
        // services
        $xml .= "\n<service name=\"" . $this->serviceName . '">';
        $has_client = isset($_GET['client_id']);
        if (count($this->ports) >= 1) {
            foreach ($this->ports as $pName => $attrs) {
                $xml .= "\n" . '  <port name="' . $pName . '" binding="tns:' . $attrs['binding'] . '">';
                $address = $attrs['location'] . ($debug || $has_client ? "?" : "")
                           . ($debug ? 'debug=1' : '') . ($debug && $has_client ? "&amp;" : "")
                           . ($has_client ? 'client_id=' . $_GET['client_id'] : '');
                $xml .= "\n" . '    <soap:address location="' . $address . '"/>';
                $xml .= "\n" . '  </port>';
            }
        }
 
        $xml .= "\n" . '</service>';
        return $xml . "\n</definitions>";
    }

References $_GET, $xml, nusoap_base\getLocalPart(), nusoap_base\getNamespaceFromPrefix(), nusoap_base\getPrefix(), nusoap_base\getPrefixFromNamespace(), and getTypeDef().

Referenced by nusoap_server\service().

Here is the call graph for this function:

Here is the caller graph for this function:

serializeComplexTypeAttributes()

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 @access private

Definition at line 6211 of file nusoap.php.

    {
        $xml = '';
        if (isset($typeDef['attrs']) && is_array($typeDef['attrs'])) {
            $this->debug("serialize attributes for XML Schema type $ns:$uqType");
            if (is_array($value)) {
                $xvalue = $value;
            } elseif (is_object($value)) {
                $xvalue = get_object_vars($value);
            } else {
                $this->debug("value is neither an array nor an object for XML Schema type $ns:$uqType");
                $xvalue = array();
            }
            foreach ($typeDef['attrs'] as $aName => $attrs) {
                if (isset($xvalue['!' . $aName])) {
                    $xname = '!' . $aName;
                    $this->debug("value provided for attribute $aName with key $xname");
                } elseif (isset($xvalue[$aName])) {
                    $xname = $aName;
                    $this->debug("value provided for attribute $aName with key $xname");
                } elseif (isset($attrs['default'])) {
                    $xname = '!' . $aName;
                    $xvalue[$xname] = $attrs['default'];
                    $this->debug('use default value of ' . $xvalue[$aName] . ' for attribute ' . $aName);
                } else {
                    $xname = '';
                    $this->debug("no value provided for attribute $aName");
                }
                if ($xname) {
                    $xml .=  " $aName=\"" . $this->expandEntities($xvalue[$xname]) . "\"";
                }
            }
        } else {
            $this->debug("no attributes to serialize for XML Schema type $ns:$uqType");
        }
        if (isset($typeDef['extensionBase'])) {
            $ns = $this->getPrefix($typeDef['extensionBase']);
            $uqType = $this->getLocalPart($typeDef['extensionBase']);
            if ($this->getNamespaceFromPrefix($ns)) {
                $ns = $this->getNamespaceFromPrefix($ns);
            }
            if ($typeDef = $this->getTypeDef($uqType, $ns)) {
                $this->debug("serialize attributes for extension base $ns:$uqType");
                $xml .= $this->serializeComplexTypeAttributes($typeDef, $value, $ns, $uqType);
            } else {
                $this->debug("extension base $ns:$uqType is not a supported type");
            }
        }
        return $xml;
    }

References $xml, nusoap_base\debug(), nusoap_base\expandEntities(), nusoap_base\getLocalPart(), nusoap_base\getNamespaceFromPrefix(), nusoap_base\getPrefix(), getTypeDef(), and serializeComplexTypeAttributes().

Referenced by serializeComplexTypeAttributes(), and serializeType().

Here is the call graph for this function:

Here is the caller graph for this function:

serializeComplexTypeElements()

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 @access private

Definition at line 6274 of file nusoap.php.

    {
        $xml = '';
        if (isset($typeDef['elements']) && is_array($typeDef['elements'])) {
            $this->debug("in serializeComplexTypeElements, serialize elements for XML Schema type $ns:$uqType");
            if (is_array($value)) {
                $xvalue = $value;
            } elseif (is_object($value)) {
                $xvalue = get_object_vars($value);
            } else {
                $this->debug("value is neither an array nor an object for XML Schema type $ns:$uqType");
                $xvalue = array();
            }
            // toggle whether all elements are present - ideally should validate against schema
            if (count($typeDef['elements']) != count($xvalue)) {
                $optionals = true;
            }
            foreach ($typeDef['elements'] as $eName => $attrs) {
                if (!isset($xvalue[$eName])) {
                    if (isset($attrs['default'])) {
                        $xvalue[$eName] = $attrs['default'];
                        $this->debug('use default value of ' . $xvalue[$eName] . ' for element ' . $eName);
                    }
                }
                // if user took advantage of a minOccurs=0, then only serialize named parameters
                if (isset($optionals)
                    && (!isset($xvalue[$eName]))
                    && ((!isset($attrs['nillable'])) || $attrs['nillable'] != 'true')
                    ) {
                    if (isset($attrs['minOccurs']) && $attrs['minOccurs'] <> '0') {
                        $this->debug("apparent error: no value provided for element $eName with minOccurs=" . $attrs['minOccurs']);
                    }
                    // do nothing
                    $this->debug("no value provided for complexType element $eName and element is not nillable, so serialize nothing");
                } else {
                    // get value
                    if (isset($xvalue[$eName])) {
                        $v = $xvalue[$eName];
                    } else {
                        $v = null;
                    }
                    if (isset($attrs['form'])) {
                        $unqualified = ($attrs['form'] == 'unqualified');
                    } else {
                        $unqualified = false;
                    }
                    if (isset($attrs['maxOccurs']) && ($attrs['maxOccurs'] == 'unbounded' || $attrs['maxOccurs'] > 1) && isset($v) && is_array($v) && $this->isArraySimpleOrStruct($v) == 'arraySimple') {
                        $vv = $v;
                        foreach ($vv as $k => $v) {
                            if (isset($attrs['type']) || isset($attrs['ref'])) {
                                // serialize schema-defined type
                                $xml .= $this->serializeType($eName, isset($attrs['type']) ? $attrs['type'] : $attrs['ref'], $v, $use, $encodingStyle, $unqualified);
                            } else {
                                // serialize generic type (can this ever really happen?)
                                $this->debug("calling serialize_val() for $v, $eName, false, false, false, false, $use");
                                $xml .= $this->serialize_val($v, $eName, false, false, false, false, $use);
                            }
                        }
                    } else {
                        if (isset($attrs['type']) || isset($attrs['ref'])) {
                            // serialize schema-defined type
                            $xml .= $this->serializeType($eName, isset($attrs['type']) ? $attrs['type'] : $attrs['ref'], $v, $use, $encodingStyle, $unqualified);
                        } else {
                            // serialize generic type (can this ever really happen?)
                            $this->debug("calling serialize_val() for $v, $eName, false, false, false, false, $use");
                            $xml .= $this->serialize_val($v, $eName, false, false, false, false, $use);
                        }
                    }
                }
            }
        } else {
            $this->debug("no elements to serialize for XML Schema type $ns:$uqType");
        }
        if (isset($typeDef['extensionBase'])) {
            $ns = $this->getPrefix($typeDef['extensionBase']);
            $uqType = $this->getLocalPart($typeDef['extensionBase']);
            if ($this->getNamespaceFromPrefix($ns)) {
                $ns = $this->getNamespaceFromPrefix($ns);
            }
            if ($typeDef = $this->getTypeDef($uqType, $ns)) {
                $this->debug("serialize elements for extension base $ns:$uqType");
                $xml .= $this->serializeComplexTypeElements($typeDef, $value, $ns, $uqType, $use, $encodingStyle);
            } else {
                $this->debug("extension base $ns:$uqType is not a supported type");
            }
        }
        return $xml;
    }

References $xml, nusoap_base\debug(), nusoap_base\getLocalPart(), nusoap_base\getNamespaceFromPrefix(), nusoap_base\getPrefix(), getTypeDef(), nusoap_base\isArraySimpleOrStruct(), nusoap_base\serialize_val(), serializeComplexTypeElements(), and serializeType().

Referenced by serializeComplexTypeElements(), and serializeType().

Here is the call graph for this function:

Here is the caller graph for this function:

serializeParameters()

wsdl::serializeParameters	(		$operation,
			$direction,
			$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

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) @access public

Deprecated:

Definition at line 5829 of file nusoap.php.

    {
        $this->debug("in serializeParameters: operation=$operation, direction=$direction, XMLSchemaVersion=$this->XMLSchemaVersion");
        $this->appendDebug('parameters=' . $this->varDump($parameters));
 
        if ($direction != 'input' && $direction != 'output') {
            $this->debug('The value of the \$direction argument needs to be either "input" or "output"');
            $this->setError('The value of the \$direction argument needs to be either "input" or "output"');
            return false;
        }
        if (!$opData = $this->getOperationData($operation)) {
            $this->debug('Unable to retrieve WSDL data for operation: ' . $operation);
            $this->setError('Unable to retrieve WSDL data for operation: ' . $operation);
            return false;
        }
        $this->debug('opData:');
        $this->appendDebug($this->varDump($opData));
 
        // Get encoding style for output and set to current
        $encodingStyle = 'http://schemas.xmlsoap.org/soap/encoding/';
        if (($direction == 'input') && isset($opData['output']['encodingStyle']) && ($opData['output']['encodingStyle'] != $encodingStyle)) {
            $encodingStyle = $opData['output']['encodingStyle'];
            $enc_style = $encodingStyle;
        }
 
        // set input params
        $xml = '';
        if (isset($opData[$direction]['parts']) && sizeof($opData[$direction]['parts']) > 0) {
            $use = $opData[$direction]['use'];
            $this->debug("use=$use");
            $this->debug('got ' . count($opData[$direction]['parts']) . ' part(s)');
            if (is_array($parameters)) {
                $parametersArrayType = $this->isArraySimpleOrStruct($parameters);
                $this->debug('have ' . $parametersArrayType . ' parameters');
                foreach ($opData[$direction]['parts'] as $name => $type) {
                    $this->debug('serializing part "' . $name . '" of type "' . $type . '"');
                    // Track encoding style
                    if (isset($opData[$direction]['encodingStyle']) && $encodingStyle != $opData[$direction]['encodingStyle']) {
                        $encodingStyle = $opData[$direction]['encodingStyle'];
                        $enc_style = $encodingStyle;
                    } else {
                        $enc_style = false;
                    }
                    // NOTE: add error handling here
                    // if serializeType returns false, then catch global error and fault
                    if ($parametersArrayType == 'arraySimple') {
                        $p = array_shift($parameters);
                        $this->debug('calling serializeType w/indexed param');
                        $xml .= $this->serializeType($name, $type, $p, $use, $enc_style);
                    } elseif (isset($parameters[$name])) {
                        $this->debug('calling serializeType w/named param');
                        $xml .= $this->serializeType($name, $type, $parameters[$name], $use, $enc_style);
                    } else {
                        // TODO: only send nillable
                        $this->debug('calling serializeType w/null param');
                        $xml .= $this->serializeType($name, $type, null, $use, $enc_style);
                    }
                }
            } else {
                $this->debug('no parameters passed.');
            }
        }
        $this->debug("serializeParameters returning: $xml");
        return $xml;
    }

References $name, $opData, $type, $xml, nusoap_base\appendDebug(), nusoap_base\debug(), getOperationData(), nusoap_base\isArraySimpleOrStruct(), serializeType(), nusoap_base\setError(), and nusoap_base\varDump().

Here is the call graph for this function:

serializeRPCParameters()

wsdl::serializeRPCParameters	(		$operation,
			$direction,
			$parameters,
			$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

Parameters

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

Returns

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

Definition at line 5734 of file nusoap.php.

    {
        $this->debug("in serializeRPCParameters: operation=$operation, direction=$direction, XMLSchemaVersion=$this->XMLSchemaVersion, bindingType=$bindingType");
        $this->appendDebug('parameters=' . $this->varDump($parameters));
 
        if ($direction != 'input' && $direction != 'output') {
            $this->debug('The value of the \$direction argument needs to be either "input" or "output"');
            $this->setError('The value of the \$direction argument needs to be either "input" or "output"');
            return false;
        }
        if (!$opData = $this->getOperationData($operation, $bindingType)) {
            $this->debug('Unable to retrieve WSDL data for operation: ' . $operation . ' bindingType: ' . $bindingType);
            $this->setError('Unable to retrieve WSDL data for operation: ' . $operation . ' bindingType: ' . $bindingType);
            return false;
        }
        $this->debug('in serializeRPCParameters: opData:');
        $this->appendDebug($this->varDump($opData));
 
        // Get encoding style for output and set to current
        $encodingStyle = 'http://schemas.xmlsoap.org/soap/encoding/';
        if (($direction == 'input') && isset($opData['output']['encodingStyle']) && ($opData['output']['encodingStyle'] != $encodingStyle)) {
            $encodingStyle = $opData['output']['encodingStyle'];
            $enc_style = $encodingStyle;
        }
 
        // set input params
        $xml = '';
        if (isset($opData[$direction]['parts']) && sizeof($opData[$direction]['parts']) > 0) {
            $parts = &$opData[$direction]['parts'];
            $part_count = sizeof($parts);
            $style = $opData['style'];
            $use = $opData[$direction]['use'];
            $this->debug("have $part_count part(s) to serialize using $style/$use");
            if (is_array($parameters)) {
                $parametersArrayType = $this->isArraySimpleOrStruct($parameters);
                $parameter_count = count($parameters);
                $this->debug("have $parameter_count parameter(s) provided as $parametersArrayType to serialize");
                // check for Microsoft-style wrapped parameters
                if ($style == 'document' && $use == 'literal' && $part_count == 1 && isset($parts['parameters'])) {
                    $this->debug('check whether the caller has wrapped the parameters');
                    if ((($parametersArrayType == 'arrayStruct' || $parameter_count == 0) && !isset($parameters['parameters'])) || ($direction == 'output' && $parametersArrayType == 'arraySimple' && $parameter_count == 1)) {
                        $this->debug('check whether caller\'s parameters match the wrapped ones');
                        if ($this->parametersMatchWrapped($parts['parameters'], $parameters)) {
                            $this->debug('wrap the parameters for the caller');
                            $parameters = array('parameters' => $parameters);
                            $parameter_count = 1;
                        }
                    }
                }
                foreach ($parts as $name => $type) {
                    $this->debug("serializing part $name of type $type");
                    // Track encoding style
                    if (isset($opData[$direction]['encodingStyle']) && $encodingStyle != $opData[$direction]['encodingStyle']) {
                        $encodingStyle = $opData[$direction]['encodingStyle'];
                        $enc_style = $encodingStyle;
                    } else {
                        $enc_style = false;
                    }
                    // NOTE: add error handling here
                    // if serializeType returns false, then catch global error and fault
                    if ($parametersArrayType == 'arraySimple') {
                        $p = array_shift($parameters);
                        $this->debug('calling serializeType w/indexed param');
                        $xml .= $this->serializeType($name, $type, $p, $use, $enc_style);
                    } elseif (isset($parameters[$name])) {
                        $this->debug('calling serializeType w/named param');
                        $xml .= $this->serializeType($name, $type, $parameters[$name], $use, $enc_style);
                    } else {
                        // TODO: only send nillable
                        $this->debug('calling serializeType w/null param');
                        $xml .= $this->serializeType($name, $type, null, $use, $enc_style);
                    }
                }
            } else {
                $this->debug('no parameters passed.');
            }
        }
        $this->debug("serializeRPCParameters returning: $xml");
        return $xml;
    }

References $name, $opData, $parts, $type, $xml, nusoap_base\appendDebug(), nusoap_base\debug(), getOperationData(), nusoap_base\isArraySimpleOrStruct(), parametersMatchWrapped(), serializeType(), nusoap_base\setError(), and nusoap_base\varDump().

Referenced by nusoap_client\call(), and nusoap_server\serialize_return().

Here is the call graph for this function:

Here is the caller graph for this function:

serializeType()

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 @access private

Definition at line 5907 of file nusoap.php.

    {
        $this->debug("in serializeType: name=$name, type=$type, use=$use, encodingStyle=$encodingStyle, unqualified=" . ($unqualified ? "unqualified" : "qualified"));
        $this->appendDebug("value=" . $this->varDump($value));
        if ($use == 'encoded' && $encodingStyle) {
            $encodingStyle = ' SOAP-ENV:encodingStyle="' . $encodingStyle . '"';
        }
 
        // if a soapval has been supplied, let its type override the WSDL
        if (is_object($value) && get_class($value) == 'soapval') {
            if ($value->type_ns) {
                $type = $value->type_ns . ':' . $value->type;
                $forceType = true;
                $this->debug("in serializeType: soapval overrides type to $type");
            } elseif ($value->type) {
                $type = $value->type;
                $forceType = true;
                $this->debug("in serializeType: soapval overrides type to $type");
            } else {
                $forceType = false;
                $this->debug("in serializeType: soapval does not override type");
            }
            $attrs = $value->attributes;
            $value = $value->value;
            $this->debug("in serializeType: soapval overrides value to $value");
            if ($attrs) {
                if (!is_array($value)) {
                    $value['!'] = $value;
                }
                foreach ($attrs as $n => $v) {
                    $value['!' . $n] = $v;
                }
                $this->debug("in serializeType: soapval provides attributes");
            }
        } else {
            $forceType = false;
        }
 
        $xml = '';
        if (strpos($type, ':')) {
            $uqType = substr($type, strrpos($type, ':') + 1);
            $ns = substr($type, 0, strrpos($type, ':'));
            $this->debug("in serializeType: got a prefixed type: $uqType, $ns");
            if ($this->getNamespaceFromPrefix($ns)) {
                $ns = $this->getNamespaceFromPrefix($ns);
                $this->debug("in serializeType: expanded prefixed type: $uqType, $ns");
            }
 
            if ($ns == $this->XMLSchemaVersion || $ns == 'http://schemas.xmlsoap.org/soap/encoding/') {
                $this->debug('in serializeType: type namespace indicates XML Schema or SOAP Encoding type');
                if ($unqualified && $use == 'literal') {
                    $elementNS = " xmlns=\"\"";
                } else {
                    $elementNS = '';
                }
                if (is_null($value)) {
                    if ($use == 'literal') {
                        // TODO: depends on minOccurs
                        $xml = "<$name$elementNS/>";
                    } else {
                        // TODO: depends on nillable, which should be checked before calling this method
                        $xml = "<$name$elementNS xsi:nil=\"true\" xsi:type=\"" . $this->getPrefixFromNamespace($ns) . ":$uqType\"/>";
                    }
                    $this->debug("in serializeType: returning: $xml");
                    return $xml;
                }
                if ($uqType == 'Array') {
                    // JBoss/Axis does this sometimes
                    return $this->serialize_val($value, $name, false, false, false, false, $use);
                }
                if ($uqType == 'boolean') {
                    if ((is_string($value) && $value == 'false') || (! $value)) {
                        $value = 'false';
                    } else {
                        $value = 'true';
                    }
                }
                if ($uqType == 'string' && gettype($value) == 'string') {
                    $value = $this->expandEntities($value);
                }
                if (($uqType == 'long' || $uqType == 'unsignedLong') && gettype($value) == 'double') {
                    $value = sprintf("%.0lf", $value);
                }
                // it's a scalar
                // TODO: what about null/nil values?
                // check type isn't a custom type extending xmlschema namespace
                if (!$this->getTypeDef($uqType, $ns)) {
                    if ($use == 'literal') {
                        if ($forceType) {
                            $xml = "<$name$elementNS xsi:type=\"" . $this->getPrefixFromNamespace($ns) . ":$uqType\">$value</$name>";
                        } else {
                            $xml = "<$name$elementNS>$value</$name>";
                        }
                    } else {
                        $xml = "<$name$elementNS xsi:type=\"" . $this->getPrefixFromNamespace($ns) . ":$uqType\"$encodingStyle>$value</$name>";
                    }
                    $this->debug("in serializeType: returning: $xml");
                    return $xml;
                }
                $this->debug('custom type extends XML Schema or SOAP Encoding namespace (yuck)');
            } elseif ($ns == 'http://xml.apache.org/xml-soap') {
                $this->debug('in serializeType: appears to be Apache SOAP type');
                if ($uqType == 'Map') {
                    $tt_prefix = $this->getPrefixFromNamespace('http://xml.apache.org/xml-soap');
                    if (! $tt_prefix) {
                        $this->debug('in serializeType: Add namespace for Apache SOAP type');
                        $tt_prefix = 'ns' . rand(1000, 9999);
                        $this->namespaces[$tt_prefix] = 'http://xml.apache.org/xml-soap';
                        // force this to be added to usedNamespaces
                        $tt_prefix = $this->getPrefixFromNamespace('http://xml.apache.org/xml-soap');
                    }
                    $contents = '';
                    foreach ($value as $k => $v) {
                        $this->debug("serializing map element: key $k, value $v");
                        $contents .= '<item>';
                        $contents .= $this->serialize_val($k, 'key', false, false, false, false, $use);
                        $contents .= $this->serialize_val($v, 'value', false, false, false, false, $use);
                        $contents .= '</item>';
                    }
                    if ($use == 'literal') {
                        if ($forceType) {
                            $xml = "<$name xsi:type=\"" . $tt_prefix . ":$uqType\">$contents</$name>";
                        } else {
                            $xml = "<$name>$contents</$name>";
                        }
                    } else {
                        $xml = "<$name xsi:type=\"" . $tt_prefix . ":$uqType\"$encodingStyle>$contents</$name>";
                    }
                    $this->debug("in serializeType: returning: $xml");
                    return $xml;
                }
                $this->debug('in serializeType: Apache SOAP type, but only support Map');
            }
        } else {
            // TODO: should the type be compared to types in XSD, and the namespace
            // set to XSD if the type matches?
            $this->debug("in serializeType: No namespace for type $type");
            $ns = '';
            $uqType = $type;
        }
        if (!$typeDef = $this->getTypeDef($uqType, $ns)) {
            $this->setError("$type ($uqType) is not a supported type.");
            $this->debug("in serializeType: $type ($uqType) is not a supported type.");
            return false;
        } else {
            $this->debug("in serializeType: found typeDef");
            $this->appendDebug('typeDef=' . $this->varDump($typeDef));
            if (substr($uqType, -1) == '^') {
                $uqType = substr($uqType, 0, -1);
            }
        }
        $phpType = $typeDef['phpType'];
        $this->debug("in serializeType: uqType: $uqType, ns: $ns, phptype: $phpType, arrayType: " . (isset($typeDef['arrayType']) ? $typeDef['arrayType'] : ''));
        // if php type == struct, map value to the <all> element names
        if ($phpType == 'struct') {
            if (isset($typeDef['typeClass']) && $typeDef['typeClass'] == 'element') {
                $elementName = $uqType;
                if (isset($typeDef['form']) && ($typeDef['form'] == 'qualified')) {
                    $elementNS = " xmlns=\"$ns\"";
                } else {
                    $elementNS = " xmlns=\"\"";
                }
            } else {
                $elementName = $name;
                if ($unqualified) {
                    $elementNS = " xmlns=\"\"";
                } else {
                    $elementNS = '';
                }
            }
            if (is_null($value)) {
                if ($use == 'literal') {
                    // TODO: depends on minOccurs
                    $xml = "<$elementName$elementNS/>";
                } else {
                    $xml = "<$elementName$elementNS xsi:nil=\"true\" xsi:type=\"" . $this->getPrefixFromNamespace($ns) . ":$uqType\"/>";
                }
                $this->debug("in serializeType: returning: $xml");
                return $xml;
            }
            if (is_object($value)) {
                $value = get_object_vars($value);
            }
            if (is_array($value)) {
                $elementAttrs = $this->serializeComplexTypeAttributes($typeDef, $value, $ns, $uqType);
                if ($use == 'literal') {
                    if ($forceType) {
                        $xml = "<$elementName$elementNS$elementAttrs xsi:type=\"" . $this->getPrefixFromNamespace($ns) . ":$uqType\">";
                    } else {
                        $xml = "<$elementName$elementNS$elementAttrs>";
                    }
                } else {
                    $xml = "<$elementName$elementNS$elementAttrs xsi:type=\"" . $this->getPrefixFromNamespace($ns) . ":$uqType\"$encodingStyle>";
                }
 
                $xml .= $this->serializeComplexTypeElements($typeDef, $value, $ns, $uqType, $use, $encodingStyle);
                $xml .= "</$elementName>";
            } else {
                $this->debug("in serializeType: phpType is struct, but value is not an array");
                $this->setError("phpType is struct, but value is not an array: see debug output for details");
                $xml = '';
            }
        } elseif ($phpType == 'array') {
            if (isset($typeDef['form']) && ($typeDef['form'] == 'qualified')) {
                $elementNS = " xmlns=\"$ns\"";
            } else {
                if ($unqualified) {
                    $elementNS = " xmlns=\"\"";
                } else {
                    $elementNS = '';
                }
            }
            if (is_null($value)) {
                if ($use == 'literal') {
                    // TODO: depends on minOccurs
                    $xml = "<$name$elementNS/>";
                } else {
                    $xml = "<$name$elementNS xsi:nil=\"true\" xsi:type=\"" .
                        $this->getPrefixFromNamespace('http://schemas.xmlsoap.org/soap/encoding/') .
                        ":Array\" " .
                        $this->getPrefixFromNamespace('http://schemas.xmlsoap.org/soap/encoding/') .
                        ':arrayType="' .
                        $this->getPrefixFromNamespace($this->getPrefix($typeDef['arrayType'])) .
                        ':' .
                        $this->getLocalPart($typeDef['arrayType']) . "[0]\"/>";
                }
                $this->debug("in serializeType: returning: $xml");
                return $xml;
            }
            if (isset($typeDef['multidimensional'])) {
                $nv = array();
                foreach ($value as $v) {
                    $cols = ',' . sizeof($v);
                    $nv = array_merge($nv, $v);
                }
                $value = $nv;
            } else {
                $cols = '';
            }
            if (is_array($value) && sizeof($value) >= 1) {
                $rows = sizeof($value);
                $contents = '';
                foreach ($value as $k => $v) {
                    $this->debug("serializing array element: $k, $v of type: $typeDef[arrayType]");
                    //if (strpos($typeDef['arrayType'], ':') ) {
                    if (!in_array($typeDef['arrayType'], $this->typemap['http://www.w3.org/2001/XMLSchema'])) {
                        $contents .= $this->serializeType('item', $typeDef['arrayType'], $v, $use);
                    } else {
                        $contents .= $this->serialize_val($v, 'item', $typeDef['arrayType'], null, $this->XMLSchemaVersion, false, $use);
                    }
                }
            } else {
                $rows = 0;
                $contents = null;
            }
            // TODO: for now, an empty value will be serialized as a zero element
            // array.  Revisit this when coding the handling of null/nil values.
            if ($use == 'literal') {
                $xml = "<$name$elementNS>"
                    . $contents
                    . "</$name>";
            } else {
                $xml = "<$name$elementNS xsi:type=\"" . $this->getPrefixFromNamespace('http://schemas.xmlsoap.org/soap/encoding/') . ':Array" ' .
                    $this->getPrefixFromNamespace('http://schemas.xmlsoap.org/soap/encoding/')
                    . ':arrayType="'
                    . $this->getPrefixFromNamespace($this->getPrefix($typeDef['arrayType']))
                    . ":" . $this->getLocalPart($typeDef['arrayType']) . "[$rows$cols]\">"
                    . $contents
                    . "</$name>";
            }
        } elseif ($phpType == 'scalar') {
            if (isset($typeDef['form']) && ($typeDef['form'] == 'qualified')) {
                $elementNS = " xmlns=\"$ns\"";
            } else {
                if ($unqualified) {
                    $elementNS = " xmlns=\"\"";
                } else {
                    $elementNS = '';
                }
            }
            if ($use == 'literal') {
                if ($forceType) {
                    $xml = "<$name$elementNS xsi:type=\"" . $this->getPrefixFromNamespace($ns) . ":$uqType\">$value</$name>";
                } else {
                    $xml = "<$name$elementNS>$value</$name>";
                }
            } else {
                $xml = "<$name$elementNS xsi:type=\"" . $this->getPrefixFromNamespace($ns) . ":$uqType\"$encodingStyle>$value</$name>";
            }
        }
        $this->debug("in serializeType: returning: $xml");
        return $xml;
    }

References $cols, $name, $rows, $type, $xml, nusoap_base\appendDebug(), nusoap_base\debug(), nusoap_base\expandEntities(), nusoap_base\getLocalPart(), nusoap_base\getNamespaceFromPrefix(), nusoap_base\getPrefix(), nusoap_base\getPrefixFromNamespace(), getTypeDef(), nusoap_base\serialize_val(), serializeComplexTypeAttributes(), serializeComplexTypeElements(), serializeType(), nusoap_base\setError(), and nusoap_base\varDump().

Referenced by serializeComplexTypeElements(), serializeParameters(), serializeRPCParameters(), and serializeType().

Here is the call graph for this function:

Here is the caller graph for this function:

setCredentials()

wsdl::setCredentials	(		$username,
			$password,
			$authtype = 'basic',
			$certRequest = array()
	)

if authenticating, set user credentials here

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) @access public

Definition at line 5170 of file nusoap.php.

    {
        $this->debug("setCredentials username=$username authtype=$authtype certRequest=");
        $this->appendDebug($this->varDump($certRequest));
        $this->username = $username;
        $this->password = $password;
        $this->authtype = $authtype;
        $this->certRequest = $certRequest;
    }

References $authtype, $certRequest, $password, $username, nusoap_base\appendDebug(), nusoap_base\debug(), and nusoap_base\varDump().

Referenced by nusoap_client\loadWSDL().

Here is the call graph for this function:

Here is the caller graph for this function:

start_element()

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 @access private

Definition at line 4906 of file nusoap.php.

    {
        if ($this->status == 'schema') {
            $this->currentSchema->schemaStartElement($parser, $name, $attrs);
            $this->appendDebug($this->currentSchema->getDebug());
            $this->currentSchema->clearDebug();
        } elseif (preg_match('/schema$/', $name)) {
            $this->debug('Parsing WSDL schema');
            // $this->debug("startElement for $name ($attrs[name]). status = $this->status (".$this->getLocalPart($name).")");
            $this->status = 'schema';
            $this->currentSchema = new nusoap_xmlschema('', '', $this->namespaces);
            $this->currentSchema->schemaStartElement($parser, $name, $attrs);
            $this->appendDebug($this->currentSchema->getDebug());
            $this->currentSchema->clearDebug();
        } else {
            // position in the total number of elements, starting from 0
            $pos = $this->position++;
            $depth = $this->depth++;
            // set self as current value for this depth
            $this->depth_array[$depth] = $pos;
            $this->message[$pos] = array('cdata' => '');
            // process attributes
            if (count($attrs) > 0) {
                // register namespace declarations
                foreach ($attrs as $k => $v) {
                    if (preg_match('/^xmlns/', $k)) {
                        if ($ns_prefix = substr(strrchr($k, ':'), 1)) {
                            $this->namespaces[$ns_prefix] = $v;
                        } else {
                            $this->namespaces['ns' . (count($this->namespaces) + 1)] = $v;
                        }
                        if ($v == 'http://www.w3.org/2001/XMLSchema' || $v == 'http://www.w3.org/1999/XMLSchema' || $v == 'http://www.w3.org/2000/10/XMLSchema') {
                            $this->XMLSchemaVersion = $v;
                            $this->namespaces['xsi'] = $v . '-instance';
                        }
                    }
                }
                // expand each attribute prefix to its namespace
                foreach ($attrs as $k => $v) {
                    $k = strpos($k, ':') ? $this->expandQname($k) : $k;
                    if ($k != 'location' && $k != 'soapAction' && $k != 'namespace') {
                        $v = strpos($v, ':') ? $this->expandQname($v) : $v;
                    }
                    $eAttrs[$k] = $v;
                }
                $attrs = $eAttrs;
            } else {
                $attrs = array();
            }
            // get element prefix, namespace and name
            if (preg_match('/:/', $name)) {
                // get ns prefix
                $prefix = substr($name, 0, strpos($name, ':'));
                // get ns
                $namespace = isset($this->namespaces[$prefix]) ? $this->namespaces[$prefix] : '';
                // get unqualified name
                $name = substr(strstr($name, ':'), 1);
            }
            // process attributes, expanding any prefixes to namespaces
            // find status, register data
            switch ($this->status) {
                case 'message':
                    if ($name == 'part') {
                        if (isset($attrs['type'])) {
                            $this->debug("msg " . $this->currentMessage . ": found part (with type) $attrs[name]: " . implode(',', $attrs));
                            $this->messages[$this->currentMessage][$attrs['name']] = $attrs['type'];
                        }
                        if (isset($attrs['element'])) {
                            $this->debug("msg " . $this->currentMessage . ": found part (with element) $attrs[name]: " . implode(',', $attrs));
                            $this->messages[$this->currentMessage][$attrs['name']] = $attrs['element'] . '^';
                        }
                    }
                    break;
                case 'portType':
                    switch ($name) {
                        case 'operation':
                            $this->currentPortOperation = $attrs['name'];
                            $this->debug("portType $this->currentPortType operation: $this->currentPortOperation");
                            if (isset($attrs['parameterOrder'])) {
                                $this->portTypes[$this->currentPortType][$attrs['name']]['parameterOrder'] = $attrs['parameterOrder'];
                            }
                            break;
                        case 'documentation':
                            $this->documentation = true;
                            break;
                        // merge input/output data
                        default:
                            $m = isset($attrs['message']) ? $this->getLocalPart($attrs['message']) : '';
                            $this->portTypes[$this->currentPortType][$this->currentPortOperation][$name]['message'] = $m;
                            break;
                    }
                    break;
                case 'binding':
                    switch ($name) {
                        case 'binding':
                            // get ns prefix
                            if (isset($attrs['style'])) {
                                $this->bindings[$this->currentBinding]['prefix'] = $prefix;
                            }
                            $this->bindings[$this->currentBinding] = array_merge($this->bindings[$this->currentBinding], $attrs);
                            break;
                        case 'header':
                            $this->bindings[$this->currentBinding]['operations'][$this->currentOperation][$this->opStatus]['headers'][] = $attrs;
                            break;
                        case 'operation':
                            if (isset($attrs['soapAction'])) {
                                $this->bindings[$this->currentBinding]['operations'][$this->currentOperation]['soapAction'] = $attrs['soapAction'];
                            }
                            if (isset($attrs['style'])) {
                                $this->bindings[$this->currentBinding]['operations'][$this->currentOperation]['style'] = $attrs['style'];
                            }
                            if (isset($attrs['name'])) {
                                $this->currentOperation = $attrs['name'];
                                $this->debug("current binding operation: $this->currentOperation");
                                $this->bindings[$this->currentBinding]['operations'][$this->currentOperation]['name'] = $attrs['name'];
                                $this->bindings[$this->currentBinding]['operations'][$this->currentOperation]['binding'] = $this->currentBinding;
                                $this->bindings[$this->currentBinding]['operations'][$this->currentOperation]['endpoint'] = isset($this->bindings[$this->currentBinding]['endpoint']) ? $this->bindings[$this->currentBinding]['endpoint'] : '';
                            }
                            break;
                        case 'input':
                            $this->opStatus = 'input';
                            break;
                        case 'output':
                            $this->opStatus = 'output';
                            break;
                        case 'body':
                            if (isset($this->bindings[$this->currentBinding]['operations'][$this->currentOperation][$this->opStatus])) {
                                $this->bindings[$this->currentBinding]['operations'][$this->currentOperation][$this->opStatus] = array_merge($this->bindings[$this->currentBinding]['operations'][$this->currentOperation][$this->opStatus], $attrs);
                            } else {
                                $this->bindings[$this->currentBinding]['operations'][$this->currentOperation][$this->opStatus] = $attrs;
                            }
                            break;
                    }
                    break;
                case 'service':
                    switch ($name) {
                        case 'port':
                            $this->currentPort = $attrs['name'];
                            $this->debug('current port: ' . $this->currentPort);
                            $this->ports[$this->currentPort]['binding'] = $this->getLocalPart($attrs['binding']);
 
                            break;
                        case 'address':
                            $this->ports[$this->currentPort]['location'] = $attrs['location'];
                            $this->ports[$this->currentPort]['bindingType'] = $namespace;
                            $this->bindings[ $this->ports[$this->currentPort]['binding'] ]['bindingType'] = $namespace;
                            $this->bindings[ $this->ports[$this->currentPort]['binding'] ]['endpoint'] = $attrs['location'];
                            break;
                    }
                    break;
            }
            // set status
            switch ($name) {
            case 'import':
                if (isset($attrs['location'])) {
                    $this->import[$attrs['namespace']][] = array('location' => $attrs['location'], 'loaded' => false);
                    $this->debug('parsing import ' . $attrs['namespace'] . ' - ' . $attrs['location'] . ' (' . count($this->import[$attrs['namespace']]) . ')');
                } else {
                    $this->import[$attrs['namespace']][] = array('location' => '', 'loaded' => true);
                    if (! $this->getPrefixFromNamespace($attrs['namespace'])) {
                        $this->namespaces['ns' . (count($this->namespaces)+1)] = $attrs['namespace'];
                    }
                    $this->debug('parsing import ' . $attrs['namespace'] . ' - [no location] (' . count($this->import[$attrs['namespace']]) . ')');
                }
                break;
            //wait for schema
            //case 'types':
            //  $this->status = 'schema';
            //  break;
            case 'message':
                $this->status = 'message';
                $this->messages[$attrs['name']] = array();
                $this->currentMessage = $attrs['name'];
                break;
            case 'portType':
                $this->status = 'portType';
                $this->portTypes[$attrs['name']] = array();
                $this->currentPortType = $attrs['name'];
                break;
            case "binding":
                if (isset($attrs['name'])) {
                    // get binding name
                    if (strpos($attrs['name'], ':')) {
                        $this->currentBinding = $this->getLocalPart($attrs['name']);
                    } else {
                        $this->currentBinding = $attrs['name'];
                    }
                    $this->status = 'binding';
                    $this->bindings[$this->currentBinding]['portType'] = $this->getLocalPart($attrs['type']);
                    $this->debug("current binding: $this->currentBinding of portType: " . $attrs['type']);
                }
                break;
            case 'service':
                $this->serviceName = $attrs['name'];
                $this->status = 'service';
                $this->debug('current service: ' . $this->serviceName);
                break;
            case 'definitions':
                foreach ($attrs as $name => $value) {
                    $this->wsdl_info[$name] = $value;
                }
                break;
            }
        }
    }

References $currentBinding, $currentMessage, $currentOperation, $currentPort, $currentPortType, $depth, $name, $namespace, $parser, nusoap_base\appendDebug(), nusoap_base\debug(), nusoap_base\expandQname(), nusoap_base\getLocalPart(), and nusoap_base\getPrefixFromNamespace().

Here is the call graph for this function:

webDescription()

wsdl::webDescription

(

)

prints html description of services

@access private

Definition at line 5354 of file nusoap.php.

    {
        global $HTTP_SERVER_VARS;
 
        if (isset($_SERVER)) {
            $PHP_SELF = $_SERVER['PHP_SELF'];
        } elseif (isset($HTTP_SERVER_VARS)) {
            $PHP_SELF = $HTTP_SERVER_VARS['PHP_SELF'];
        } else {
            $this->setError("Neither _SERVER nor HTTP_SERVER_VARS is available");
        }
        // begin-patch: https://mantis.ilias.de/view.php?id=28866
        $PHP_SELF = filter_var($PHP_SELF, FILTER_SANITIZE_STRING);
        // end-patch
 
        $b = '
                <html><head><title>NuSOAP: ' . $this->serviceName . '</title>
                <style type="text/css">
                    body    { font-family: arial; color: #000000; background-color: #ffffff; margin: 0px 0px 0px 0px; }
                    p       { font-family: arial; color: #000000; margin-top: 0px; margin-bottom: 12px; }
                    pre { background-color: silver; padding: 5px; font-family: Courier New; font-size: x-small; color: #000000;}
                    ul      { margin-top: 10px; margin-left: 20px; }
                    li      { list-style-type: none; margin-top: 10px; color: #000000; }
                    .content{
                        margin-left: 0px; padding-bottom: 2em; }
                    .nav {
                        padding-top: 10px; padding-bottom: 10px; padding-left: 15px; font-size: .70em;
                        margin-top: 10px; margin-left: 0px; color: #000000;
                        background-color: #ccccff; width: 20%; margin-left: 20px; margin-top: 20px; }
                    .title {
                        font-family: arial; font-size: 26px; color: #ffffff;
                        background-color: #999999; width: 105%; margin-left: 0px;
                        padding-top: 10px; padding-bottom: 10px; padding-left: 15px;}
                    .hidden {
                        position: absolute; visibility: hidden; z-index: 200; left: 250px; top: 100px;
                        font-family: arial; overflow: hidden; width: 600;
                        padding: 20px; font-size: 10px; background-color: #999999;
                        layer-background-color:#FFFFFF; }
                    a,a:active  { color: charcoal; font-weight: bold; }
                    a:visited   { color: #666666; font-weight: bold; }
                    a:hover     { color: cc3300; font-weight: bold; }
                </style>
                <script language="JavaScript" type="text/javascript">
                <!--
                // POP-UP CAPTIONS...
                function lib_bwcheck(){ //Browsercheck (needed)
                    this.ver=navigator.appVersion
                    this.agent=navigator.userAgent
                    this.dom=document.getElementById?1:0
                    this.opera5=this.agent.indexOf("Opera 5")>-1
                    this.ie5=(this.ver.indexOf("MSIE 5")>-1 && this.dom && !this.opera5)?1:0;
                    this.ie6=(this.ver.indexOf("MSIE 6")>-1 && this.dom && !this.opera5)?1:0;
                    this.ie4=(document.all && !this.dom && !this.opera5)?1:0;
                    this.ie=this.ie4||this.ie5||this.ie6
                    this.mac=this.agent.indexOf("Mac")>-1
                    this.ns6=(this.dom && parseInt(this.ver) >= 5) ?1:0;
                    this.ns4=(document.layers && !this.dom)?1:0;
                    this.bw=(this.ie6 || this.ie5 || this.ie4 || this.ns4 || this.ns6 || this.opera5)
                    return this
                }
                var bw = new lib_bwcheck()
                //Makes crossbrowser object.
                function makeObj(obj){
                    this.evnt=bw.dom? document.getElementById(obj):bw.ie4?document.all[obj]:bw.ns4?document.layers[obj]:0;
                    if(!this.evnt) return false
                    this.css=bw.dom||bw.ie4?this.evnt.style:bw.ns4?this.evnt:0;
                    this.wref=bw.dom||bw.ie4?this.evnt:bw.ns4?this.css.document:0;
                    this.writeIt=b_writeIt;
                    return this
                }
                // A unit of measure that will be added when setting the position of a layer.
                //var px = bw.ns4||window.opera?"":"px";
                function b_writeIt(text){
                    if (bw.ns4){this.wref.write(text);this.wref.close()}
                    else this.wref.innerHTML = text
                }
                //Shows the messages
                var oDesc;
                function popup(divid){
                    if(oDesc = new makeObj(divid)){
                        oDesc.css.visibility = "visible"
                    }
                }
                function popout(){ // Hides message
                    if(oDesc) oDesc.css.visibility = "hidden"
                }
                //-->
                </script>
                </head>
                <body>
                <div class=content>
                        <br><br>
                        <div class=title>' . $this->serviceName . '</div>
                        <div class=nav>
                                <p>View the <a href="' . $PHP_SELF . '?wsdl">WSDL</a> for the service.
                                Click on an operation name to view it&apos;s details.</p>
                                <ul>';
        foreach ($this->getOperations() as $op => $data) {
            // begin-patch: https://mantis.ilias.de/view.php?id=28866
            if (isset($data['endpoint'])) {
                $data['endpoint'] = filter_var($data['endpoint'], FILTER_SANITIZE_STRING);
            }
            // end-patch
            $b .= "<li><a href='#' onclick=\"popout();popup('$op')\">$op</a></li>";
            // create hidden div
            $b .= "<div id='$op' class='hidden'>
                                    <a href='#' onclick='popout()'><font color='#ffffff'>Close</font></a><br><br>";
            foreach ($data as $donnie => $marie) { // loop through opdata
                        if ($donnie == 'input' || $donnie == 'output') { // show input/output data
                            $b .= "<font color='white'>" . ucfirst($donnie) . ':</font><br>';
                            foreach ($marie as $captain => $tenille) { // loop through data
                                if ($captain == 'parts') { // loop thru parts
                                    $b .= "&nbsp;&nbsp;$captain:<br>";
                                    //if(is_array($tenille)){
                                    foreach ($tenille as $joanie => $chachi) {
                                        $b .= "&nbsp;&nbsp;&nbsp;&nbsp;$joanie: $chachi<br>";
                                    }
                                    //}
                                } else {
                                    $b .= "&nbsp;&nbsp;$captain: $tenille<br>";
                                }
                            }
                        } else {
                            $b .= "<font color='white'>" . ucfirst($donnie) . ":</font> $marie<br>";
                        }
            }
            $b .= '</div>';
        }
        $b .= '
                                <ul>
                        </div>
                </div></body></html>';
        return $b;
    }

References $_SERVER, Vendor\Package\$b, $data, getOperations(), and nusoap_base\setError().

Referenced by nusoap_server\service().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$authtype

wsdl::$authtype = ''

Definition at line 4658 of file nusoap.php.

Referenced by setCredentials().

$bindings

wsdl::$bindings = array()

Definition at line 4631 of file nusoap.php.

$certRequest

wsdl::$certRequest = array()

Definition at line 4659 of file nusoap.php.

Referenced by setCredentials().

$complexTypes

wsdl::$complexTypes = array()

Definition at line 4625 of file nusoap.php.

$curl_options

wsdl::$curl_options = array()

Definition at line 4653 of file nusoap.php.

Referenced by __construct().

$currentBinding

wsdl::$currentBinding

Definition at line 4632 of file nusoap.php.

Referenced by start_element().

$currentMessage

wsdl::$currentMessage

Definition at line 4627 of file nusoap.php.

Referenced by start_element().

$currentOperation

wsdl::$currentOperation

Definition at line 4628 of file nusoap.php.

Referenced by start_element().

$currentPort

wsdl::$currentPort

Definition at line 4634 of file nusoap.php.

Referenced by start_element().

$currentPortType

wsdl::$currentPortType

Definition at line 4630 of file nusoap.php.

Referenced by start_element().

$currentSchema

wsdl::$currentSchema

Definition at line 4623 of file nusoap.php.

Referenced by end_element().

$depth

wsdl::$depth = 0

Definition at line 4644 of file nusoap.php.

Referenced by character_data(), and start_element().

$depth_array

wsdl::$depth_array = array()

Definition at line 4645 of file nusoap.php.

$documentation

wsdl::$documentation = false

Definition at line 4637 of file nusoap.php.

Referenced by addOperation().

$endpoint

wsdl::$endpoint = ''

Definition at line 4638 of file nusoap.php.

$import

wsdl::$import = array()

Definition at line 4640 of file nusoap.php.

$message

wsdl::$message = array()

Definition at line 4624 of file nusoap.php.

$messages

wsdl::$messages = array()

Definition at line 4626 of file nusoap.php.

$opData

wsdl::$opData = array()

Definition at line 4635 of file nusoap.php.

Referenced by getOperationData(), getOperationDataForSoapAction(), serializeParameters(), and serializeRPCParameters().

$parser

wsdl::$parser

Definition at line 4642 of file nusoap.php.

Referenced by end_element(), and start_element().

$password

wsdl::$password = ''

Definition at line 4657 of file nusoap.php.

Referenced by setCredentials().

$ports

wsdl::$ports = array()

Definition at line 4633 of file nusoap.php.

$portTypes

wsdl::$portTypes = array()

Definition at line 4629 of file nusoap.php.

$position

wsdl::$position = 0

Definition at line 4643 of file nusoap.php.

$proxyhost

wsdl::$proxyhost = ''

Definition at line 4647 of file nusoap.php.

Referenced by __construct().

$proxypassword

wsdl::$proxypassword = ''

Definition at line 4650 of file nusoap.php.

Referenced by __construct().

$proxyport

wsdl::$proxyport = ''

Definition at line 4648 of file nusoap.php.

Referenced by __construct().

$proxyusername

wsdl::$proxyusername = ''

Definition at line 4649 of file nusoap.php.

Referenced by __construct().

$response_timeout

wsdl::$response_timeout = 30

Definition at line 4652 of file nusoap.php.

Referenced by __construct().

$schemas

wsdl::$schemas = array()

Definition at line 4622 of file nusoap.php.

$status

wsdl::$status = ''

Definition at line 4636 of file nusoap.php.

$timeout

wsdl::$timeout = 0

Definition at line 4651 of file nusoap.php.

Referenced by __construct().

$use_curl

wsdl::$use_curl = false

Definition at line 4654 of file nusoap.php.

Referenced by __construct().

$username

wsdl::$username = ''

Definition at line 4656 of file nusoap.php.

Referenced by setCredentials().

$wsdl

wsdl::$wsdl

Definition at line 4620 of file nusoap.php.

Referenced by __construct(), fetchWSDL(), and parseWSDL().

---

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

• webservice/soap/lib/nusoap.php