"TYPO3 4.0.1: soapclient Class Reference", "datetime" => "Sat Dec 2 19:25:41 2006", "date" => "2 Dec 2006", "doxygenversion" => "1.4.6", "projectname" => "TYPO3 4.0.1", "projectnumber" => "4.0.1" ); get_header($doxygen_vars); ?>

soapclient Class Reference

Inheritance diagram for soapclient:

[legend]Collaboration diagram for soapclient:

[legend]List of all members.


Public Member Functions
	soapclient ($endpoint, $wsdl=false, $proxyhost=false, $proxyport=false, $proxyusername=false, $proxypassword=false, $timeout=0, $response_timeout=30)
	call ($operation, $params=array(), $namespace='http://tempuri.org', $soapAction='', $headers=false, $rpcParams=null, $style='rpc', $use='encoded')
	getOperationData ($operation)
	send ($msg, $soapaction= '', $timeout=0, $response_timeout=30)
	parseResponse ($headers, $data)
	setEndpoint ($endpoint)
	setHeaders ($headers)
	getHeaders ()
	setHTTPProxy ($proxyhost, $proxyport, $proxyusername= '', $proxypassword= '')
	setCredentials ($username, $password, $authtype= 'basic', $certRequest=array())
	setHTTPEncoding ($enc='gzip, deflate')
	useHTTPPersistentConnection ()
	getDefaultRpcParams ()
	setDefaultRpcParams ($rpcParams)
	getProxy ()
	_getProxyClassCode ($r)
	getProxyClassCode ()
	getHTTPBody ($soapmsg)
	getHTTPContentType ()
	getHTTPContentTypeCharset ()
	decodeUTF8 ($bool)
	setCookie ($name, $value)
	getCookies ()
	checkCookies ()
	UpdateCookies ($cookies)
Public Attributes
	$username = ''
	$password = ''
	$authtype = ''
	$certRequest = array()
	$requestHeaders = false
	$responseHeaders = ''
	$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()
	$fault
	$faultcode
	$faultstring
	$faultdetail

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 <dietrich@ganx4.com>

Version:

Id: class.nusoap.php 1421 2006-04-10 09:27:15Z mundaun

public

Definition at line 5348 of file class.nusoap.php.

Constructor & Destructor Documentation

soapclient::soapclient ( $ 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 5415 of file class.nusoap.php.
References $endpoint, $proxyhost, $proxypassword, $proxyport, $proxyusername, $response_timeout, $timeout, nusoap_base::appendDebug(), nusoap_base::debug(), and nusoap_base::setError().

Member Function Documentation

soapclient::_getProxyClassCode ( $ r )

dynamically creates proxy class code

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

Definition at line 5958 of file class.nusoap.php.

soapclient::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 $method 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

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 5483 of file class.nusoap.php.

soapclient::checkCookies ( )

checks all Cookies and delete those which are expired

Returns:
always return true private

Definition at line 6091 of file class.nusoap.php.

soapclient::getCookies ( )

gets all Cookies

Returns:
array with all internal cookies public

Definition at line 6081 of file class.nusoap.php.

soapclient::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 5893 of file class.nusoap.php.

soapclient::getHeaders ( )

get the SOAP response headers (namespace resolution incomplete)

Returns:
string public

Definition at line 5827 of file class.nusoap.php.

soapclient::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 6019 of file class.nusoap.php.

soapclient::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 6031 of file class.nusoap.php.

soapclient::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 6044 of file class.nusoap.php.

soapclient::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 5659 of file class.nusoap.php.

soapclient::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 5919 of file class.nusoap.php.

soapclient::getProxyClassCode ( )

dynamically creates proxy class code

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

Definition at line 6007 of file class.nusoap.php.

soapclient::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 5759 of file class.nusoap.php.

soapclient::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.

Parameters:

string $msg a SOAPx4 soapmsg object

string $soapaction SOAPAction value

integer $timeout set connection timeout in seconds

integer $response_timeout set response timeout in seconds

Returns:
mixed native PHP types. private

Definition at line 5680 of file class.nusoap.php.

soapclient::setCookie ( $ name,

$ value

)

adds a new Cookie into $this->cookies array

Parameters:

string $name Cookie Name

string $value Cookie Value

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

Definition at line 6067 of file class.nusoap.php.

soapclient::setCredentials ( $ username,

$ password,

$ authtype = 'basic',

$ certRequest = array()

)

if authenticating, set user credentials here

Parameters:

string $username

string $password

string $authtype (basic|digest|certificate)

array $certRequest (keys must be cainfofile (optional), sslcertfile, sslkeyfile, passphrase, verifypeer (optional), verifyhost (optional): see corresponding options in cURL docs) public

Definition at line 5856 of file class.nusoap.php.

soapclient::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 5908 of file class.nusoap.php.

soapclient::setEndpoint ( $ endpoint )

sets the SOAP endpoint, which can override WSDL

Parameters:

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

Definition at line 5807 of file class.nusoap.php.

soapclient::setHeaders ( $ headers )

set the SOAP headers

Parameters:

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

Definition at line 5817 of file class.nusoap.php.

soapclient::setHTTPEncoding ( $ enc = 'gzip,

deflate'

)

use HTTP encoding

Parameters:

string $enc public

Definition at line 5869 of file class.nusoap.php.

soapclient::setHTTPProxy ( $ proxyhost,

$ proxyport,

$ proxyusername = '',

$ proxypassword = ''

)

set proxy info here

Parameters:

string $proxyhost

string $proxyport

string $proxyusername

string $proxypassword public

Definition at line 5840 of file class.nusoap.php.

soapclient::UpdateCookies ( $ cookies )

updates the current cookies with a new set

Parameters:

array $cookies new cookies with which to update current ones

Returns:
always return true private

Definition at line 6124 of file class.nusoap.php.

soapclient::useHTTPPersistentConnection ( )

use HTTP persistent connections if possible
public
Definition at line 5878 of file class.nusoap.php.

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

typo3_src-4.0.1/typo3/mod/tools/em/class.nusoap.php

soapclient Class Reference

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation