soapclient higher level class for easy usage. More...

Inheritance diagram for soap_client:

Collaboration diagram for soap_client:

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

	call ($operation, $params=array(), $namespace='', $soapAction='', $headers=false, $rpcParams=null, $style='rpc', $use='encoded')
	calls method, returns PHP native type 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...

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

	getHeaders ()
	get the response headers More...

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

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

	setHTTPEncoding ($enc='gzip, deflate')
	use HTTP encoding 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 proxy class, allowing user to directly call methods from wsdl 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)

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

	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)

	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 = ''

	$requestHeaders = false

	$responseHeaders = ''

	$document = ''

	$endpoint

	$error_str = false

	$proxyhost = ''

	$proxyport = ''

	$proxyusername = ''

	$proxypassword = ''

	$xml_encoding = ''

	$http_encoding = false

	$timeout = 0

	$response_timeout = 30

	$endpointType = ''

	$persistentConnection = false

	$defaultRpcParams = false

	$request = ''

	$response = ''

	$responseData = ''

	$decode_utf8 = true

	$fault

	$faultcode

	$faultstring

	$faultdetail

Data Fields inherited from nusoap_base
	$title = 'NuSOAP'

	$version = '0.6.7'

	$revision = '$Revision$'

	$error_str = false
	Current error string (manipulated by getError/setError) More...

	$debug_str = ''
	Current debug string (manipulated by debug/appendDebug/clearDebug/getDebug/getDebugAsXMLComment) More...

	$charencoding = true

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

	$soap_defencoding = 'UTF-8'

	$namespaces

	$usedNamespaces = array()

	$typemap

	$xmlEntities

	$debugLevel

Detailed Description

soapclient higher level class for easy usage.

usage:

// instantiate client with server info $soapclient = new soapclient( string path [ ,boolean 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 @access public

Definition at line 4968 of file nusoap.php.

Member Function Documentation

◆ call()

soap_client::call	(	$operation,
		$params = `array()`,
		$namespace = `''`,
		$soapAction = `''`,
		$headers = `false`,
		$rpcParams = `null`,
		$style = `'rpc'`,
		$use = `'encoded'`
	)

calls method, returns PHP native type

Parameters

string	$method	SOAP server URL or path
array	$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)
boolean	$headers	optional array of soapval objects for headers
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 @access public

Definition at line 5084 of file nusoap.php.

                                                                                                                                         {
                $this->operation = $operation;
                $this->fault = false;
                $this->error_str = '';
                $this->request = '';
                $this->response = '';
                $this->responseData = '';
                $this->faultstring = '';
                $this->faultcode = '';
                $this->opData = array();
                
                $this->debug("call: $operation, $params, $namespace, $soapAction, $headers, $style, $use; endpointType: $this->endpointType");
                if ($headers) {
                        $this->requestHeaders = $headers;
                }
                // serialize parameters
                if($this->endpointType == 'wsdl' && $opData = $this->getOperationData($operation)){
                        // use WSDL for operation
                        $this->opData = $opData;
                        foreach($opData as $key => $value){
                                $this->debug("$key -> $value");
                        }
                        if (isset($opData['soapAction'])) {
                                $soapAction = $opData['soapAction'];
                        }
                        $this->endpoint = $opData['endpoint'];
                        $namespace = isset($opData['input']['namespace']) ? $opData['input']['namespace'] :     ($namespace != '' ? $namespace : 'http://testuri.org');
                        $style = $opData['style'];
                        $use = $opData['input']['use'];
                        // add ns to ns array
                        if($namespace != '' && !isset($this->wsdl->namespaces[$namespace])){
                                $this->wsdl->namespaces['nu'] = $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);
                        } else {
                                $this->debug('params must be array or string');
                                $this->setError('params must be array or string');
                                return false;
                        }
            $usedNamespaces = $this->wsdl->usedNamespaces;
                        // Partial fix for multiple encoding styles in the same function call
                        $encodingStyle = 'http://schemas.xmlsoap.org/soap/encoding/';
                        if (isset($opData['output']['encodingStyle']) && $encodingStyle != $opData['output']['encodingStyle']) {
                                $methodEncodingStyle = ' SOAP-ENV:encodingStyle="' . $opData['output']['encodingStyle'] . '"';
                        } else {
                                $methodEncodingStyle = '';
                        }
                        $this->debug("wsdl debug: \n".$this->wsdl->debug_str);
                        $this->wsdl->debug_str = '';
                        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->setError( 'operation '.$operation.' not present.');
                        $this->debug("operation '$operation' not present.");
                        $this->debug("wsdl debug: \n".$this->wsdl->debug_str);
                        $this->wsdl->debug_str = '';
                        return false;
                } else {
                        // no WSDL
            if($namespace == ''){
                $namespace = 'http://testuri.org';
            }
                        //$this->namespaces['ns1'] = $namespace;
                        $nsPrefix = 'ns1';
                        // 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();
                        $methodEncodingStyle = '';
                }
                // wrap RPC calls with method element
                if ($style == 'rpc') {
                        if ($use == 'literal') {
                                $this->debug("wrapping RPC request with literal method element");
                                $payload = "<$operation xmlns=\"$namespace\">" . $payload . "</$operation>";
                        } else {
                                $this->debug("wrapping RPC request with encoded method element");
                                $payload = "<$nsPrefix:$operation$methodEncodingStyle xmlns:$nsPrefix=\"$namespace\">" .
                                                        $payload .
                                                        "</$nsPrefix:$operation>";
                        }
                }
                // serialize envelope
                $soapmsg = $this->serializeEnvelope($payload,$this->requestHeaders,$usedNamespaces,$style,$use);
//echo htmlentities($soapmsg)."<br><br>";
                $this->debug("endpoint: $this->endpoint, soapAction: $soapAction, namespace: $namespace, style: $style, use: $use");
                $this->debug('SOAP message length: ' . strlen($soapmsg) . ' contents: ' . 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).' back');
                        
                        // 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;
                        } else {
                                // array of return values
                                if(is_array($return)){
                                        // multiple 'out' parameters
                                        if(sizeof($return) > 1){
                                                return $return;
                                        }
                                        // single 'out' parameter
                                        return array_shift($return);
                                // nothing returned (ie, echoVoid)
                                } else {
                                        return "";
                                }
                        }
                }
        }

References $key, $namespace, PHPMailer\PHPMailer\$params, $style, nusoap_base\$usedNamespaces, nusoap_base\debug(), nusoap_base\getError(), getHTTPBody(), getOperationData(), nusoap_base\getPrefixFromNamespace(), send(), nusoap_base\serialize_val(), nusoap_base\serializeEnvelope(), wsdl\serializeRPCParameters(), and nusoap_base\setError().

Here is the call graph for this function:

◆ decodeUTF8()

soap_client::decodeUTF8 ( $bool )

Definition at line 5577 of file nusoap.php.

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

◆ getDefaultRpcParams()

soap_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.

@access public

Deprecated:

Definition at line 5463 of file nusoap.php.

                                       {
                return $this->defaultRpcParams;
        }

References $defaultRpcParams.

◆ getHeaders()

soap_client::getHeaders ( )

get the response headers

Returns: mixed object SOAPx4 soapval object or empty if no headers @access public

Definition at line 5398 of file nusoap.php.

                             {
            if($this->responseHeaders != '') {
                        return $this->responseHeaders;
            }
        }

References $responseHeaders.

◆ getHTTPBody()

soap_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 @access protected

Definition at line 5542 of file nusoap.php.

                                       {
                return $soapmsg;
        }

Referenced by call().

Here is the caller graph for this function:

◆ getHTTPContentType()

soap_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. @access protected

Definition at line 5554 of file nusoap.php.

                                      {
                return 'text/xml';
        }

Referenced by send().

Here is the caller graph for this function:

◆ getHTTPContentTypeCharset()

soap_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. @access protected

Definition at line 5567 of file nusoap.php.

                                             {
                return $this->soap_defencoding;
        }

References nusoap_base\$soap_defencoding.

Referenced by send().

Here is the caller graph for this function:

◆ getOperationData()

soap_client::getOperationData ( $operation )

get available data pertaining to an operation

Parameters

string $operation operation name

Returns: array array of data pertaining to the operation @access public

Definition at line 5237 of file nusoap.php.

                                             {
                if(isset($this->operations[$operation])){
                        return $this->operations[$operation];
                }
                $this->debug("No data for operation: $operation");
        }

References nusoap_base\debug().

Referenced by call().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getProxy()

soap_client::getProxy ( )

dynamically creates proxy class, allowing user to directly call methods from wsdl

Returns: object soap_proxy object @access public

Definition at line 5485 of file nusoap.php.

                           {
                $evalStr = '';
                foreach($this->operations as $operation => $opData){
                        if($operation != ''){
                                // create param string
                                $paramStr = '';
                                if(sizeof($opData['input']['parts']) > 0){
                                        foreach($opData['input']['parts'] as $name => $type){
                                                $paramStr .= "\$$name,";
                                        }
                                        $paramStr = substr($paramStr,0,strlen($paramStr)-1);
                                }
                                $opData['namespace'] = !isset($opData['namespace']) ? 'http://testuri.com' : $opData['namespace'];
                                $evalStr .= "function $operation ($paramStr){
                                        // load params into array
                                        \$params = array($paramStr);
                                        return \$this->call('$operation',\$params,'".$opData['namespace']."','".(isset($opData['soapAction']) ? $opData['soapAction'] : '')."');
                                }";
                                unset($paramStr);
                        }
                }
                $r = rand();
                $evalStr = 'class soap_proxy_'.$r.' extends soap_client {
                                '.$evalStr.'
                        }';
                //print "proxy class:<pre>$evalStr</pre>";
                // eval the class
                eval($evalStr);
                // instantiate proxy object
                eval("\$proxy = new soap_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->username = $this->username;
                $proxy->password = $this->password;
                $proxy->proxyhost = $this->proxyhost;
                $proxy->proxyport = $this->proxyport;
                $proxy->proxyusername = $this->proxyusername;
                $proxy->proxypassword = $this->proxypassword;
                $proxy->timeout = $this->timeout;
                $proxy->response_timeout = $this->response_timeout;
                $proxy->http_encoding = $this->http_encoding;
                $proxy->persistentConnection = $this->persistentConnection;
                return $proxy;
        }

References $defaultRpcParams, $http_encoding, $name, $password, $persistentConnection, $proxyhost, $proxypassword, $proxyport, $proxyusername, $r, $response_timeout, $timeout, $type, and $username.

◆ parseResponse()

soap_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 @access protected

Definition at line 5339 of file nusoap.php.

                                            {
                $this->debug('Entering parseResponse() for data of length ' . strlen($data) . ' and type ' . $headers['content-type']);
                if (!strstr($headers['content-type'], 'text/xml')) {
echo "-".$data."<br /><br />".htmlentities($data)."-";
                        $this->setError('Response not of type text/xml');
                        return false;
                }
                if (strpos($headers['content-type'], '=')) {
                        $enc = str_replace('"', '', substr(strstr($headers["content-type"], '='), 1));
                        $this->debug('Got response encoding: ' . $enc);
                        if(eregi('^(ISO-8859-1|US-ASCII|UTF-8)$',$enc)){
                                $this->xml_encoding = strtoupper($enc);
                        } else {
                                $this->xml_encoding = 'US-ASCII';
                        }
                } else {
                        // should be US-ASCII, but for XML, let's be pragmatic and admit UTF-8 is most common
                        $this->xml_encoding = 'UTF-8';
                }
                $this->debug('Use encoding: ' . $this->xml_encoding . ' when creating soap_parser');
                $parser = new soap_parser($data,$this->xml_encoding,$this->operation,$this->decode_utf8);
                // add parser debug data to our debug
                $this->debug($parser->debug_str);
                // 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 decoded message
                        $return = $parser->get_response();
            // add document for doclit support
            $this->document = $parser->document;
                        // destroy the parser object
                        unset($parser);
                        // return decode message
                        return $return;
                }
         }

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

Referenced by send().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ send()

soap_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 5258 of file nusoap.php.

                                                                                {
                // detect transport
                switch(true){
                        // http(s)
                        case ereg('^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);
                                        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->username != '' && $this->password != '') {
                                        $http->setCredentials($this->username, $this->password, $this->authtype);
                                }
                                if($this->http_encoding != ''){
                                        $http->setEncoding($this->http_encoding);
                                }
                                $this->debug('sending message, length: '.strlen($msg));
                                if(ereg('^http:',$this->endpoint)){
                                //if(strpos($this->endpoint,'http:')){
                                        $this->responseData = $http->send($msg,$timeout,$response_timeout);
                                } elseif(ereg('^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
                                        if (extension_loaded('curl')) {
                                                $this->responseData = $http->sendHTTPS($msg,$timeout,$response_timeout);
                                        } else {
                                                $this->setError('CURL Extension, or OpenSSL extension w/ PHP version >= 4.3 is required for HTTPS');
                                        }                                                               
                                } else {
                                        $this->setError('no http/s in endpoint url');
                                }
                                $this->request = $http->outgoing_payload;
                                $this->response = $http->incoming_payload;
                                $this->debug("transport debug data...\n".$http->debug_str);
                                
                                // save transport object if using persistent connections
                                if ($this->persistentConnection) {
                                        $http->debug_str = '';
                                        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;
                }
        }

References $http, $persistentConnection, $response_timeout, $timeout, nusoap_base\debug(), nusoap_base\getError(), getHTTPContentType(), getHTTPContentTypeCharset(), parseResponse(), and nusoap_base\setError().

Referenced by call().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setCredentials()

soap_client::setCredentials	(	$username,
		$password,
		$authtype = `'basic'`
	)

if authenticating, set user credentials here

Parameters

string	$username
string	$password
string	$authtype	(basic\|digest) @access public

Definition at line 5428 of file nusoap.php.

                                                                           {
                $this->username = $username;
                $this->password = $password;
                $this->authtype = $authtype;
        }

References $authtype, $password, and $username.

◆ setDefaultRpcParams()

soap_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.

Parameters

boolean $rpcParams @access public

Definition at line 5475 of file nusoap.php.

                                                 {
                $this->defaultRpcParams = $rpcParams;
        }

◆ setHeaders()

soap_client::setHeaders ( $headers )

set the SOAP headers

Parameters

$headers string XML @access public

Definition at line 5388 of file nusoap.php.

                                     {
                $this->requestHeaders = $headers;
        }

◆ setHTTPEncoding()

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

use HTTP encoding

Parameters

string $enc @access public

Definition at line 5440 of file nusoap.php.

                                                      {
                $this->http_encoding = $enc;
        }

◆ setHTTPProxy()

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

set proxy info here

Parameters

string	$proxyhost
string	$proxyport
string	$proxyusername
string	$proxypassword	@access public

Definition at line 5413 of file nusoap.php.

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

References $proxyhost, $proxypassword, $proxyport, and $proxyusername.

◆ soap_client()

soap_client::soap_client	(	$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 @access public

Definition at line 5020 of file nusoap.php.

                                                                                                                                                                                {
                $this->endpoint = $endpoint;
                $this->proxyhost = $proxyhost;
                $this->proxyport = $proxyport;
                $this->proxyusername = $proxyusername;
                $this->proxypassword = $proxypassword;
                $this->timeout = $timeout;
                $this->response_timeout = $response_timeout;
 
                // make values
                if($wsdl){
                        $this->endpointType = 'wsdl';
                        if (is_object($endpoint) && is_a($endpoint, 'wsdl')) {
                                $this->wsdl = $endpoint;
                                $this->endpoint = $this->wsdl->wsdl;
                                $this->wsdlFile = $this->endpoint;
                                $this->debug('existing wsdl instance created from ' . $this->endpoint);
                        } else {
                                $this->wsdlFile = $this->endpoint;
                                
                                // instantiate wsdl object and parse wsdl file
                                $this->debug('instantiating wsdl class with doc: '.$endpoint);
                                $this->wsdl =& new wsdl($this->wsdlFile,$this->proxyhost,$this->proxyport,$this->proxyusername,$this->proxypassword,$this->timeout,$this->response_timeout);
                        }
                        $this->debug("wsdl debug...\n".$this->wsdl->debug_str);
                        $this->wsdl->debug_str = '';
                        // catch errors
                        if($errstr = $this->wsdl->getError()){
                                $this->debug('got wsdl error: '.$errstr);
                                $this->setError('wsdl error: '.$errstr);
                        } elseif($this->operations = $this->wsdl->getOperations()){
                                $this->debug( 'got '.count($this->operations).' operations from wsdl '.$this->wsdlFile);
                        } else {
                                $this->debug( 'getOperations returned false');
                                $this->setError('no operations defined in the WSDL document!');
                        }
                }
        }

References $endpoint, $proxyhost, $proxypassword, $proxyport, $proxyusername, $response_timeout, $timeout, nusoap_base\debug(), nusoap_base\getError(), wsdl\getOperations(), nusoap_base\setError(), and wsdl\wsdl().

Here is the call graph for this function:

◆ useHTTPPersistentConnection()

soap_client::useHTTPPersistentConnection ( )

use HTTP persistent connections if possible

@access public

Definition at line 5449 of file nusoap.php.

                                              {
                $this->persistentConnection = true;
        }

Field Documentation

◆ $authtype

soap_client::$authtype = ''

Definition at line 4972 of file nusoap.php.

Referenced by setCredentials().

◆ $decode_utf8

soap_client::$decode_utf8 = true

Definition at line 4993 of file nusoap.php.

◆ $defaultRpcParams

soap_client::$defaultRpcParams = false

Definition at line 4988 of file nusoap.php.

Referenced by getDefaultRpcParams(), and getProxy().

◆ $document

soap_client::$document = ''

Definition at line 4975 of file nusoap.php.

◆ $endpoint

soap_client::$endpoint

Definition at line 4976 of file nusoap.php.

Referenced by soap_client().

◆ $endpointType

soap_client::$endpointType = ''

Definition at line 4986 of file nusoap.php.

◆ $error_str

soap_client::$error_str = false

Definition at line 4977 of file nusoap.php.

◆ $fault

soap_client::$fault

Definition at line 5004 of file nusoap.php.

◆ $faultcode

soap_client::$faultcode

Definition at line 5004 of file nusoap.php.

◆ $faultdetail

soap_client::$faultdetail

Definition at line 5004 of file nusoap.php.

◆ $faultstring

soap_client::$faultstring

Definition at line 5004 of file nusoap.php.

◆ $http_encoding

soap_client::$http_encoding = false

Definition at line 4983 of file nusoap.php.

Referenced by getProxy().

◆ $password

soap_client::$password = ''

Definition at line 4971 of file nusoap.php.

Referenced by getProxy(), and setCredentials().

◆ $persistentConnection

soap_client::$persistentConnection = false

Definition at line 4987 of file nusoap.php.

Referenced by getProxy(), and send().

◆ $proxyhost

soap_client::$proxyhost = ''

Definition at line 4978 of file nusoap.php.

Referenced by getProxy(), setHTTPProxy(), and soap_client().

◆ $proxypassword

soap_client::$proxypassword = ''

Definition at line 4981 of file nusoap.php.

Referenced by getProxy(), setHTTPProxy(), and soap_client().

◆ $proxyport

soap_client::$proxyport = ''

Definition at line 4979 of file nusoap.php.

Referenced by getProxy(), setHTTPProxy(), and soap_client().

◆ $proxyusername

soap_client::$proxyusername = ''

Definition at line 4980 of file nusoap.php.

Referenced by getProxy(), setHTTPProxy(), and soap_client().

◆ $request

soap_client::$request = ''

Definition at line 4989 of file nusoap.php.

◆ $requestHeaders

soap_client::$requestHeaders = false

Definition at line 4973 of file nusoap.php.

◆ $response

soap_client::$response = ''

Definition at line 4990 of file nusoap.php.

◆ $response_timeout

soap_client::$response_timeout = 30

Definition at line 4985 of file nusoap.php.

Referenced by getProxy(), send(), and soap_client().

◆ $responseData

soap_client::$responseData = ''

Definition at line 4991 of file nusoap.php.

◆ $responseHeaders

soap_client::$responseHeaders = ''

Definition at line 4974 of file nusoap.php.

Referenced by getHeaders().

◆ $timeout

soap_client::$timeout = 0

Definition at line 4984 of file nusoap.php.

Referenced by getProxy(), send(), and soap_client().

◆ $username

soap_client::$username = ''

Definition at line 4970 of file nusoap.php.

Referenced by getProxy(), and setCredentials().

◆ $xml_encoding

soap_client::$xml_encoding = ''

Definition at line 4982 of file nusoap.php.

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

Services/SOAPAuth/include/nusoap.php

Public Member Functions

Data Fields

Detailed Description

Member Function Documentation

◆ call()

◆ decodeUTF8()

◆ getDefaultRpcParams()

◆ getHeaders()

◆ getHTTPBody()

◆ getHTTPContentType()

◆ getHTTPContentTypeCharset()

◆ getOperationData()

◆ getProxy()

◆ parseResponse()

◆ send()

◆ setCredentials()

◆ setDefaultRpcParams()

◆ setHeaders()

◆ setHTTPEncoding()

◆ setHTTPProxy()

◆ soap_client()

◆ useHTTPPersistentConnection()

Field Documentation

◆ $authtype

◆ $decode_utf8

◆ $defaultRpcParams

◆ $document

◆ $endpoint

◆ $endpointType

◆ $error_str

◆ $fault

◆ $faultcode

◆ $faultdetail

◆ $faultstring

◆ $http_encoding

◆ $password

◆ $persistentConnection

◆ $proxyhost

◆ $proxypassword

◆ $proxyport

◆ $proxyusername

◆ $request

◆ $requestHeaders

◆ $response

◆ $response_timeout

◆ $responseData

◆ $responseHeaders

◆ $timeout

◆ $username

◆ $xml_encoding