Inheritance diagram for soap_transport_http:

Public Member Functions
	__construct ($url, $curl_options=null, $use_curl=false)

	setCurlOption ($option, $value)

	setHeader ($name, $value)

	unsetHeader ($name)

	setURL ($url)

	io_method ()

	connect ($connection_timeout=0, $response_timeout=30)

	send ($data, $timeout=0, $response_timeout=30, $cookies=null)

	sendHTTPS ($data, $timeout=0, $response_timeout=30, $cookies)

	setCredentials ($username, $password, $authtype='basic', $digestRequest=[], $certRequest=[])

	setSOAPAction ($soapaction)

	setEncoding ($enc='gzip, deflate')

	setProxy ($proxyhost, $proxyport, $proxyusername='', $proxypassword='', $proxyauthtype='basic')

	isSkippableCurlHeader (&$data)

	decodeChunked ($buffer, $lb)

	buildPayload ($data, $cookie_str='')

	sendRequest ($data, $cookies=null)

	getResponse ()

	setContentType ($type, $charset=false)

	usePersistentConnection ()

	parseCookie ($cookie_str)

	getCookiesForRequest ($cookies, $secure=false)

Public Member Functions inherited from nusoap_base
	__construct ()

	getGlobalDebugLevel ()

	setGlobalDebugLevel ($level)

	getDebugLevel ()

	setDebugLevel ($level)

	debug ($string)

	appendDebug ($string)

	clearDebug ()

&	getDebug ()

&	getDebugAsXMLComment ()

	expandEntities ($val)

	getError ()

	setError ($str)

	isArraySimpleOrStruct ($val)

	serialize_val ($val, $name=false, $type=false, $name_ns=false, $type_ns=false, $attributes=false, $use='encoded', $soapval=false)

	serializeEnvelope ($body, $headers=false, $namespaces=[], $style='rpc', $use='encoded', $encodingStyle='https://schemas.xmlsoap.org/soap/encoding/')

	formatDump ($str)

	contractQname ($qname)

	expandQname ($qname)

	getLocalPart ($str)

	getPrefix ($str)

	getNamespaceFromPrefix ($prefix)

	getPrefixFromNamespace ($ns)

	getmicrotime ()

	varDump ($data)

	__toString ()

Data Fields
	$url = ''

	$uri = ''

	$digest_uri = ''

	$scheme = ''

	$host = ''

	$port = ''

	$path = ''

	$request_method = 'POST'

	$protocol_version = '1.0'

	$encoding = ''

	$outgoing_headers = []

	$incoming_headers = []

	$incoming_cookies = []

	$outgoing_payload = ''

	$incoming_payload = ''

	$response_status_line

	$useSOAPAction = true

	$persistentConnection = false

	$ch = false

	$ch_options = []

	$use_curl = false

	$proxy = null

	$username = ''

	$password = ''

	$authtype = ''

	$digestRequest = []

	$certRequest = []

Data Fields inherited from nusoap_base
	$title = 'NuSOAP'

	$version = '0.9.5'

	$revision = '$Revision: 1.123 $'

	$error_str = ''

	$debug_str = ''

	$charencoding = true

	$debugLevel

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

	$soap_defencoding = 'UTF-8'

	$namespaces

	$usedNamespaces = []

	$typemap

	$xmlEntities

Detailed Description

transport class for sending/receiving data via HTTP and HTTPS NOTE: PHP must be compiled with the CURL extension for HTTPS support

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: nusoap.php,v 1.123 2010/04/26 20:15:08 snichol Exp

@access public

Definition at line 2224 of file nusoap.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	$url,
		$curl_options = null,
		$use_curl = false )

constructor

Parameters

string	$url	The URL to which to connect
array	$curl_options	User-specified cURL options
bool	$use_curl	Whether to try to force cURL use @access public

Definition at line 2270 of file nusoap.php.

Member Function Documentation

◆ buildPayload()

buildPayload	(		$data,
			$cookie_str = '' )

Writes the payload, including HTTP headers, to $this->outgoing_payload.

Parameters

string	$data	HTTP body
string	$cookie_str	data for HTTP Cookie header

Returns: void @access private

Definition at line 2925 of file nusoap.php.

◆ connect()

connect	(		$connection_timeout = 0,
			$response_timeout = 30 )

establish an HTTP connection

Parameters

int	$connection_timeout
int	$response_timeout	set response timeout in seconds

Returns: bool true if connected, false if not @access private

Definition at line 2395 of file nusoap.php.

◆ decodeChunked()

decodeChunked	(		$buffer,
			$lb )

decode a string that is encoded w/ "chunked' transfer encoding as defined in RFC2068 19.4.6

Parameters

string	$buffer
string	$lb

Returns: string @access public; string

Deprecated

Definition at line 2867 of file nusoap.php.

◆ getCookiesForRequest()

getCookiesForRequest	(		$cookies,
			$secure = false )

sort out cookies for the current request

Parameters

array	$cookies	array with all cookies
bool	$secure	is the send-content secure or not?

Returns: string for Cookie-HTTP-Header @access private

Definition at line 3512 of file nusoap.php.

◆ getResponse()

getResponse ( )

gets the SOAP response via HTTP[S]

Returns: string the response (also sets member variables like incoming_payload) @access private

Definition at line 3033 of file nusoap.php.

◆ io_method()

io_method ( )

gets the I/O method to use

Returns: string I/O method to use (socket|curl|unknown) @access private

Definition at line 2376 of file nusoap.php.

◆ isSkippableCurlHeader()

isSkippableCurlHeader ( & $data )

Test if the given string starts with a header that is to be skipped. Skippable headers result from chunked transfer and proxy requests.

Parameters

string $data The string to check.

Returns: bool Whether a skippable header was found. @access private; bool

Definition at line 2834 of file nusoap.php.

◆ parseCookie()

parseCookie ( $cookie_str )

parse an incoming Cookie into it's parts

Parameters

string $cookie_str content of cookie

Returns: array with data of that cookie @access private

Definition at line 3446 of file nusoap.php.

◆ send()

send	(	$data,
		$timeout = 0,
		$response_timeout = 30,
		$cookies = null )

sends the SOAP request and gets the SOAP response via HTTP[S]

Parameters

string	$data	message data
int	$timeout	set connection timeout in seconds
int	$response_timeout	set response timeout in seconds
array	$cookies	cookies to send

Returns: string data @access public

Definition at line 2638 of file nusoap.php.

◆ sendHTTPS()

sendHTTPS	(	$data,
		$timeout = 0,
		$response_timeout = 30,
		$cookies )

sends the SOAP request and gets the SOAP response via HTTPS using CURL

Parameters

string	$data	message data
int	$timeout	set connection timeout in seconds
int	$response_timeout	set response timeout in seconds
array	$cookies	cookies to send

Returns: string data @access public

Deprecated

Definition at line 2679 of file nusoap.php.

◆ sendRequest()

sendRequest	(		$data,
			$cookies = null )

sends the SOAP request via HTTP[S]

Parameters

string	$data	message data
array	$cookies	cookies to send

Returns: bool true if OK, false if problem @access private

Definition at line 2975 of file nusoap.php.

◆ setContentType()

setContentType	(		$type,
			$charset = false )

sets the content-type for the SOAP message to be sent

Parameters

string	$type	the content type, MIME style
mixed	$charset	character set used for encoding (or false) @access public

Definition at line 3414 of file nusoap.php.

◆ setCredentials()

setCredentials	(	$username,
		$password,
		$authtype = 'basic',
		$digestRequest = [],
		$certRequest = [] )

if authenticating, set user credentials here

Parameters

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

Definition at line 2694 of file nusoap.php.

◆ setCurlOption()

setCurlOption	(		$option,
			$value )

sets a cURL option

Parameters

mixed	$option	The cURL option (always integer?)
mixed	$value	The cURL option value @access private

Definition at line 2291 of file nusoap.php.

◆ setEncoding()

setEncoding	(		$enc = 'gzip,
		deflate'	)

use http encoding

Parameters

string $enc encoding style. supported values: gzip, deflate, or both @access public

Definition at line 2780 of file nusoap.php.

◆ setHeader()

setHeader	(		$name,
			$value )

sets an HTTP header

Parameters

string	$name	The name of the header
string	$value	The value of the header @access private

Definition at line 2305 of file nusoap.php.

◆ setProxy()

setProxy	(	$proxyhost,
		$proxyport,
		$proxyusername = '',
		$proxypassword = '',
		$proxyauthtype = 'basic' )

set proxy info here

Parameters

string	$proxyhost	use an empty string to remove proxy
string	$proxyport
string	$proxyusername
string	$proxypassword
string	$proxyauthtype	(basic\|ntlm) @access public

Definition at line 2805 of file nusoap.php.

◆ setSOAPAction()

setSOAPAction ( $soapaction )

set the soapaction value

Parameters

string $soapaction @access public

Definition at line 2769 of file nusoap.php.

◆ setURL()

setURL ( $url )

sets the URL to which to connect

Parameters

string $url The URL to which to connect @access private

Definition at line 2331 of file nusoap.php.

◆ unsetHeader()

unsetHeader ( $name )

unsets an HTTP header

Parameters

string $name The name of the header @access private

Definition at line 2317 of file nusoap.php.

◆ usePersistentConnection()

usePersistentConnection ( )

specifies that an HTTP persistent connection should be used

Returns: bool whether the request was honored by this method. @access public

Definition at line 3425 of file nusoap.php.

Field Documentation

◆ $authtype

$authtype = ''

Definition at line 2251 of file nusoap.php.

◆ $certRequest

$certRequest = []

Definition at line 2253 of file nusoap.php.

◆ $ch

$ch = false

Definition at line 2245 of file nusoap.php.

◆ $ch_options

$ch_options = []

Definition at line 2246 of file nusoap.php.

◆ $digest_uri

$digest_uri = ''

Definition at line 2229 of file nusoap.php.

◆ $digestRequest

$digestRequest = []

Definition at line 2252 of file nusoap.php.

◆ $encoding

$encoding = ''

Definition at line 2236 of file nusoap.php.

◆ $host

$host = ''

Definition at line 2231 of file nusoap.php.

◆ $incoming_cookies

$incoming_cookies = []

Definition at line 2239 of file nusoap.php.

◆ $incoming_headers

$incoming_headers = []

Definition at line 2238 of file nusoap.php.

◆ $incoming_payload

$incoming_payload = ''

Definition at line 2241 of file nusoap.php.

◆ $outgoing_headers

$outgoing_headers = []

Definition at line 2237 of file nusoap.php.

◆ $outgoing_payload

$outgoing_payload = ''

Definition at line 2240 of file nusoap.php.

◆ $password

$password = ''

Definition at line 2250 of file nusoap.php.

◆ $path

$path = ''

Definition at line 2233 of file nusoap.php.

◆ $persistentConnection

$persistentConnection = false

Definition at line 2244 of file nusoap.php.

◆ $port

$port = ''

Definition at line 2232 of file nusoap.php.

◆ $protocol_version

$protocol_version = '1.0'

Definition at line 2235 of file nusoap.php.

◆ $proxy

$proxy = null

Definition at line 2248 of file nusoap.php.

◆ $request_method

$request_method = 'POST'

Definition at line 2234 of file nusoap.php.

◆ $response_status_line

$response_status_line

Definition at line 2242 of file nusoap.php.

◆ $scheme

$scheme = ''

Definition at line 2230 of file nusoap.php.

◆ $uri

$uri = ''

Definition at line 2228 of file nusoap.php.

◆ $url

$url = ''

Definition at line 2227 of file nusoap.php.

◆ $use_curl

$use_curl = false

Definition at line 2247 of file nusoap.php.

◆ $username

$username = ''

Definition at line 2249 of file nusoap.php.

◆ $useSOAPAction

$useSOAPAction = true

Definition at line 2243 of file nusoap.php.

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

html/modules/legacy/lib/nusoap/nusoap.php

Public Member Functions

Data Fields

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildPayload()

◆ connect()

◆ decodeChunked()

◆ getCookiesForRequest()

◆ getResponse()

◆ io_method()

◆ isSkippableCurlHeader()

◆ parseCookie()

◆ send()

◆ sendHTTPS()

◆ sendRequest()

◆ setContentType()

◆ setCredentials()

◆ setCurlOption()

◆ setEncoding()

◆ setHeader()

◆ setProxy()

◆ setSOAPAction()

◆ setURL()

◆ unsetHeader()

◆ usePersistentConnection()

Field Documentation

◆ $authtype

◆ $certRequest

◆ $ch

◆ $ch_options

◆ $digest_uri

◆ $digestRequest

◆ $encoding

◆ $host

◆ $incoming_cookies

◆ $incoming_headers

◆ $incoming_payload

◆ $outgoing_headers

◆ $outgoing_payload

◆ $password

◆ $path

◆ $persistentConnection

◆ $port

◆ $protocol_version

◆ $proxy

◆ $request_method

◆ $response_status_line

◆ $scheme

◆ $uri

◆ $url

◆ $use_curl

◆ $username

◆ $useSOAPAction