[nu]soapclient higher level class for easy usage. More...

Inheritance diagram for nusoap_client:

Collaboration diagram for nusoap_client:

Public Member Functions
	__construct ($endpoint, $wsdl=false, $proxyhost=false, $proxyport=false, $proxyusername=false, $proxypassword=false, $timeout=0, $response_timeout=30)
	constructor More...

	call ($operation, $params=array(), $namespace='http://tempuri.org', $soapAction='', $headers=false, $rpcParams=null, $style='rpc', $use='encoded')
	calls method, returns PHP native type More...

	checkWSDL ()
	check WSDL passed as an instance or pulled from an endpoint More...

	loadWSDL ()
	instantiate wsdl object and parse wsdl file More...

	getOperationData ($operation)
	get available data pertaining to an operation More...

	send ($msg, $soapaction='', $timeout=0, $response_timeout=30)
	send the SOAP message More...

	parseResponse ($headers, $data)
	processes SOAP message returned from server More...

	setCurlOption ($option, $value)
	sets user-specified cURL options More...

	setEndpoint ($endpoint)
	sets the SOAP endpoint, which can override WSDL More...

	setHeaders ($headers)
	set the SOAP headers More...

	getHeaders ()
	get the SOAP response headers (namespace resolution incomplete) More...

	getHeader ()
	get the SOAP response Header (parsed) More...

	setHTTPProxy ($proxyhost, $proxyport, $proxyusername='', $proxypassword='')
	set proxy info here More...

	setCredentials ($username, $password, $authtype='basic', $certRequest=array())
	if authenticating, set user credentials here More...

	setHTTPEncoding ($enc='gzip, deflate')
	use HTTP encoding More...

	setUseCURL ($use)
	Set whether to try to use cURL connections if possible. More...

	useHTTPPersistentConnection ()
	use HTTP persistent connections if possible More...

	getDefaultRpcParams ()
	gets the default RPC parameter setting. More...

	setDefaultRpcParams ($rpcParams)
	sets the default RPC parameter setting. More...

	getProxy ()
	dynamically creates an instance of a proxy class, allowing user to directly call methods from wsdl More...

	_getProxyClassCode ($r)
	dynamically creates proxy class code More...

	getProxyClassCode ()
	dynamically creates proxy class code More...

	getHTTPBody ($soapmsg)
	gets the HTTP body for the current request. More...

	getHTTPContentType ()
	gets the HTTP content type for the current request. More...

	getHTTPContentTypeCharset ()
	gets the HTTP content type charset for the current request. More...

	decodeUTF8 ($bool)

	setCookie ($name, $value)
	adds a new Cookie into $this->cookies array More...

	getCookies ()
	gets all Cookies More...

	checkCookies ()
	checks all Cookies and delete those which are expired More...

	UpdateCookies ($cookies)
	updates the current cookies with a new set More...

Public Member Functions inherited from nusoap_base
	debug ($string)
	adds debug data to the class level debug string 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')
	serializes PHP values in accordance w/ section 5. More...

	serializeEnvelope ($body, $headers=false, $namespaces=array(), $style='rpc', $use='encoded')
	serialize message More...

	formatDump ($str)

	contractQname ($qname)
	contracts a qualified name More...

	expandQname ($qname)
	expands 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 returns false if no namespace registered with the given prefix More...

	getPrefixFromNamespace ($ns)
	returns the prefix for a given namespace (or prefix) or false if no prefixes registered for the given namespace More...

	varDump ($data)

	__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
	$username = ''

	$password = ''

	$authtype = ''

	$certRequest = array()

	$requestHeaders = false

	$responseHeaders = ''

	$responseHeader = NULL

	$document = ''

	$endpoint

	$forceEndpoint = ''

	$proxyhost = ''

	$proxyport = ''

	$proxyusername = ''

	$proxypassword = ''

	$xml_encoding = ''

	$http_encoding = false

	$timeout = 0

	$response_timeout = 30

	$endpointType = ''

	$persistentConnection = false

	$defaultRpcParams = false

	$request = ''

	$response = ''

	$responseData = ''

	$cookies = array()

	$decode_utf8 = true

	$operations = array()

	$curl_options = array()

	$bindingType = ''

	$use_curl = false

	$fault

	$faultcode

	$faultstring

	$faultdetail

Data Fields inherited from nusoap_base
	$title = 'NuSOAP'

	$version = '0.6.7'

	$revision = '$Revision$'

	$error_str = false

	$debug_str = ''

	$charencoding = true

	$XMLSchemaVersion = 'http://www.w3.org/2001/XMLSchema'

	$soap_defencoding = 'UTF-8'

	$namespaces

	$usedNamespaces = array()

	$typemap

	$xmlEntities

	$debugLevel

Detailed Description

[nu]soapclient higher level class for easy usage.

usage:

// instantiate client with server info $soapclient = new nusoap_client( string path [ ,mixed wsdl] );

// call method, get results echo $soapclient->call( string methodname [ ,array parameters] );

// bye bye client unset($soapclient);

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$ public

Definition at line 7064 of file nusoap.php.

Constructor & Destructor Documentation

◆ __construct()

nusoap_client::__construct	(	$endpoint,
		$wsdl = `false`,
		$proxyhost = `false`,
		$proxyport = `false`,
		$proxyusername = `false`,
		$proxypassword = `false`,
		$timeout = `0`,
		$response_timeout = `30`
	)

constructor

Parameters

mixed	$endpoint	SOAP server or WSDL URL (string), or wsdl instance (object)
bool	$wsdl	optional, set to true if using WSDL
int	$portName	optional portName in WSDL document
string	$proxyhost
string	$proxyport
string	$proxyusername
string	$proxypassword
integer	$timeout	set the connection timeout
integer	$response_timeout	set the response timeout public

Definition at line 7135 of file nusoap.php.

References $endpoint, nusoap_base\appendDebug(), nusoap_base\debug(), nusoap_base\varDump(), and wsdl\wsdl().

                                                                                                                                                                                 {
                 parent::__construct();
                 $this->endpoint = $endpoint;
                 $this->proxyhost = $proxyhost;
                 $this->proxyport = $proxyport;
                 $this->proxyusername = $proxyusername;
                 $this->proxypassword = $proxypassword;
                 $this->timeout = $timeout;
                 $this->response_timeout = $response_timeout;
 
                 $this->debug("ctor wsdl=$wsdl timeout=$timeout response_timeout=$response_timeout");
                 $this->appendDebug('endpoint=' . $this->varDump($endpoint));
 
                 // make values
                 if($wsdl){
                         if (is_object($endpoint) && (get_class($endpoint) == 'wsdl')) {
                                 $this->wsdl = $endpoint;
                                 $this->endpoint = $this->wsdl->wsdl;
                                 $this->wsdlFile = $this->endpoint;
                                 $this->debug('existing wsdl instance created from ' . $this->endpoint);
                                 $this->checkWSDL();
                         } else {
                                 $this->wsdlFile = $this->endpoint;
                                 $this->wsdl = null;
                                 $this->debug('will use lazy evaluation of wsdl from ' . $this->endpoint);
                         }
                         $this->endpointType = 'wsdl';
                 } else {
                         $this->debug("instantiate SOAP with endpoint at $endpoint");
                         $this->endpointType = 'soap';
                 }
         }

Here is the call graph for this function:

Member Function Documentation

◆ _getProxyClassCode()

nusoap_client::_getProxyClassCode ( $r )

dynamically creates proxy class code

Returns: string PHP/NuSOAP code for the proxy class private

Definition at line 7773 of file nusoap.php.

References $name, $type, nusoap_base\appendDebug(), nusoap_base\debug(), nusoap_base\getError(), nusoap_base\setError(), and nusoap_base\varDump().

                                         {
                 $this->debug("in getProxy endpointType=$this->endpointType");
                 $this->appendDebug("wsdl=" . $this->varDump($this->wsdl));
                 if ($this->endpointType != 'wsdl') {
                         $evalStr = 'A proxy can only be created for a WSDL client';
                         $this->setError($evalStr);
                         $evalStr = "echo \"$evalStr\";";
                         return $evalStr;
                 }
                 if ($this->endpointType == 'wsdl' && is_null($this->wsdl)) {
                         $this->loadWSDL();
                         if ($this->getError()) {
                                 return "echo \"" . $this->getError() . "\";";
                         }
                 }
                 $evalStr = '';
                 foreach ($this->operations as $operation => $opData) {
                         if ($operation != '') {
                                 // create param string and param comment string
                                 if (sizeof($opData['input']['parts']) > 0) {
                                         $paramStr = '';
                                         $paramArrayStr = '';
                                         $paramCommentStr = '';
                                         foreach ($opData['input']['parts'] as $name => $type) {
                                                 $paramStr .= "\$$name, ";
                                                 $paramArrayStr .= "'$name' => \$$name, ";
                                                 $paramCommentStr .= "$type \$$name, ";
                                         }
                                         $paramStr = substr($paramStr, 0, strlen($paramStr)-2);
                                         $paramArrayStr = substr($paramArrayStr, 0, strlen($paramArrayStr)-2);
                                         $paramCommentStr = substr($paramCommentStr, 0, strlen($paramCommentStr)-2);
                                 } else {
                                         $paramStr = '';
                                         $paramArrayStr = '';
                                         $paramCommentStr = 'void';
                                 }
                                 $opData['namespace'] = !isset($opData['namespace']) ? 'http://testuri.com' : $opData['namespace'];
                                 $evalStr .= "// $paramCommentStr
         function " . str_replace('.', '__', $operation) . "($paramStr) {
                 \$params = array($paramArrayStr);
                 return \$this->call('$operation', \$params, '".$opData['namespace']."', '".(isset($opData['soapAction']) ? $opData['soapAction'] : '')."');
         }
         ";
                                 unset($paramStr);
                                 unset($paramCommentStr);
                         }
                 }
                 $evalStr = 'class nusoap_proxy_'.$r.' extends nusoap_client {
         '.$evalStr.'
 }';
                 return $evalStr;
         }

Here is the call graph for this function:

◆ call()

nusoap_client::call	(	$operation,
		$params = `array()`,
		$namespace = `'http://tempuri.org'`,
		$soapAction = `''`,
		$headers = `false`,
		$rpcParams = `null`,
		$style = `'rpc'`,
		$use = `'encoded'`
	)

calls method, returns PHP native type

Parameters

string	$operation	SOAP server URL or path
mixed	$params	An array, associative or simple, of the parameters for the method call, or a string that is the XML for the call. For rpc style, this call will wrap the XML in a tag named after the method, as well as the SOAP Envelope and Body. For document style, this will only wrap with the Envelope and Body. IMPORTANT: when using an array with document style, in which case there is really one parameter, the root of the fragment used in the call, which encloses what programmers normally think of parameters. A parameter array must include the wrapper.
string	$namespace	optional method namespace (WSDL can override)
string	$soapAction	optional SOAPAction value (WSDL can override)
mixed	$headers	optional string of XML with SOAP header content, or array of soapval objects for SOAP headers, or associative array
boolean	$rpcParams	optional (no longer used)
string	$style	optional (rpc\|document) the style to use when serializing parameters (WSDL can override)
string	$use	optional (encoded\|literal) the use when serializing parameters (WSDL can override)

Returns: mixed response from SOAP call public

Definition at line 7193 of file nusoap.php.

References $namespace, $params, $style, nusoap_base\appendDebug(), array, nusoap_base\clearDebug(), nusoap_base\debug(), nusoap_base\getDebug(), nusoap_base\getError(), nusoap_base\getPrefixFromNamespace(), nusoap_base\serialize_val(), nusoap_base\serializeEnvelope(), wsdl\serializeRPCParameters(), nusoap_base\setError(), and nusoap_base\varDump().

                                                                  ://tempuri.org',$soapAction='',$headers=false,$rpcParams=null,$style='rpc',$use='encoded'){
                 $this->operation = $operation;
                 $this->fault = false;
                 $this->setError('');
                 $this->request = '';
                 $this->response = '';
                 $this->responseData = '';
                 $this->faultstring = '';
                 $this->faultcode = '';
                 $this->opData = array();
                 
                 $this->debug("call: operation=$operation, namespace=$namespace, soapAction=$soapAction, rpcParams=$rpcParams, style=$style, use=$use, endpointType=$this->endpointType");
                 $this->appendDebug('params=' . $this->varDump($params));
                 $this->appendDebug('headers=' . $this->varDump($headers));
                 if ($headers) {
                         $this->requestHeaders = $headers;
                 }
                 if ($this->endpointType == 'wsdl' && is_null($this->wsdl)) {
                         $this->loadWSDL();
                         if ($this->getError())
                                 return false;
                 }
                 // serialize parameters
                 if($this->endpointType == 'wsdl' && $opData = $this->getOperationData($operation)){
                         // use WSDL for operation
                         $this->opData = $opData;
                         $this->debug("found operation");
                         $this->appendDebug('opData=' . $this->varDump($opData));
                         if (isset($opData['soapAction'])) {
                                 $soapAction = $opData['soapAction'];
                         }
                         if (! $this->forceEndpoint) {
                                 $this->endpoint = $opData['endpoint'];
                         } else {
                                 $this->endpoint = $this->forceEndpoint;
                         }
                         $namespace = isset($opData['input']['namespace']) ? $opData['input']['namespace'] :     $namespace;
                         $style = $opData['style'];
                         $use = $opData['input']['use'];
                         // add ns to ns array
                         if($namespace != '' && !isset($this->wsdl->namespaces[$namespace])){
                                 $nsPrefix = 'ns' . rand(1000, 9999);
                                 $this->wsdl->namespaces[$nsPrefix] = $namespace;
                         }
             $nsPrefix = $this->wsdl->getPrefixFromNamespace($namespace);
                         // serialize payload
                         if (is_string($params)) {
                                 $this->debug("serializing param string for WSDL operation $operation");
                                 $payload = $params;
                         } elseif (is_array($params)) {
                                 $this->debug("serializing param array for WSDL operation $operation");
                                 $payload = $this->wsdl->serializeRPCParameters($operation,'input',$params,$this->bindingType);
                         } else {
                                 $this->debug('params must be array or string');
                                 $this->setError('params must be array or string');
                                 return false;
                         }
             $usedNamespaces = $this->wsdl->usedNamespaces;
                         if (isset($opData['input']['encodingStyle'])) {
                                 $encodingStyle = $opData['input']['encodingStyle'];
                         } else {
                                 $encodingStyle = '';
                         }
                         $this->appendDebug($this->wsdl->getDebug());
                         $this->wsdl->clearDebug();
                         if ($errstr = $this->wsdl->getError()) {
                                 $this->debug('got wsdl error: '.$errstr);
                                 $this->setError('wsdl error: '.$errstr);
                                 return false;
                         }
                 } elseif($this->endpointType == 'wsdl') {
                         // operation not in WSDL
                         $this->appendDebug($this->wsdl->getDebug());
                         $this->wsdl->clearDebug();
                         $this->setError( 'operation '.$operation.' not present.');
                         $this->debug("operation '$operation' not present.");
                         return false;
                 } else {
                         // no WSDL
                         //$this->namespaces['ns1'] = $namespace;
                         $nsPrefix = 'ns' . rand(1000, 9999);
                         // serialize 
                         $payload = '';
                         if (is_string($params)) {
                                 $this->debug("serializing param string for operation $operation");
                                 $payload = $params;
                         } elseif (is_array($params)) {
                                 $this->debug("serializing param array for operation $operation");
                                 foreach($params as $k => $v){
                                         $payload .= $this->serialize_val($v,$k,false,false,false,false,$use);
                                 }
                         } else {
                                 $this->debug('params must be array or string');
                                 $this->setError('params must be array or string');
                                 return false;
                         }
                         $usedNamespaces = array();
                         if ($use == 'encoded') {
                                 $encodingStyle = 'http://schemas.xmlsoap.org/soap/encoding/';
                         } else {
                                 $encodingStyle = '';
                         }
                 }
                 // wrap RPC calls with method element
                 if ($style == 'rpc') {
                         if ($use == 'literal') {
                                 $this->debug("wrapping RPC request with literal method element");
                                 if ($namespace) {
                                         // http://www.ws-i.org/Profiles/BasicProfile-1.1-2004-08-24.html R2735 says rpc/literal accessor elements should not be in a namespace
                                         $payload = "<$nsPrefix:$operation xmlns:$nsPrefix=\"$namespace\">" .
                                                                 $payload .
                                                                 "</$nsPrefix:$operation>";
                                 } else {
                                         $payload = "<$operation>" . $payload . "</$operation>";
                                 }
                         } else {
                                 $this->debug("wrapping RPC request with encoded method element");
                                 if ($namespace) {
                                         $payload = "<$nsPrefix:$operation xmlns:$nsPrefix=\"$namespace\">" .
                                                                 $payload .
                                                                 "</$nsPrefix:$operation>";
                                 } else {
                                         $payload = "<$operation>" .
                                                                 $payload .
                                                                 "</$operation>";
                                 }
                         }
                 }
                 // serialize envelope
                 $soapmsg = $this->serializeEnvelope($payload,$this->requestHeaders,$usedNamespaces,$style,$use,$encodingStyle);
                 $this->debug("endpoint=$this->endpoint, soapAction=$soapAction, namespace=$namespace, style=$style, use=$use, encodingStyle=$encodingStyle");
                 $this->debug('SOAP message length=' . strlen($soapmsg) . ' contents (max 1000 bytes)=' . substr($soapmsg, 0, 1000));
                 // send
                 $return = $this->send($this->getHTTPBody($soapmsg),$soapAction,$this->timeout,$this->response_timeout);
                 if($errstr = $this->getError()){
                         $this->debug('Error: '.$errstr);
                         return false;
                 } else {
                         $this->return = $return;
                         $this->debug('sent message successfully and got a(n) '.gettype($return));
                 $this->appendDebug('return=' . $this->varDump($return));
                         
                         // fault?
                         if(is_array($return) && isset($return['faultcode'])){
                                 $this->debug('got fault');
                                 $this->setError($return['faultcode'].': '.$return['faultstring']);
                                 $this->fault = true;
                                 foreach($return as $k => $v){
                                         $this->$k = $v;
                                         $this->debug("$k = $v<br>");
                                 }
                                 return $return;
                         } elseif ($style == 'document') {
                                 // NOTE: if the response is defined to have multiple parts (i.e. unwrapped),
                                 // we are only going to return the first part here...sorry about that
                                 return $return;
                         } else {
                                 // array of return values
                                 if(is_array($return)){
                                         // multiple 'out' parameters, which we return wrapped up
                                         // in the array
                                         if(sizeof($return) > 1){
                                                 return $return;
                                         }
                                         // single 'out' parameter (normally the return value)
                                         $return = array_shift($return);
                                         $this->debug('return shifted value: ');
                                         $this->appendDebug($this->varDump($return));
                                 return $return;
                                 // nothing returned (ie, echoVoid)
                                 } else {
                                         return "";
                                 }
                         }
                 }
         }

Here is the call graph for this function:

◆ checkCookies()

nusoap_client::checkCookies ( )

checks all Cookies and delete those which are expired

Returns: boolean always return true private

Definition at line 7916 of file nusoap.php.

References array, nusoap_base\debug(), and time.

                                 {
                 if (sizeof($this->cookies) == 0) {
                         return true;
                 }
                 $this->debug('checkCookie: check ' . sizeof($this->cookies) . ' cookies');
                 $curr_cookies = $this->cookies;
                 $this->cookies = array();
                 foreach ($curr_cookies as $cookie) {
                         if (! is_array($cookie)) {
                                 $this->debug('Remove cookie that is not an array');
                                 continue;
                         }
                         if ((isset($cookie['expires'])) && (! empty($cookie['expires']))) {
                                 if (strtotime($cookie['expires']) > time()) {
                                         $this->cookies[] = $cookie;
                                 } else {
                                         $this->debug('Remove expired cookie ' . $cookie['name']);
                                 }
                         } else {
                                 $this->cookies[] = $cookie;
                         }
                 }
                 $this->debug('checkCookie: '.sizeof($this->cookies).' cookies left in array');
                 return true;
         }

Here is the call graph for this function:

◆ checkWSDL()

nusoap_client::checkWSDL ( )

check WSDL passed as an instance or pulled from an endpoint

private

Definition at line 7375 of file nusoap.php.

References nusoap_base\appendDebug(), nusoap_base\clearDebug(), nusoap_base\debug(), nusoap_base\getDebug(), nusoap_base\getError(), wsdl\getOperations(), and nusoap_base\setError().

                              {
                 $this->appendDebug($this->wsdl->getDebug());
                 $this->wsdl->clearDebug();
                 $this->debug('checkWSDL');
                 // catch errors
                 if ($errstr = $this->wsdl->getError()) {
                         $this->debug('got wsdl error: '.$errstr);
                         $this->setError('wsdl error: '.$errstr);
                 } elseif ($this->operations = $this->wsdl->getOperations('soap')) {
                         $this->bindingType = 'soap';
                         $this->debug('got '.count($this->operations).' operations from wsdl '.$this->wsdlFile.' for binding type '.$this->bindingType);
                 } elseif ($this->operations = $this->wsdl->getOperations('soap12')) {
                         $this->bindingType = 'soap12';
                         $this->debug('got '.count($this->operations).' operations from wsdl '.$this->wsdlFile.' for binding type '.$this->bindingType);
                         $this->debug('**************** WARNING: SOAP 1.2 BINDING *****************');
                 } else {
                         $this->debug('getOperations returned false');
                         $this->setError('no operations defined in the WSDL document!');
                 }
         }

Here is the call graph for this function:

◆ decodeUTF8()

nusoap_client::decodeUTF8 ( $bool )

Definition at line 7879 of file nusoap.php.

                               {
                 $this->decode_utf8 = $bool;
                 return true;
     }

◆ getCookies()

nusoap_client::getCookies ( )

gets all Cookies

Returns: array with all internal cookies public

Definition at line 7906 of file nusoap.php.

                               {
                 return $this->cookies;
         }

◆ getDefaultRpcParams()

nusoap_client::getDefaultRpcParams ( )

gets the default RPC parameter setting.

If true, default is that call params are like RPC even for document style. Each call() can override this value.

This is no longer used.

Returns: boolean public

Deprecated:

Definition at line 7699 of file nusoap.php.

                                        {
                 return $this->defaultRpcParams;
         }

◆ getHeader()

nusoap_client::getHeader ( )

get the SOAP response Header (parsed)

Returns: mixed public

Definition at line 7618 of file nusoap.php.

                             {
                 return $this->responseHeader;
         }

◆ getHeaders()

nusoap_client::getHeaders ( )

get the SOAP response headers (namespace resolution incomplete)

Returns: string public

Definition at line 7608 of file nusoap.php.

                              {
                 return $this->responseHeaders;
         }

◆ getHTTPBody()

nusoap_client::getHTTPBody ( $soapmsg )

gets the HTTP body for the current request.

Parameters

string $soapmsg The SOAP payload

Returns: string The HTTP body, which includes the SOAP payload private

Definition at line 7844 of file nusoap.php.

                                        {
                 return $soapmsg;
         }

◆ getHTTPContentType()

nusoap_client::getHTTPContentType ( )

gets the HTTP content type for the current request.

Note: getHTTPBody must be called before this.

Returns: string the HTTP content type for the current request. private

Definition at line 7856 of file nusoap.php.

                                       {
                 return 'text/xml';
         }

◆ getHTTPContentTypeCharset()

nusoap_client::getHTTPContentTypeCharset ( )

gets the HTTP content type charset for the current request.

returns false for non-text content types.

Note: getHTTPBody must be called before this.

Returns: string the HTTP content type charset for the current request. private

Definition at line 7869 of file nusoap.php.

References nusoap_base\$soap_defencoding.

                                              {
                 return $this->soap_defencoding;
         }

◆ getOperationData()

nusoap_client::getOperationData ( $operation )

get available data pertaining to an operation

Parameters

string $operation operation name

Returns: array array of data pertaining to the operation public

Definition at line 7416 of file nusoap.php.

References nusoap_base\debug(), and nusoap_base\getError().

                                              {
                 if ($this->endpointType == 'wsdl' && is_null($this->wsdl)) {
                         $this->loadWSDL();
                         if ($this->getError())
                                 return false;
                 }
                 if(isset($this->operations[$operation])){
                         return $this->operations[$operation];
                 }
                 $this->debug("No data for operation: $operation");
         }

Here is the call graph for this function:

◆ getProxy()

nusoap_client::getProxy ( )

dynamically creates an instance of a proxy class, allowing user to directly call methods from wsdl

Returns: object soap_proxy object public

Definition at line 7725 of file nusoap.php.

References $endpoint, $password, $r, nusoap_base\$soap_defencoding, nusoap_base\debug(), and nusoap_base\getError().

                             {
                 $r = rand();
                 $evalStr = $this->_getProxyClassCode($r);
                 //$this->debug("proxy class: $evalStr");
                 if ($this->getError()) {
                         $this->debug("Error from _getProxyClassCode, so return NULL");
                         return null;
                 }
                 // eval the class
                 eval($evalStr);
                 // instantiate proxy object
                 eval("\$proxy = new nusoap_proxy_$r('');");
                 // transfer current wsdl data to the proxy thereby avoiding parsing the wsdl twice
                 $proxy->endpointType = 'wsdl';
                 $proxy->wsdlFile = $this->wsdlFile;
                 $proxy->wsdl = $this->wsdl;
                 $proxy->operations = $this->operations;
                 $proxy->defaultRpcParams = $this->defaultRpcParams;
                 // transfer other state
                 $proxy->soap_defencoding = $this->soap_defencoding;
                 $proxy->username = $this->username;
                 $proxy->password = $this->password;
                 $proxy->authtype = $this->authtype;
                 $proxy->certRequest = $this->certRequest;
                 $proxy->requestHeaders = $this->requestHeaders;
                 $proxy->endpoint = $this->endpoint;
                 $proxy->forceEndpoint = $this->forceEndpoint;
                 $proxy->proxyhost = $this->proxyhost;
                 $proxy->proxyport = $this->proxyport;
                 $proxy->proxyusername = $this->proxyusername;
                 $proxy->proxypassword = $this->proxypassword;
                 $proxy->http_encoding = $this->http_encoding;
                 $proxy->timeout = $this->timeout;
                 $proxy->response_timeout = $this->response_timeout;
                 $proxy->persistentConnection = &$this->persistentConnection;
                 $proxy->decode_utf8 = $this->decode_utf8;
                 $proxy->curl_options = $this->curl_options;
                 $proxy->bindingType = $this->bindingType;
                 $proxy->use_curl = $this->use_curl;
                 return $proxy;
         }

Here is the call graph for this function:

◆ getProxyClassCode()

nusoap_client::getProxyClassCode ( )

dynamically creates proxy class code

Returns: string PHP/NuSOAP code for the proxy class public

Definition at line 7832 of file nusoap.php.

References $r.

                                      {
                 $r = rand();
                 return $this->_getProxyClassCode($r);
         }

◆ loadWSDL()

nusoap_client::loadWSDL ( )

instantiate wsdl object and parse wsdl file

public

Definition at line 7401 of file nusoap.php.

References nusoap_base\debug(), wsdl\fetchWSDL(), and wsdl\setCredentials().

                             {
                 $this->debug('instantiating wsdl class with doc: '.$this->wsdlFile);
                 $this->wsdl = new wsdl('',$this->proxyhost,$this->proxyport,$this->proxyusername,$this->proxypassword,$this->timeout,$this->response_timeout,$this->curl_options,$this->use_curl);
                 $this->wsdl->setCredentials($this->username, $this->password, $this->authtype, $this->certRequest);
                 $this->wsdl->fetchWSDL($this->wsdlFile);
                 $this->checkWSDL();
         }

Here is the call graph for this function:

◆ parseResponse()

nusoap_client::parseResponse	(	$headers,
		$data
	)

processes SOAP message returned from server

Parameters

array	$headers	The HTTP headers
string	$data	unprocessed response data from server

Returns: mixed value of the message, decoded into a PHP type private

Definition at line 7521 of file nusoap.php.

References $data, nusoap_base\appendDebug(), nusoap_base\debug(), nusoap_base\setError(), and nusoap_base\varDump().

                                             {
                 $this->debug('Entering parseResponse() for data of length ' . strlen($data) . ' headers:');
                 $this->appendDebug($this->varDump($headers));
                 if (!strstr($headers['content-type'], 'text/xml')) {
                         $this->setError('Response not of type text/xml: ' . $headers['content-type']);
                         return false;
                 }
                 if (strpos($headers['content-type'], '=')) {
                         $enc = str_replace('"', '', substr(strstr($headers["content-type"], '='), 1));
                         $this->debug('Got response encoding: ' . $enc);
                         if(preg_match('/^(ISO-8859-1|US-ASCII|UTF-8)$/i',$enc)){
                                 $this->xml_encoding = strtoupper($enc);
                         } else {
                                 $this->xml_encoding = 'US-ASCII';
                         }
                 } else {
                         // should be US-ASCII for HTTP 1.0 or ISO-8859-1 for HTTP 1.1
                         $this->xml_encoding = 'ISO-8859-1';
                 }
                 $this->debug('Use encoding: ' . $this->xml_encoding . ' when creating nusoap_parser');
                 $parser = new nusoap_parser($data,$this->xml_encoding,$this->operation,$this->decode_utf8);
                 // add parser debug data to our debug
                 $this->appendDebug($parser->getDebug());
                 // if parse errors
                 if($errstr = $parser->getError()){
                         $this->setError( $errstr);
                         // destroy the parser object
                         unset($parser);
                         return false;
                 } else {
                         // get SOAP headers
                         $this->responseHeaders = $parser->getHeaders();
                         // get SOAP headers
                         $this->responseHeader = $parser->get_soapheader();
                         // get decoded message
                         $return = $parser->get_soapbody();
             // add document for doclit support
             $this->document = $parser->document;
                         // destroy the parser object
                         unset($parser);
                         // return decode message
                         return $return;
                 }
          }

Here is the call graph for this function:

◆ send()

nusoap_client::send	(	$msg,
		$soapaction = `''`,
		$timeout = `0`,
		$response_timeout = `30`
	)

send the SOAP message

Note: if the operation has multiple return values the return value of this method will be an array of those values.

@param    string $msg a SOAPx4 soapmsg object
@param    string $soapaction SOAPAction value
@param    integer $timeout set connection timeout in seconds
@param      integer $response_timeout set response timeout in seconds
@return     mixed native PHP types.
@access   private

Definition at line 7442 of file nusoap.php.

References $http, nusoap_base\appendDebug(), array, nusoap_base\debug(), nusoap_base\getError(), and nusoap_base\setError().

                                                                                 {
                 $this->checkCookies();
                 // detect transport
                 switch(true){
                         // http(s)
                         case preg_match('/^http/',$this->endpoint):
                                 $this->debug('transporting via HTTP');
                                 if($this->persistentConnection == true && is_object($this->persistentConnection)){
                                         $http =& $this->persistentConnection;
                                 } else {
                                         $http = new soap_transport_http($this->endpoint, $this->curl_options, $this->use_curl);
                                         if ($this->persistentConnection) {
                                                 $http->usePersistentConnection();
                                         }
                                 }
                                 $http->setContentType($this->getHTTPContentType(), $this->getHTTPContentTypeCharset());
                                 $http->setSOAPAction($soapaction);
                                 if($this->proxyhost && $this->proxyport){
                                         $http->setProxy($this->proxyhost,$this->proxyport,$this->proxyusername,$this->proxypassword);
                                 }
                 if($this->authtype != '') {
                                         $http->setCredentials($this->username, $this->password, $this->authtype, array(), $this->certRequest);
                                 }
                                 if($this->http_encoding != ''){
                                         $http->setEncoding($this->http_encoding);
                                 }
                                 $this->debug('sending message, length='.strlen($msg));
                                 if(preg_match('/^http:/',$this->endpoint)){
                                 //if(strpos($this->endpoint,'http:')){
                                         $this->responseData = $http->send($msg,$timeout,$response_timeout,$this->cookies);
                                 } elseif(preg_match('/^https/',$this->endpoint)){
                                 //} elseif(strpos($this->endpoint,'https:')){
                                         //if(phpversion() == '4.3.0-dev'){
                                                 //$response = $http->send($msg,$timeout,$response_timeout);
                                 //$this->request = $http->outgoing_payload;
                                                 //$this->response = $http->incoming_payload;
                                         //} else
                                         $this->responseData = $http->sendHTTPS($msg,$timeout,$response_timeout,$this->cookies);
                                 } else {
                                         $this->setError('no http/s in endpoint url');
                                 }
                                 $this->request = $http->outgoing_payload;
                                 $this->response = $http->incoming_payload;
                                 $this->appendDebug($http->getDebug());
                                 $this->UpdateCookies($http->incoming_cookies);
 
                                 // save transport object if using persistent connections
                                 if ($this->persistentConnection) {
                                         $http->clearDebug();
                                         if (!is_object($this->persistentConnection)) {
                                                 $this->persistentConnection = $http;
                                         }
                                 }
                                 
                                 if($err = $http->getError()){
                                         $this->setError('HTTP Error: '.$err);
                                         return false;
                                 } elseif($this->getError()){
                                         return false;
                                 } else {
                                         $this->debug('got response, length='. strlen($this->responseData).' type='.$http->incoming_headers['content-type']);
                                         return $this->parseResponse($http->incoming_headers, $this->responseData);
                                 }
                         break;
                         default:
                                 $this->setError('no transport found, or selected transport is not yet supported!');
                         return false;
                         break;
                 }
         }

Here is the call graph for this function:

◆ setCookie()

nusoap_client::setCookie	(	$name,
		$value
	)

adds a new Cookie into $this->cookies array

Parameters

string	$name	Cookie Name
string	$value	Cookie Value

Returns: boolean if cookie-set was successful returns true, else false public

Definition at line 7892 of file nusoap.php.

References $name, and array.

                                           {
                 if (strlen($name) == 0) {
                         return false;
                 }
                 $this->cookies[] = array('name' => $name, 'value' => $value);
                 return true;
         }

◆ setCredentials()

nusoap_client::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, verifypeer (optional), verifyhost (optional): see corresponding options in cURL docs) public

Definition at line 7647 of file nusoap.php.

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

                                                                                                    {
                 $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;
         }

Here is the call graph for this function:

◆ setCurlOption()

nusoap_client::setCurlOption	(	$option,
		$value
	)

sets user-specified cURL options

Parameters

mixed	$option	The cURL option (always integer?)
mixed	$value	The cURL option value public

Definition at line 7573 of file nusoap.php.

References nusoap_base\appendDebug(), nusoap_base\debug(), and nusoap_base\varDump().

                                                 {
                 $this->debug("setCurlOption option=$option, value=");
                 $this->appendDebug($this->varDump($value));
                 $this->curl_options[$option] = $value;
         }

Here is the call graph for this function:

◆ setDefaultRpcParams()

nusoap_client::setDefaultRpcParams ( $rpcParams )

sets the default RPC parameter setting.

If true, default is that call params are like RPC even for document style Each call() can override this value.

This is no longer used.

Parameters

boolean $rpcParams public

Deprecated:

Definition at line 7714 of file nusoap.php.

                                                  {
                 $this->defaultRpcParams = $rpcParams;
         }

◆ setEndpoint()

nusoap_client::setEndpoint ( $endpoint )

sets the SOAP endpoint, which can override WSDL

Parameters

string $endpoint The endpoint URL to use, or empty string or false to prevent override public

Definition at line 7585 of file nusoap.php.

References $endpoint, and nusoap_base\debug().

                                         {
                 $this->debug("setEndpoint(\"$endpoint\")");
                 $this->forceEndpoint = $endpoint;
         }

Here is the call graph for this function:

◆ setHeaders()

nusoap_client::setHeaders ( $headers )

set the SOAP headers

Parameters

mixed $headers String of XML with SOAP header content, or array of soapval objects for SOAP headers public

Definition at line 7596 of file nusoap.php.

References nusoap_base\appendDebug(), nusoap_base\debug(), and nusoap_base\varDump().

                                      {
                 $this->debug("setHeaders headers=");
                 $this->appendDebug($this->varDump($headers));
                 $this->requestHeaders = $headers;
         }

Here is the call graph for this function:

◆ setHTTPEncoding()

nusoap_client::setHTTPEncoding	(		$enc = `'gzip`,
		deflate'
	)

use HTTP encoding

Parameters

string $enc HTTP encoding public

Definition at line 7662 of file nusoap.php.

References nusoap_base\debug().

                                                       {
                 $this->debug("setHTTPEncoding(\"$enc\")");
                 $this->http_encoding = $enc;
         }

Here is the call graph for this function:

◆ setHTTPProxy()

nusoap_client::setHTTPProxy	(	$proxyhost,
		$proxyport,
		$proxyusername = `''`,
		$proxypassword = `''`
	)

set proxy info here

Parameters

string	$proxyhost
string	$proxyport
string	$proxyusername
string	$proxypassword	public

Definition at line 7631 of file nusoap.php.

                                                                                                 {
                 $this->proxyhost = $proxyhost;
                 $this->proxyport = $proxyport;
                 $this->proxyusername = $proxyusername;
                 $this->proxypassword = $proxypassword;
         }

◆ setUseCURL()

nusoap_client::setUseCURL ( $use )

Set whether to try to use cURL connections if possible.

Parameters

boolean $use Whether to try to use cURL public

Definition at line 7673 of file nusoap.php.

References nusoap_base\debug().

                                   {
                 $this->debug("setUseCURL($use)");
                 $this->use_curl = $use;
         }

Here is the call graph for this function:

◆ UpdateCookies()

nusoap_client::UpdateCookies ( $cookies )

updates the current cookies with a new set

Parameters

array $cookies new cookies with which to update current ones

Returns: boolean always return true private

Definition at line 7949 of file nusoap.php.

References $domain, $i, and nusoap_base\debug().

                                          {
                 if (sizeof($this->cookies) == 0) {
                         // no existing cookies: take whatever is new
                         if (sizeof($cookies) > 0) {
                                 $this->debug('Setting new cookie(s)');
                                 $this->cookies = $cookies;
                         }
                         return true;
                 }
                 if (sizeof($cookies) == 0) {
                         // no new cookies: keep what we've got
                         return true;
                 }
                 // merge
                 foreach ($cookies as $newCookie) {
                         if (!is_array($newCookie)) {
                                 continue;
                         }
                         if ((!isset($newCookie['name'])) || (!isset($newCookie['value']))) {
                                 continue;
                         }
                         $newName = $newCookie['name'];
 
                         $found = false;
                         for ($i = 0; $i < count($this->cookies); $i++) {
                                 $cookie = $this->cookies[$i];
                                 if (!is_array($cookie)) {
                                         continue;
                                 }
                                 if (!isset($cookie['name'])) {
                                         continue;
                                 }
                                 if ($newName != $cookie['name']) {
                                         continue;
                                 }
                                 $newDomain = isset($newCookie['domain']) ? $newCookie['domain'] : 'NODOMAIN';
                                 $domain = isset($cookie['domain']) ? $cookie['domain'] : 'NODOMAIN';
                                 if ($newDomain != $domain) {
                                         continue;
                                 }
                                 $newPath = isset($newCookie['path']) ? $newCookie['path'] : 'NOPATH';
                                 $path = isset($cookie['path']) ? $cookie['path'] : 'NOPATH';
                                 if ($newPath != $path) {
                                         continue;
                                 }
                                 $this->cookies[$i] = $newCookie;
                                 $found = true;
                                 $this->debug('Update cookie ' . $newName . '=' . $newCookie['value']);
                                 break;
                         }
                         if (! $found) {
                                 $this->debug('Add cookie ' . $newName . '=' . $newCookie['value']);
                                 $this->cookies[] = $newCookie;
                         }
                 }
                 return true;
         }

Here is the call graph for this function:

◆ useHTTPPersistentConnection()

nusoap_client::useHTTPPersistentConnection ( )

use HTTP persistent connections if possible

public

Definition at line 7683 of file nusoap.php.

References nusoap_base\debug().

                                               {
                 $this->debug("useHTTPPersistentConnection");
                 $this->persistentConnection = true;
         }

Here is the call graph for this function:

Field Documentation

◆ $authtype

nusoap_client::$authtype = ''

Definition at line 7068 of file nusoap.php.

◆ $bindingType

nusoap_client::$bindingType = ''

Definition at line 7094 of file nusoap.php.

◆ $certRequest

nusoap_client::$certRequest = array()

Definition at line 7069 of file nusoap.php.

◆ $cookies

nusoap_client::$cookies = array()

Definition at line 7090 of file nusoap.php.

◆ $curl_options

nusoap_client::$curl_options = array()

Definition at line 7093 of file nusoap.php.

◆ $decode_utf8

nusoap_client::$decode_utf8 = true

Definition at line 7091 of file nusoap.php.

◆ $defaultRpcParams

nusoap_client::$defaultRpcParams = false

Definition at line 7086 of file nusoap.php.

◆ $document

nusoap_client::$document = ''

Definition at line 7073 of file nusoap.php.

◆ $endpoint

nusoap_client::$endpoint

Definition at line 7074 of file nusoap.php.

◆ $endpointType

nusoap_client::$endpointType = ''

Definition at line 7084 of file nusoap.php.

◆ $fault

nusoap_client::$fault

Definition at line 7104 of file nusoap.php.

◆ $faultcode

nusoap_client::$faultcode

Definition at line 7109 of file nusoap.php.

◆ $faultdetail

nusoap_client::$faultdetail

Definition at line 7119 of file nusoap.php.

◆ $faultstring

nusoap_client::$faultstring

Definition at line 7114 of file nusoap.php.

◆ $forceEndpoint

nusoap_client::$forceEndpoint = ''

Definition at line 7075 of file nusoap.php.

◆ $http_encoding

nusoap_client::$http_encoding = false

Definition at line 7081 of file nusoap.php.

◆ $operations

nusoap_client::$operations = array()

Definition at line 7092 of file nusoap.php.

◆ $password

nusoap_client::$password = ''

Definition at line 7067 of file nusoap.php.

◆ $persistentConnection

nusoap_client::$persistentConnection = false

Definition at line 7085 of file nusoap.php.

◆ $proxyhost

nusoap_client::$proxyhost = ''

Definition at line 7076 of file nusoap.php.

◆ $proxypassword

nusoap_client::$proxypassword = ''

Definition at line 7079 of file nusoap.php.

◆ $proxyport

nusoap_client::$proxyport = ''

Definition at line 7077 of file nusoap.php.

◆ $proxyusername

nusoap_client::$proxyusername = ''

Definition at line 7078 of file nusoap.php.

◆ $request

nusoap_client::$request = ''

Definition at line 7087 of file nusoap.php.

◆ $requestHeaders

nusoap_client::$requestHeaders = false

Definition at line 7070 of file nusoap.php.

◆ $response

nusoap_client::$response = ''

Definition at line 7088 of file nusoap.php.

◆ $response_timeout

nusoap_client::$response_timeout = 30

Definition at line 7083 of file nusoap.php.

◆ $responseData

nusoap_client::$responseData = ''

Definition at line 7089 of file nusoap.php.

◆ $responseHeader

nusoap_client::$responseHeader = NULL

Definition at line 7072 of file nusoap.php.

◆ $responseHeaders

nusoap_client::$responseHeaders = ''

Definition at line 7071 of file nusoap.php.

◆ $timeout

nusoap_client::$timeout = 0

Definition at line 7082 of file nusoap.php.

◆ $use_curl

nusoap_client::$use_curl = false

Definition at line 7095 of file nusoap.php.

◆ $username

nusoap_client::$username = ''

Definition at line 7066 of file nusoap.php.

◆ $xml_encoding

nusoap_client::$xml_encoding = ''

Definition at line 7080 of file nusoap.php.

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

webservice/soap/lib/nusoap.php

Public Member Functions

Data Fields

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getProxyClassCode()

◆ call()

◆ checkCookies()

◆ checkWSDL()

◆ decodeUTF8()

◆ getCookies()

◆ getDefaultRpcParams()

◆ getHeader()

◆ getHeaders()

◆ getHTTPBody()

◆ getHTTPContentType()

◆ getHTTPContentTypeCharset()

◆ getOperationData()

◆ getProxy()

◆ getProxyClassCode()

◆ loadWSDL()

◆ parseResponse()

◆ send()

◆ setCookie()

◆ setCredentials()

◆ setCurlOption()

◆ setDefaultRpcParams()

◆ setEndpoint()

◆ setHeaders()

◆ setHTTPEncoding()

◆ setHTTPProxy()

◆ setUseCURL()

◆ UpdateCookies()

◆ useHTTPPersistentConnection()

Field Documentation

◆ $authtype

◆ $bindingType

◆ $certRequest

◆ $cookies

◆ $curl_options

◆ $decode_utf8

◆ $defaultRpcParams

◆ $document

◆ $endpoint

◆ $endpointType

◆ $fault

◆ $faultcode

◆ $faultdetail

◆ $faultstring

◆ $forceEndpoint

◆ $http_encoding

◆ $operations

◆ $password

◆ $persistentConnection

◆ $proxyhost

◆ $proxypassword

◆ $proxyport

◆ $proxyusername

◆ $request

◆ $requestHeaders

◆ $response

◆ $response_timeout

◆ $responseData

◆ $responseHeader

◆ $responseHeaders

◆ $timeout

◆ $use_curl

◆ $username

◆ $xml_encoding