Docs For Class nusoap

$authtype = ''

[line 30]

Type:

mixed

[ Top ]

$bindingType = ''

[line 56]

Type:

mixed

[ Top ]

$certRequest = array()

[line 31]

Type:

mixed

[ Top ]

$cookies = array()

[line 52]

Type:

mixed

[ Top ]

$curl_options = array()

[line 55]

Type:

mixed

[ Top ]

$decode_utf8 = true

[line 53]

Type:

mixed

[ Top ]

$defaultRpcParams = false

[line 48]

Type:

mixed

[ Top ]

$document = ''

[line 35]

Type:

mixed

[ Top ]

$endpoint =

[line 36]

Type:

mixed

[ Top ]

$endpointType = ''

[line 46]

Type:

mixed

[ Top ]

$fault =

[line 66]

Tags:

access:

public

Type:

fault

[ Top ]

$faultcode =

[line 71]

Tags:

access:

public

Type:

faultcode

[ Top ]

$faultdetail =

[line 81]

Tags:

access:

public

Type:

faultdetail

[ Top ]

$faultstring =

[line 76]

Tags:

access:

public

Type:

faultstring

[ Top ]

$forceEndpoint = ''

[line 37]

Type:

mixed

[ Top ]

$http_encoding = false

[line 43]

Type:

mixed

[ Top ]

$operations = array()

[line 54]

Type:

mixed

[ Top ]

$password = ''

[line 29]

Type:

mixed

[ Top ]

$persistentConnection = false

[line 47]

Type:

mixed

[ Top ]

$proxyhost = ''

[line 38]

Type:

mixed

[ Top ]

$proxypassword = ''

[line 41]

Type:

mixed

[ Top ]

$proxyport = ''

[line 39]

Type:

mixed

[ Top ]

$proxyusername = ''

[line 40]

Type:

mixed

[ Top ]

$request = ''

[line 49]

Type:

mixed

[ Top ]

$requestHeaders = false

[line 32]

Type:

mixed

[ Top ]

$response = ''

[line 50]

Type:

mixed

[ Top ]

$responseData = ''

[line 51]

Type:

mixed

[ Top ]

$responseHeader = NULL

[line 34]

Type:

mixed

[ Top ]

$responseHeaders = ''

[line 33]

Type:

mixed

[ Top ]

$response_timeout = 30

[line 45]

Type:

mixed

[ Top ]

$timeout = 0

[line 44]

Type:

mixed

[ Top ]

$username = ''

[line 28]

Type:

mixed

[ Top ]

$use_curl = false

[line 57]

Type:

mixed

[ Top ]

$xml_encoding = ''

[line 42]

Type:

mixed

[ Top ]

constructor nusoap_client [line 97]

nusoap_client nusoap_client(
mixed
$endpoint, [bool
$wsdl = false], [string
$proxyhost = false], [string
$proxyport = false], [string
$proxyusername = false], [string
$proxypassword = false], [integer
$timeout = 0], [integer
$response_timeout = 30], int
$portName)

constructor

Tags:

access:

public

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

[ Top ]

method call [line 155]

mixed call(
string
$operation, [mixed
$params = array()], [string
$namespace = 'http://tempuri.org'], [string
$soapAction = ''], [mixed
$headers = false], [boolean
$rpcParams = null], [string
$style = 'rpc'], [string
$use = 'encoded'])

calls method, returns PHP native type

Tags:

return:	response from SOAP call
access:	public

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)

[ Top ]

method decodeUTF8 [line 841]

void decodeUTF8(

$bool)

Parameters:

$bool

[ Top ]

method getCookies [line 868]

array getCookies(
)

gets all Cookies

Tags:

return:	with all internal cookies
access:	public

[ Top ]

method getDefaultRpcParams [line 661]

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

Tags:

deprecated:
access:	public

[ Top ]

method getHeader [line 580]

mixed getHeader(
)

get the SOAP response Header (parsed)

Tags:

access:

public

[ Top ]

method getHeaders [line 570]

string getHeaders(
)

get the SOAP response headers (namespace resolution incomplete)

Tags:

access:

public

[ Top ]

method getOperationData [line 378]

array getOperationData(
string
$operation)

get available data pertaining to an operation

Tags:

return:	array of data pertaining to the operation
access:	public

Parameters:

string

$operation

operation name

[ Top ]

method getProxy [line 687]

object soap_proxy getProxy(
)

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

Tags:

return:	object
access:	public

[ Top ]

method getProxyClassCode [line 794]

string getProxyClassCode(
)

dynamically creates proxy class code

Tags:

return:	PHP/NuSOAP code for the proxy class
access:	public

[ Top ]

method loadWSDL [line 363]

void loadWSDL(
)

instantiate wsdl object and parse wsdl file

Tags:

access:

public

[ Top ]

method setCookie [line 854]

boolean setCookie(
string
$name, string
$value)

adds a new Cookie into $this->cookies array

Tags:

return:	if cookie-set was successful returns true, else false
access:	public

Parameters:

string	$name	Cookie Name
string	$value	Cookie Value

[ Top ]

method setCredentials [line 609]

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

if authenticating, set user credentials here

Tags:

access:

public

Parameters:

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

[ Top ]

method setCurlOption [line 535]

void setCurlOption(
mixed
$option, mixed
$value)

sets user-specified cURL options

Tags:

access:

public

Parameters:

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

[ Top ]

method setDefaultRpcParams [line 676]

void setDefaultRpcParams(
boolean
$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.

Tags:

deprecated:
access:	public

Parameters:

boolean

$rpcParams

[ Top ]

method setEndpoint [line 547]

void setEndpoint(
string
$endpoint)

sets the SOAP endpoint, which can override WSDL

Tags:

access:

public

Parameters:

string

$endpoint

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

[ Top ]

method setHeaders [line 558]

void setHeaders(
mixed
$headers)

set the SOAP headers

Tags:

access:

public

Parameters:

mixed

$headers

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

[ Top ]

method setHTTPEncoding [line 624]

void setHTTPEncoding(
[string
$enc = 'gzip, deflate'])

use HTTP encoding

Tags:

access:

public

Parameters:

string

$enc

HTTP encoding

[ Top ]

method setHTTPProxy [line 593]

void setHTTPProxy(
string
$proxyhost, string
$proxyport, [string
$proxyusername = ''], [string
$proxypassword = ''])

set proxy info here

Tags:

access:

public

Parameters:

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

[ Top ]

method setUseCURL [line 635]

void setUseCURL(
boolean
$use)

Set whether to try to use cURL connections if possible

Tags:

access:

public

Parameters:

boolean

$use

Whether to try to use cURL

[ Top ]

method useHTTPPersistentConnection [line 645]

void useHTTPPersistentConnection(
)

use HTTP persistent connections if possible

Tags:

access:

public

[ Top ]

Class: nusoap_client

Class Overview

Author(s):

Version:

Variables

Methods

Child classes:

Class Details

Tags:

Class Variables

$authtype = ''

$bindingType = ''

$certRequest = array()

$cookies = array()

$curl_options = array()

$decode_utf8 = true

$defaultRpcParams = false

$document = ''

$endpoint =

$endpointType = ''

$fault =

Tags:

$faultcode =

Tags:

$faultdetail =

Tags:

$faultstring =

Tags:

$forceEndpoint = ''

$http_encoding = false

$operations = array()

$password = ''

$persistentConnection = false

$proxyhost = ''

$proxypassword = ''

$proxyport = ''

$proxyusername = ''

$request = ''

$requestHeaders = false

$response = ''

$responseData = ''

$responseHeader = NULL

$responseHeaders = ''

$response_timeout = 30

$timeout = 0

$username = ''

$use_curl = false

$xml_encoding = ''

Class Methods

constructor nusoap_client [line 97]

Tags:

Parameters:

method call [line 155]

Tags:

Parameters:

method decodeUTF8 [line 841]

Parameters:

method getCookies [line 868]

Tags:

method getDefaultRpcParams [line 661]

Tags:

method getHeader [line 580]

Tags:

method getHeaders [line 570]

Tags:

method getOperationData [line 378]

Tags:

Parameters:

method getProxy [line 687]

Tags:

method getProxyClassCode [line 794]

Tags:

method loadWSDL [line 363]

Tags:

method setCookie [line 854]

Tags:

Parameters:

method setCredentials [line 609]

Tags:

Parameters: