soapclient Klassenreferenz

Klassendiagramm für soapclient:

Öffentliche Methoden
	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)
	nusoap_base ()
	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')
	serializeEnvelope ($body, $headers=false, $namespaces=array(), $style='rpc', $use='encoded', $encodingStyle='http://schemas.xmlsoap.org/soap/encoding/')
	formatDump ($str)
	contractQname ($qname)
	expandQname ($qname)
	getLocalPart ($str)
	getPrefix ($str)
	getNamespaceFromPrefix ($prefix)
	getPrefixFromNamespace ($ns)
	getmicrotime ()
	varDump ($data)
Öffentliche Attribute
	$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
	$title = 'NuSOAP'
	$version = '0.7.2'
	$revision = '$Revision: 2663 $'
	$error_str = ''
	$debug_str = ''
	$charencoding = true
	$debugLevel
	$XMLSchemaVersion = 'http://www.w3.org/2001/XMLSchema'
	$soap_defencoding = 'ISO-8859-1'
	$namespaces
	$usedNamespaces = array()
	$typemap
	$xmlEntities

Ausführliche Beschreibung

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

Autor:: Dietrich Ayala <dietrich@ganx4.com>

Version:

Id: class.nusoap.php 2663 2007-11-05 09:22:23Z ingmars

public

Dokumentation der Elementfunktionen

soapclient::_getProxyClassCode ( $ r )

dynamically creates proxy class code

Rückgabe:: string PHP/NuSOAP code for the proxy class private

nusoap_base::appendDebug ( $ string ) [inherited]

adds debug data to the instance debug string without formatting

Parameter:

string

$string debug data public

soapclient::call	(	$	operation,
		$	params = `array()`,
		$	namespace = `'http://tempuri.org'`,
		$	soapAction = `''`,
		$	headers = `false`,
		$	rpcParams = `null`,
		$	style = `'rpc'`,
		$	use = `'encoded'`
	)

calls method, returns PHP native type

Parameter:

	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)

Rückgabe:: mixed response from SOAP call public

soapclient::checkCookies ( )

checks all Cookies and delete those which are expired

Rückgabe:: always return true private

nusoap_base::clearDebug ( ) [inherited]

clears the current debug data for this instance

public

nusoap_base::contractQname ( $ qname ) [inherited]

contracts (changes namespace to prefix) a qualified name

Parameter:

string

$qname qname

Rückgabe:: string contracted qname private

nusoap_base::debug ( $ string ) [inherited]

adds debug data to the instance debug string with formatting

Parameter:

string

$string debug data private

nusoap_base::expandEntities ( $ val ) [inherited]

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

Parameter:

string

$val The string in which to expand entities. private

nusoap_base::expandQname ( $ qname ) [inherited]

expands (changes prefix to namespace) a qualified name

Parameter:

string

$string qname

Rückgabe:: string expanded qname private

nusoap_base::formatDump ( $ str ) [inherited]

formats a string to be inserted into an HTML stream

Parameter:

string

$str The string to format

Rückgabe:: string The formatted string public

Veraltet:

soapclient::getCookies ( )

gets all Cookies

Rückgabe:: array with all internal cookies public

& nusoap_base::getDebug ( ) [inherited]

gets the current debug data for this instance

Rückgabe:: debug data public

& nusoap_base::getDebugAsXMLComment ( ) [inherited]

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

Rückgabe:: debug data as an XML comment public

nusoap_base::getDebugLevel ( ) [inherited]

gets the debug level for this instance

Rückgabe:: int Debug level 0-9, where 0 turns off public

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.

Rückgabe:: boolean public

Veraltet:

nusoap_base::getError ( ) [inherited]

returns error string if present

Rückgabe:: mixed error string or false public

nusoap_base::getGlobalDebugLevel ( ) [inherited]

gets the global debug level, which applies to future instances

Rückgabe:: integer Debug level 0-9, where 0 turns off public

soapclient::getHeaders ( )

get the SOAP response headers (namespace resolution incomplete)

Rückgabe:: string public

soapclient::getHTTPBody ( $ soapmsg )

gets the HTTP body for the current request.

Parameter:

string

$soapmsg The SOAP payload

Rückgabe:: string The HTTP body, which includes the SOAP payload private

soapclient::getHTTPContentType ( )

gets the HTTP content type for the current request.

Note: getHTTPBody must be called before this.

Rückgabe:: string the HTTP content type for the current request. private

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.

Rückgabe:: string the HTTP content type charset for the current request. private

nusoap_base::getLocalPart ( $ str ) [inherited]

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

Parameter:

string

$str The prefixed string

Rückgabe:: string The local part public

nusoap_base::getmicrotime ( ) [inherited]

returns the time in ODBC canonical form with microseconds

Rückgabe:: string The time in ODBC canonical form with microseconds public

nusoap_base::getNamespaceFromPrefix ( $ prefix ) [inherited]

pass it a prefix, it returns a namespace

Parameter:

string

$prefix The prefix

Rückgabe:: mixed The namespace, false if no namespace has the specified prefix public

soapclient::getOperationData ( $ operation )

get available data pertaining to an operation

Parameter:

string

$operation operation name

Rückgabe:: array array of data pertaining to the operation public

nusoap_base::getPrefix ( $ str ) [inherited]

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

Parameter:

string

$str The prefixed string

Rückgabe:: mixed The prefix or false if there is no prefix public

nusoap_base::getPrefixFromNamespace ( $ ns ) [inherited]

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

Parameter:

string

$ns The namespace

Rückgabe:: mixed The prefix, false if the namespace has no prefixes public

soapclient::getProxy ( )

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

Rückgabe:: object soap_proxy object public

soapclient::getProxyClassCode ( )

dynamically creates proxy class code

Rückgabe:: string PHP/NuSOAP code for the proxy class public

nusoap_base::isArraySimpleOrStruct ( $ val ) [inherited]

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

Parameter:

mixed

$val The PHP array

Rückgabe:: string (arraySimple|arrayStruct) private

nusoap_base::nusoap_base ( ) [inherited]

constructor

public

soapclient::parseResponse	(	$	headers,
		$	data
	)

processes SOAP message returned from server

Parameter:

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

Rückgabe:: mixed value of the message, decoded into a PHP type private

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.

Parameter:

	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

Rückgabe:: mixed native PHP types. private

nusoap_base::serialize_val	(	$	val,
		$	name = `false`,
		$	type = `false`,
		$	name_ns = `false`,
		$	type_ns = `false`,
		$	attributes = `false`,
		$	use = `'encoded'`
	)			`[inherited]`

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

Parameter:

	mixed	$val The value to serialize
	string	$name The name (local part) of the XML element
	string	$type The XML schema type (local part) for the element
	string	$name_ns The namespace for the name of the XML element
	string	$type_ns The namespace for the type of the element
	array	$attributes The attributes to serialize as name=>value pairs
	string	$use The WSDL "use" (encoded\|literal)

Rückgabe:: string The serialized element, possibly with child elements public

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

serializes a message

Parameter:

	string	$body the XML of the SOAP body
	mixed	$headers optional string of XML with SOAP header content, or array of soapval objects for SOAP headers
	array	$namespaces optional the namespaces used in generating the body and headers
	string	$style optional (rpc\|document)
	string	$use optional (encoded\|literal)
	string	$encodingStyle optional (usually 'http://schemas.xmlsoap.org/soap/encoding/' for encoded)

Rückgabe:: string the message public

soapclient::setCookie	(	$	name,
		$	value
	)

adds a new Cookie into $this->cookies array

Parameter:

	string	$name Cookie Name
	string	$value Cookie Value

Rückgabe:: if cookie-set was successful returns true, else false public

soapclient::setCredentials	(	$	username,
		$	password,
		$	authtype = `'basic'`,
		$	certRequest = `array()`
	)

if authenticating, set user credentials here

Parameter:

	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

nusoap_base::setDebugLevel ( $ level ) [inherited]

sets the debug level for this instance

Parameter:

int

$level Debug level 0-9, where 0 turns off public

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.

Parameter:

boolean

$rpcParams public

Veraltet:

soapclient::setEndpoint ( $ endpoint )

sets the SOAP endpoint, which can override WSDL

Parameter:

$endpoint

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

nusoap_base::setError ( $ str ) [inherited]

sets error string

Rückgabe:: boolean $string error string private

nusoap_base::setGlobalDebugLevel ( $ level ) [inherited]

sets the global debug level, which applies to future instances

Parameter:

int

$level Debug level 0-9, where 0 turns off public

soapclient::setHeaders ( $ headers )

set the SOAP headers

Parameter:

$headers

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

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

use HTTP encoding

Parameter:

string

$enc public

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

set proxy info here

Parameter:

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

soapclient::soapclient	(	$	endpoint,
		$	wsdl = `false`,
		$	proxyhost = `false`,
		$	proxyport = `false`,
		$	proxyusername = `false`,
		$	proxypassword = `false`,
		$	timeout = `0`,
		$	response_timeout = `30`
	)

constructor

Parameter:

	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

soapclient::UpdateCookies ( $ cookies )

updates the current cookies with a new set

Parameter:

array

$cookies new cookies with which to update current ones

Rückgabe:: always return true private

soapclient::useHTTPPersistentConnection ( )

use HTTP persistent connections if possible

public

nusoap_base::varDump ( $ data ) [inherited]

Returns a string with the output of var_dump

Parameter:

mixed

$data The variable to var_dump

Rückgabe:: string The output of var_dump public

Dokumentation der Datenelemente

nusoap_base::$namespaces [inherited]

Initialisierung:

 array(
                'SOAP-ENV' => 'http://schemas.xmlsoap.org/soap/envelope/',
                'xsd' => 'http://www.w3.org/2001/XMLSchema',
                'xsi' => 'http://www.w3.org/2001/XMLSchema-instance',
                'SOAP-ENC' => 'http://schemas.xmlsoap.org/soap/encoding/'
                )

nusoap_base::$typemap [inherited]

Initialisierung:

 array(
        'http://www.w3.org/2001/XMLSchema' => array(
                'string'=>'string','boolean'=>'boolean','float'=>'double','double'=>'double','decimal'=>'double',
                'duration'=>'','dateTime'=>'string','time'=>'string','date'=>'string','gYearMonth'=>'',
                'gYear'=>'','gMonthDay'=>'','gDay'=>'','gMonth'=>'','hexBinary'=>'string','base64Binary'=>'string',
                
                'anyType'=>'string','anySimpleType'=>'string',
                
                'normalizedString'=>'string','token'=>'string','language'=>'','NMTOKEN'=>'','NMTOKENS'=>'','Name'=>'','NCName'=>'','ID'=>'',
                'IDREF'=>'','IDREFS'=>'','ENTITY'=>'','ENTITIES'=>'','integer'=>'integer','nonPositiveInteger'=>'integer',
                'negativeInteger'=>'integer','long'=>'integer','int'=>'integer','short'=>'integer','byte'=>'integer','nonNegativeInteger'=>'integer',
                'unsignedLong'=>'','unsignedInt'=>'','unsignedShort'=>'','unsignedByte'=>'','positiveInteger'=>''),
        'http://www.w3.org/2000/10/XMLSchema' => array(
                'i4'=>'','int'=>'integer','boolean'=>'boolean','string'=>'string','double'=>'double',
                'float'=>'double','dateTime'=>'string',
                'timeInstant'=>'string','base64Binary'=>'string','base64'=>'string','ur-type'=>'array'),
        'http://www.w3.org/1999/XMLSchema' => array(
                'i4'=>'','int'=>'integer','boolean'=>'boolean','string'=>'string','double'=>'double',
                'float'=>'double','dateTime'=>'string',
                'timeInstant'=>'string','base64Binary'=>'string','base64'=>'string','ur-type'=>'array'),
        'http://soapinterop.org/xsd' => array('SOAPStruct'=>'struct'),
        'http://schemas.xmlsoap.org/soap/encoding/' => array('base64'=>'string','array'=>'array','Array'=>'array'),
    'http://xml.apache.org/xml-soap' => array('Map')
        )

nusoap_base::$xmlEntities [inherited]

Initialisierung:

 array('quot' => '"','amp' => '&',
                'lt' => '<','gt' => '>','apos' => "'")

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

/srv/www/vhosts/typo3.local/typo3_src-4.2.10/typo3/mod/tools/em/class.nusoap.php

soapclient Klassenreferenz

Öffentliche Methoden

Öffentliche Attribute

Ausführliche Beschreibung

Dokumentation der Elementfunktionen

Dokumentation der Datenelemente