Class: mysoapclient

Source Location: /lodel/scripts/nusoap.php

Class mysoapclient

Class Overview

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

Located in /lodel/scripts/nusoap.php [line 5224]

nusoap_base
   |
   --mysoapclient

Author(s):

Dietrich Ayala <dietrich@ganx4.com>

API Tags:

Access:

public

Information Tags:

Version:

$Id: nusoap.php 3705 2006-09-14 16:06:29Z cenou $

Properties

Methods

[ Top ]

Descendants

Child Class	Description
soapclientmime	soapclientmime client supporting <a href="http://www.w3.org/TR/SOAP-attachments">MIME attachments</a>.

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From nusoap_base

nusoap_base::$charencoding

nusoap_base::$debug_str

nusoap_base::$error_str

nusoap_base::$namespaces

nusoap_base::$revision

nusoap_base::$soap_defencoding

nusoap_base::$title

nusoap_base::$typemap

nusoap_base::$usedNamespaces

nusoap_base::$version

nusoap_base::$xmlEntities

nusoap_base::$XMLSchemaVersion

Inherited From nusoap_base

nusoap_base::appendDebug()

adds debug data to the instance debug string without formatting

nusoap_base::clearDebug()

clears the current debug data for this instance

nusoap_base::contractQname()

contracts a qualified name

nusoap_base::debug()

adds debug data to the instance debug string with formatting

nusoap_base::expandEntities()

expands entities, e.g. changes '<' to '<'.

nusoap_base::expandQname()

expands a qualified name

nusoap_base::formatDump()

nusoap_base::getDebug()

gets the current debug data for this instance

nusoap_base::getDebugAsXMLComment()

gets the current debug data for this instance as an XML comment this may change the contents of the debug data

nusoap_base::getError()

returns error string if present

nusoap_base::getLocalPart()

returns the local part of a prefixed string returns the original string, if not prefixed

nusoap_base::getmicrotime()

returns the time in ODBC canonical form with microseconds

nusoap_base::getNamespaceFromPrefix()

pass it a prefix, it returns a namespace returns false if no namespace registered with the given prefix

nusoap_base::getPrefix()

returns the prefix part of a prefixed string returns false, if not prefixed

nusoap_base::getPrefixFromNamespace()

returns the prefix for a given namespace (or prefix) or false if no prefixes registered for the given namespace

nusoap_base::isArraySimpleOrStruct()

detect if array is a simple array or a struct (associative array)

nusoap_base::serializeEnvelope()

serialize message

nusoap_base::serialize_val()

serializes PHP values in accordance w/ section 5. Type information is not serialized if $use == 'literal'.

nusoap_base::setError()

sets error string

nusoap_base::varDump()

[ Top ]

Property Summary

mixed	$authtype
mixed	$decode_utf8
mixed	$defaultRpcParams
mixed	$document
mixed	$endpoint
mixed	$endpointType
fault	$fault	fault related variables
mixed	$faultcode
mixed	$faultdetail
mixed	$faultstring
mixed	$http_encoding
mixed	$operations
mixed	$password
mixed	$persistentConnection
mixed	$proxyhost
mixed	$proxypassword
mixed	$proxyport
mixed	$proxyusername
mixed	$request
mixed	$requestHeaders
mixed	$response
mixed	$responseData
mixed	$responseHeaders
mixed	$response_timeout
mixed	$timeout
mixed	$username
mixed	$xml_encoding

[ Top ]

Method Summary

mysoapclient	mysoapclient()	constructor
mixed	call()	calls method, returns PHP native type
void	decodeUTF8()
void	getDefaultRpcParams()	gets the default RPC parameter setting.
string	getHeaders()	get the response headers
string	getHTTPBody()	gets the HTTP body for the current request.
string	getHTTPContentType()	gets the HTTP content type for the current request.
string	getHTTPContentTypeCharset()	gets the HTTP content type charset for the current request.
array	getOperationData()	get available data pertaining to an operation
object soap_proxy	getProxy()	dynamically creates proxy class, allowing user to directly call methods from wsdl
mixed	parseResponse()	processes SOAP message returned from server
mixed	send()	send the SOAP message
void	setCredentials()	if authenticating, set user credentials here
void	setDefaultRpcParams()	sets the default RPC parameter setting.
void	setHeaders()	set the SOAP headers
void	setHTTPEncoding()	use HTTP encoding
void	setHTTPProxy()	set proxy info here
void	useHTTPPersistentConnection()	use HTTP persistent connections if possible

[ Top ]

Properties

mixed $authtype = '' [line 5228]

[ Top ]

mixed $decode_utf8 = true [line 5248]

[ Top ]

mixed $defaultRpcParams = false [line 5243]

[ Top ]

mixed $document = '' [line 5231]

[ Top ]

mixed $endpoint [line 5232]

[ Top ]

mixed $endpointType = '' [line 5241]

[ Top ]

fault $fault [line 5260]

fault related variables

API Tags:

Access:

public

[ Top ]

mixed $faultcode [line 5260]

[ Top ]

mixed $faultdetail [line 5260]

[ Top ]

mixed $faultstring [line 5260]

[ Top ]

mixed $http_encoding = false [line 5238]

[ Top ]

mixed $operations = array() [line 5249]

[ Top ]

mixed $password = '' [line 5227]

[ Top ]

mixed $persistentConnection = false [line 5242]

[ Top ]

mixed $proxyhost = '' [line 5233]

[ Top ]

mixed $proxypassword = '' [line 5236]

[ Top ]

mixed $proxyport = '' [line 5234]

[ Top ]

mixed $proxyusername = '' [line 5235]

[ Top ]

mixed $request = '' [line 5244]

[ Top ]

mixed $requestHeaders = false [line 5229]

[ Top ]

mixed $response = '' [line 5245]

[ Top ]

mixed $responseData = '' [line 5246]

[ Top ]

mixed $responseHeaders = '' [line 5230]

[ Top ]

mixed $response_timeout = 30 [line 5240]

[ Top ]

mixed $timeout = 0 [line 5239]

[ Top ]

mixed $username = '' [line 5226]

[ Top ]

mixed $xml_encoding = '' [line 5237]

[ Top ]

Methods

Constructor mysoapclient [line 5276]

mysoapclient mysoapclient(
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

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

API Tags:

Access:

public

[ Top ]

call [line 5342]

mixed call(

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

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)
	$operation:

API Tags:

Access:

public

[ Top ]

decodeUTF8 [line 5844]

void decodeUTF8(

$bool 
)

Parameters:

$bool:

[ Top ]

getDefaultRpcParams [line 5720]

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

API Tags:

Deprecated:
Access:	public

[ Top ]

getHeaders [line 5657]

string getHeaders(
)

get the response headers

API Tags:

Access:

public

[ Top ]

getHTTPBody [line 5809]

string getHTTPBody(
string
$soapmsg 
)

gets the HTTP body for the current request.

Parameters:

string

$soapmsg:

The SOAP payload

API Tags:

Return:	The HTTP body, which includes the SOAP payload
Access:	protected

Redefined in descendants as:

soapclientmime::getHTTPBody() : gets the HTTP body for the current request.

[ Top ]

getHTTPContentType [line 5821]

string getHTTPContentType(
)

gets the HTTP content type for the current request.

Note: getHTTPBody must be called before this.

API Tags:

Return:	the HTTP content type for the current request.
Access:	protected

Redefined in descendants as:

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

[ Top ]

getHTTPContentTypeCharset [line 5834]

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

API Tags:

Return:	the HTTP content type charset for the current request.
Access:	protected

Redefined in descendants as:

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

[ Top ]

getOperationData [line 5501]

array getOperationData(
string
$operation 
)

get available data pertaining to an operation

Parameters:

string

$operation:

operation name

API Tags:

Return:	array of data pertaining to the operation
Access:	public

[ Top ]

getProxy [line 5745]

object soap_proxy getProxy(
)

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

API Tags:

Return:	object
Access:	public

[ Top ]

parseResponse [line 5599]

mixed parseResponse(
array
$headers, string
$data 
)

processes SOAP message returned from server

Parameters:

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

API Tags:

Return:	value of the message, decoded into a PHP type
Access:	protected

Redefined in descendants as:

soapclientmime::parseResponse() : processes SOAP message returned from server

[ Top ]

send [line 5522]

mixed send(
string
$msg, [string
$soapaction = ''], [integer
$timeout = 0], [integer
$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

API Tags:

Return:	native PHP types.
Access:	private

[ Top ]

setCredentials [line 5685]

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

if authenticating, set user credentials here

Parameters:

string	$username:
string	$password:
string	$authtype:	(basic\|digest)

API Tags:

Access:

public

[ Top ]

setDefaultRpcParams [line 5735]

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.

Parameters:

boolean

$rpcParams:

API Tags:

Deprecated:
Access:	public

[ Top ]

setHeaders [line 5647]

void setHeaders(
$headers
$headers 
)

set the SOAP headers

Parameters:

$headers

$headers:

string XML

API Tags:

Access:

public

[ Top ]

setHTTPEncoding [line 5697]

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

use HTTP encoding

Parameters:

string

$enc:

API Tags:

Access:

public

[ Top ]

setHTTPProxy [line 5670]

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

set proxy info here

Parameters:

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

API Tags:

Access:

public

[ Top ]

useHTTPPersistentConnection [line 5706]

void useHTTPPersistentConnection(
)

use HTTP persistent connections if possible

API Tags:

Access:

public

[ Top ]

Documentation generated on Wed, 19 Sep 2007 05:07:17 +0200 by phpDocumentor 1.4.0a2

	default

[ class tree: default ] [ index: default ] [ all elements ]