xmlrpc_client Klassenreferenz

Aufstellung aller Elemente

Öffentliche Methoden

xmlrpc_client ($path, $server='', $port='', $method='')

setDebug ($in)

setCredentials ($u, $p, $t=1)

setCertificate ($cert, $certpass)

setCaCertificate ($cacert, $is_dir=false)

setKey ($key, $keypass)

setSSLVerifyPeer ($i)

setSSLVerifyHost ($i)

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

setAcceptedCompression ($compmethod)

setRequestCompression ($compmethod)

setCookie ($name, $value='', $path='', $domain='', $port=null)

& send ($msg, $timeout=0, $method='')

& sendPayloadHTTP10 ($msg, $server, $port, $timeout=0, $username='', $password='', $authtype=1, $proxyhost='', $proxyport=0, $proxyusername='', $proxypassword='', $proxyauthtype=1)

& sendPayloadHTTPS ($msg, $server, $port, $timeout=0, $username='', $password='', $authtype=1, $cert='', $certpass='', $cacert='', $cacertdir='', $proxyhost='', $proxyport=0, $proxyusername='', $proxypassword='', $proxyauthtype=1, $keepalive=false, $key='', $keypass='')

& sendPayloadCURL ($msg, $server, $port, $timeout=0, $username='', $password='', $authtype=1, $cert='', $certpass='', $cacert='', $cacertdir='', $proxyhost='', $proxyport=0, $proxyusername='', $proxypassword='', $proxyauthtype=1, $method='https', $keepalive=false, $key='', $keypass='')

multicall ($msgs, $timeout=0, $method='', $fallback=true)

_try_multicall ($msgs, $timeout, $method)

Öffentliche Attribute

$path

$server

$port = 0

$method = 'http'

$errno

$errstr

$debug = 0

$username = ''

$password = ''

$authtype = 1

$cert = ''

$certpass = ''

$cacert = ''

$cacertdir = ''

$key = ''

$keypass = ''

$verifypeer = true

$verifyhost = 1

$no_multicall = false

$proxy = ''

$proxyport = 0

$proxy_user = ''

$proxy_pass = ''

$proxy_authtype = 1

$cookies = array()

$accepted_compression = array()

$request_compression = ''

$xmlrpc_curl_handle = null

$keepalive = false

Wheter to use persistent connections for http 1.1 and https.

$accepted_charset_encodings = array()

Charset encodings that can be decoded without problems by the client.

$request_charset_encoding = ''

Charset encoding to be used in serializing request. NULL = use ASCII.

$return_type = 'xmlrpcvals'

Ausführliche Beschreibung

Definiert in Zeile 820 der Datei xmlrpc.inc.

Dokumentation der Elementfunktionen

xmlrpc_client::_try_multicall	(	$	msgs,
		$	timeout,
		$	method
	)

Attempt to boxcar $msgs via system.multicall. Returns either an array of xmlrpcreponses, an xmlrpc error response or false (when received response does not respect valid multicall syntax) private

Noch zu erledigen:: test this code branch...

Noch zu erledigen:: remove usage of @: it is apparently quite slow

Definiert in Zeile 1776 der Datei xmlrpc.inc.

Benutzt $method und send().

Wird benutzt von multicall().

Hier ist ein Graph der zeigt, was diese Funktion aufruft:

xmlrpc_client::multicall	(	$	msgs,
		$	timeout = `0`,
		$	method = `''`,
		$	fallback = `true`
	)

Send an array of request messages and return an array of responses. Unless $this->no_multicall has been set to true, it will try first to use one single xmlrpc call to server method system.multicall, and revert to sending many successive calls in case of failure. This failure is also stored in $this->no_multicall for subsequent calls. Unfortunately, there is no server error code universally used to denote the fact that multicall is unsupported, so there is no way to reliably distinguish between that and a temporary failure. If you are sure that server supports multicall and do not want to fallback to using many single calls, set the fourth parameter to FALSE.

NB: trying to shoehorn extra functionality into existing syntax has resulted in pretty much convoluted code...

Parameter:

	array	$msgs an array of xmlrpcmsg objects
	integer	$timeout connection timeout (in seconds)
	string	$method the http protocol variant to be used
	boolean	fallback When true, upon receiveing an error during multicall, multiple single calls will be attempted

Rückgabe:: array public

Definiert in Zeile 1704 der Datei xmlrpc.inc.

Benutzt $GLOBALS, $method, _try_multicall() und send().

Wird benutzt von send().

Hier ist ein Graph der zeigt, was diese Funktion aufruft:

& xmlrpc_client::send	(	$	msg,
		$	timeout = `0`,
		$	method = `''`
	)

Send an xmlrpc request

Parameter:

	mixed	$msg The message object, or an array of messages for using multicall, or the complete xml representation of a request
	integer	$timeout Connection timeout, in seconds, If unspecified, a platform specific timeout will apply
	string	$method if left unspecified, the http protocol chosen during creation of the object will be used

Rückgabe:: xmlrpcresp public

Definiert in Zeile 1128 der Datei xmlrpc.inc.

Benutzt $method, multicall(), sendPayloadCURL(), sendPayloadHTTP10() und sendPayloadHTTPS().

Wird benutzt von _try_multicall() und multicall().

Hier ist ein Graph der zeigt, was diese Funktion aufruft:

& xmlrpc_client::sendPayloadCURL	(	$	msg,
		$	server,
		$	port,
		$	timeout = `0`,
		$	username = `''`,
		$	password = `''`,
		$	authtype = `1`,
		$	cert = `''`,
		$	certpass = `''`,
		$	cacert = `''`,
		$	cacertdir = `''`,
		$	proxyhost = `''`,
		$	proxyport = `0`,
		$	proxyusername = `''`,
		$	proxypassword = `''`,
		$	proxyauthtype = `1`,
		$	method = `'https'`,
		$	keepalive = `false`,
		$	key = `''`,
		$	keypass = `''`
	)

Contributed by Justin Miller <justin@voxel.net> Requires curl to be built into PHP NB: CURL versions before 7.11.10 cannot use proxy to talk to https servers! private

Noch zu erledigen:: we should use a better check here - what if we get back '' or '0'?

Definiert in Zeile 1426 der Datei xmlrpc.inc.

Benutzt $authtype, $cacert, $cacertdir, $cert, $certpass, $GLOBALS, $keepalive, $key, $keypass, $method, $password, $port, $proxyport, $server und $username.

Wird benutzt von send() und sendPayloadHTTPS().

& xmlrpc_client::sendPayloadHTTP10	(	$	msg,
		$	server,
		$	port,
		$	timeout = `0`,
		$	username = `''`,
		$	password = `''`,
		$	authtype = `1`,
		$	proxyhost = `''`,
		$	proxyport = `0`,
		$	proxyusername = `''`,
		$	proxypassword = `''`,
		$	proxyauthtype = `1`
	)

private

Definiert in Zeile 1224 der Datei xmlrpc.inc.

Benutzt $authtype, $GLOBALS, $password, $port, $proxyport, $server und $username.

Wird benutzt von send().

& xmlrpc_client::sendPayloadHTTPS	(	$	msg,
		$	server,
		$	port,
		$	timeout = `0`,
		$	username = `''`,
		$	password = `''`,
		$	authtype = `1`,
		$	cert = `''`,
		$	certpass = `''`,
		$	cacert = `''`,
		$	cacertdir = `''`,
		$	proxyhost = `''`,
		$	proxyport = `0`,
		$	proxyusername = `''`,
		$	proxypassword = `''`,
		$	proxyauthtype = `1`,
		$	keepalive = `false`,
		$	key = `''`,
		$	keypass = `''`
	)

private

Definiert in Zeile 1409 der Datei xmlrpc.inc.

Benutzt $authtype, $cacert, $cacertdir, $cert, $certpass, $keepalive, $key, $keypass, $password, $port, $proxyport, $server, $username und sendPayloadCURL().

Wird benutzt von send().

Hier ist ein Graph der zeigt, was diese Funktion aufruft:

xmlrpc_client::setAcceptedCompression ( $ compmethod )

Enables/disables reception of compressed xmlrpc responses. Note that enabling reception of compressed responses merely adds some standard http headers to xmlrpc requests. It is up to the xmlrpc server to return compressed responses when receiving such requests.

Parameter:

string

$compmethod either 'gzip', 'deflate', 'any' or '' public

Definiert in Zeile 1071 der Datei xmlrpc.inc.

xmlrpc_client::setCaCertificate	(	$	cacert,
		$	is_dir = `false`
	)

Add a CA certificate to verify server with (see man page about CURLOPT_CAINFO for more details

Parameter:

	string	$cacert certificate file name (or dir holding certificates)
	bool	$is_dir set to true to indicate cacert is a dir. defaults to false public

Definiert in Zeile 999 der Datei xmlrpc.inc.

Benutzt $cacert.

xmlrpc_client::setCertificate	(	$	cert,
		$	certpass
	)

Add a client-side https certificate

Parameter:

	string	$cert
	string	$certpass public

Definiert in Zeile 986 der Datei xmlrpc.inc.

Benutzt $cert und $certpass.

xmlrpc_client::setCookie	(	$	name,
		$	value = `''`,
		$	path = `''`,
		$	domain = `''`,
		$	port = `null`
	)

Adds a cookie to list of cookies that will be sent to server. NB: setting any param but name and value will turn the cookie into a 'version 1' cookie: do not do it unless you know what you are doing

Parameter:

	string	$name
	string	$value
	string	$path
	string	$domain
	int	$port public

Noch zu erledigen:: check correctness of urlencoding cookie value (copied from php way of doing it...)

Definiert in Zeile 1104 der Datei xmlrpc.inc.

Benutzt $path und $port.

xmlrpc_client::setCredentials	(	$	u,
		$	p,
		$	t = `1`
	)

Add some http BASIC AUTH credentials, used by the client to authenticate

Parameter:

	string	$u username
	string	$p password
	integer	$t auth type. See curl_setopt man page for supported auth types. Defaults to CURLAUTH_BASIC (basic auth) public

Definiert in Zeile 973 der Datei xmlrpc.inc.

xmlrpc_client::setDebug ( $ in )

Enables/disables the echoing to screen of the xmlrpc responses received

Parameter:

integer

$debug values 0, 1 and 2 are supported (2 = echo sent msg too, before received response) public

Definiert in Zeile 961 der Datei xmlrpc.inc.

xmlrpc_client::setKey	(	$	key,
		$	keypass
	)

Set attributes for SSL communication: private SSL key NB: does not work in older php/curl installs Thanks to Daniel Convissor

Parameter:

	string	$key The name of a file containing a private SSL key
	string	$keypass The secret password needed to use the private SSL key public

Definiert in Zeile 1019 der Datei xmlrpc.inc.

Benutzt $key und $keypass.

xmlrpc_client::setProxy	(	$	proxyhost,
		$	proxyport,
		$	proxyusername = `''`,
		$	proxypassword = `''`,
		$	proxyauthtype = `1`
	)

Set proxy info

Parameter:

	string	$proxyhost
	string	$proxyport Defaults to 8080 for HTTP and 443 for HTTPS
	string	$proxyusername Leave blank if proxy has public access
	string	$proxypassword Leave blank if proxy has public access
	int	$proxyauthtype set to constant CURLAUTH_NTLM to use NTLM auth with proxy public

Definiert in Zeile 1054 der Datei xmlrpc.inc.

Benutzt $proxyport.

xmlrpc_client::setRequestCompression ( $ compmethod )

Enables/disables http compression of xmlrpc request. Take care when sending compressed requests: servers might not support them (and automatic fallback to uncompressed requests is not yet implemented)

Parameter:

string

$compmethod either 'gzip', 'deflate' or '' public

Definiert in Zeile 1086 der Datei xmlrpc.inc.

xmlrpc_client::setSSLVerifyHost ( $ i )

Set attributes for SSL communication: verify match of server cert w. hostname

Parameter:

int

$i public

Definiert in Zeile 1040 der Datei xmlrpc.inc.

xmlrpc_client::setSSLVerifyPeer ( $ i )

Set attributes for SSL communication: verify server certificate

Parameter:

bool

$i enable/disable verification of peer certificate public

Definiert in Zeile 1030 der Datei xmlrpc.inc.

xmlrpc_client::xmlrpc_client	(	$	path,
		$	server = `''`,
		$	port = `''`,
		$	method = `''`
	)

Parameter:

	string	$path either the complete server URL or the PATH part of the xmlrc server URL, e.g. /xmlrpc/server.php
	string	$server the server name / ip address
	integer	$port the port the server is listening on, defaults to 80 or 443 depending on protocol used
	string	$method the http protocol variant: defaults to 'http', 'https' and 'http11' can be used if CURL is installed

Definiert in Zeile 885 der Datei xmlrpc.inc.

Benutzt $method, $path, $port und $server.

Dokumentation der Datenelemente

xmlrpc_client::$accepted_charset_encodings = array()

Charset encodings that can be decoded without problems by the client.

Definiert in Zeile 870 der Datei xmlrpc.inc.

xmlrpc_client::$accepted_compression = array()

List of http compression methods accepted by the client for responses. NB: PHP supports deflate, gzip compressions out of the box if compiled w. zlib

NNB: you can set it to any non-empty array for HTTP11 and HTTPS, since in those cases it will be up to CURL to decide the compression methods it supports. You might check for the presence of 'zlib' in the output of curl_version() to determine wheter compression is supported or not

Definiert in Zeile 856 der Datei xmlrpc.inc.

xmlrpc_client::$authtype = 1

Definiert in Zeile 831 der Datei xmlrpc.inc.

Wird benutzt von sendPayloadCURL(), sendPayloadHTTP10() und sendPayloadHTTPS().

xmlrpc_client::$cacert = ''

Definiert in Zeile 834 der Datei xmlrpc.inc.

Wird benutzt von sendPayloadCURL(), sendPayloadHTTPS() und setCaCertificate().

xmlrpc_client::$cacertdir = ''

Definiert in Zeile 835 der Datei xmlrpc.inc.

Wird benutzt von sendPayloadCURL() und sendPayloadHTTPS().

xmlrpc_client::$cert = ''

Definiert in Zeile 832 der Datei xmlrpc.inc.

Wird benutzt von sendPayloadCURL(), sendPayloadHTTPS() und setCertificate().

xmlrpc_client::$certpass = ''

Definiert in Zeile 833 der Datei xmlrpc.inc.

Wird benutzt von sendPayloadCURL(), sendPayloadHTTPS() und setCertificate().

xmlrpc_client::$cookies = array()

Definiert in Zeile 846 der Datei xmlrpc.inc.

xmlrpc_client::$debug = 0

Definiert in Zeile 828 der Datei xmlrpc.inc.

xmlrpc_client::$errno

Definiert in Zeile 826 der Datei xmlrpc.inc.

xmlrpc_client::$errstr

Definiert in Zeile 827 der Datei xmlrpc.inc.

xmlrpc_client::$keepalive = false

Wheter to use persistent connections for http 1.1 and https.

Definiert in Zeile 868 der Datei xmlrpc.inc.

Wird benutzt von sendPayloadCURL() und sendPayloadHTTPS().

xmlrpc_client::$key = ''

Definiert in Zeile 836 der Datei xmlrpc.inc.

Wird benutzt von sendPayloadCURL(), sendPayloadHTTPS() und setKey().

xmlrpc_client::$keypass = ''

Definiert in Zeile 837 der Datei xmlrpc.inc.

Wird benutzt von sendPayloadCURL(), sendPayloadHTTPS() und setKey().

xmlrpc_client::$method = 'http'

Definiert in Zeile 825 der Datei xmlrpc.inc.

Wird benutzt von _try_multicall(), multicall(), send(), sendPayloadCURL() und xmlrpc_client().

xmlrpc_client::$no_multicall = false

Definiert in Zeile 840 der Datei xmlrpc.inc.

xmlrpc_client::$password = ''

Definiert in Zeile 830 der Datei xmlrpc.inc.

Wird benutzt von sendPayloadCURL(), sendPayloadHTTP10() und sendPayloadHTTPS().

xmlrpc_client::$path

Definiert in Zeile 822 der Datei xmlrpc.inc.

Wird benutzt von setCookie() und xmlrpc_client().

xmlrpc_client::$port = 0

Definiert in Zeile 824 der Datei xmlrpc.inc.

Wird benutzt von sendPayloadCURL(), sendPayloadHTTP10(), sendPayloadHTTPS(), setCookie() und xmlrpc_client().

xmlrpc_client::$proxy = ''

Definiert in Zeile 841 der Datei xmlrpc.inc.

xmlrpc_client::$proxy_authtype = 1

Definiert in Zeile 845 der Datei xmlrpc.inc.

xmlrpc_client::$proxy_pass = ''

Definiert in Zeile 844 der Datei xmlrpc.inc.

xmlrpc_client::$proxy_user = ''

Definiert in Zeile 843 der Datei xmlrpc.inc.

xmlrpc_client::$proxyport = 0

Definiert in Zeile 842 der Datei xmlrpc.inc.

Wird benutzt von sendPayloadCURL(), sendPayloadHTTP10(), sendPayloadHTTPS() und setProxy().

xmlrpc_client::$request_charset_encoding = ''

Charset encoding to be used in serializing request. NULL = use ASCII.

Definiert in Zeile 872 der Datei xmlrpc.inc.

xmlrpc_client::$request_compression = ''

Name of compression scheme to be used for sending requests. Either null, gzip or deflate

Definiert in Zeile 861 der Datei xmlrpc.inc.

xmlrpc_client::$return_type = 'xmlrpcvals'

Decides the content of xmlrpcresp objects returned by calls to send() valid strings are 'xmlrpcvals', 'phpvals' or 'xml'

Definiert in Zeile 877 der Datei xmlrpc.inc.

xmlrpc_client::$server

Definiert in Zeile 823 der Datei xmlrpc.inc.

Wird benutzt von sendPayloadCURL(), sendPayloadHTTP10(), sendPayloadHTTPS() und xmlrpc_client().

xmlrpc_client::$username = ''

Definiert in Zeile 829 der Datei xmlrpc.inc.

Wird benutzt von sendPayloadCURL(), sendPayloadHTTP10() und sendPayloadHTTPS().

xmlrpc_client::$verifyhost = 1

Definiert in Zeile 839 der Datei xmlrpc.inc.

xmlrpc_client::$verifypeer = true

Definiert in Zeile 838 der Datei xmlrpc.inc.

xmlrpc_client::$xmlrpc_curl_handle = null

CURL handle: used for keep-alive connections (PHP 4.3.8 up, see: http://curl.haxx.se/docs/faq.html#7.3)

Definiert in Zeile 866 der Datei xmlrpc.inc.

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

lib/xmlrpc.inc


Öffentliche Methoden
	xmlrpc_client ($path, $server='', $port='', $method='')
	setDebug ($in)
	setCredentials ($u, $p, $t=1)
	setCertificate ($cert, $certpass)
	setCaCertificate ($cacert, $is_dir=false)
	setKey ($key, $keypass)
	setSSLVerifyPeer ($i)
	setSSLVerifyHost ($i)
	setProxy ($proxyhost, $proxyport, $proxyusername= '', $proxypassword= '', $proxyauthtype=1)
	setAcceptedCompression ($compmethod)
	setRequestCompression ($compmethod)
	setCookie ($name, $value='', $path='', $domain='', $port=null)
&	send ($msg, $timeout=0, $method='')
&	sendPayloadHTTP10 ($msg, $server, $port, $timeout=0, $username='', $password='', $authtype=1, $proxyhost='', $proxyport=0, $proxyusername='', $proxypassword='', $proxyauthtype=1)
&	sendPayloadHTTPS ($msg, $server, $port, $timeout=0, $username='', $password='', $authtype=1, $cert='', $certpass='', $cacert='', $cacertdir='', $proxyhost='', $proxyport=0, $proxyusername='', $proxypassword='', $proxyauthtype=1, $keepalive=false, $key='', $keypass='')
&	sendPayloadCURL ($msg, $server, $port, $timeout=0, $username='', $password='', $authtype=1, $cert='', $certpass='', $cacert='', $cacertdir='', $proxyhost='', $proxyport=0, $proxyusername='', $proxypassword='', $proxyauthtype=1, $method='https', $keepalive=false, $key='', $keypass='')
	multicall ($msgs, $timeout=0, $method='', $fallback=true)
	_try_multicall ($msgs, $timeout, $method)
Öffentliche Attribute
	$path
	$server
	$port = 0
	$method = 'http'
	$errno
	$errstr
	$debug = 0
	$username = ''
	$password = ''
	$authtype = 1
	$cert = ''
	$certpass = ''
	$cacert = ''
	$cacertdir = ''
	$key = ''
	$keypass = ''
	$verifypeer = true
	$verifyhost = 1
	$no_multicall = false
	$proxy = ''
	$proxyport = 0
	$proxy_user = ''
	$proxy_pass = ''
	$proxy_authtype = 1
	$cookies = array()
	$accepted_compression = array()
	$request_compression = ''
	$xmlrpc_curl_handle = null
	$keepalive = false
	Wheter to use persistent connections for http 1.1 and https.
	$accepted_charset_encodings = array()
	Charset encodings that can be decoded without problems by the client.
	$request_charset_encoding = ''
	Charset encoding to be used in serializing request. NULL = use ASCII.
	$return_type = 'xmlrpcvals'



Copyright © 2003 - 2009 MyOOS [Shopsystem]. All rights reserved. MyOOS [Shopsystem] is Free Software released under the GNU/GPL License. Webmaster: info@r23.de (Impressum)