Fonctions membres publiques

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)

Attributs publics

$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'

Documentation des fonctions membres

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

Références $i, $method, $params, et send().

Référencé par multicall().

Voici le graphe d'appel pour cette fonction :

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

Paramètres:

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

Renvoie:: array public

Références $GLOBALS, $method, _try_multicall(), et send().

Référencé par send().

Voici le graphe d'appel pour cette fonction :

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

Send an xmlrpc request

Paramètres:

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

Renvoie:: xmlrpcresp public

Références $method, $n, elseif, multicall(), sendPayloadCURL(), sendPayloadHTTP10(), et sendPayloadHTTPS().

Référencé par _try_multicall(), et multicall().

Voici le graphe d'appel pour cette fonction :

& 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

Références $authtype, $cacert, $cacertdir, $cert, $certpass, $GLOBALS, $keepalive, $key, $keypass, $method, $name, $password, $port, $proxyport, $server, et $username.

Référencé par send(), et sendPayloadHTTPS().

Voici le graphe d'appel pour cette fonction :

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

private

Références $authtype, $data, $GLOBALS, $name, $password, $port, $proxyport, $server, $uri, et $username.

Référencé par send().

Voici le graphe d'appel pour cette fonction :

& 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

Références $authtype, $cacert, $cacertdir, $cert, $certpass, $keepalive, $key, $keypass, $password, $port, $proxyport, $server, $username, et sendPayloadCURL().

Référencé par send().

Voici le graphe d'appel pour cette fonction :

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.

Paramètres:

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

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

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

Paramètres:

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

Références $cacert.

xmlrpc_client::setCertificate	(	$	cert,
		$	certpass
	)

Add a client-side https certificate

Paramètres:

string	$cert
string	$certpass	public

Références $cert, et $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

Paramètres:

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

Références $name, $path, et $port.

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

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

Paramètres:

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

xmlrpc_client::setDebug ( $ in )

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

Paramètres:

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

xmlrpc_client::setKey	(	$	key,
		$	keypass
	)

Set attributes for SSL communication: private SSL key

Paramètres:

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 NB: does not work in older php/curl installs Thanks to Daniel Convissor

Références $key, et $keypass.

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

Set proxy info

Paramètres:

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

Références $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)

Paramètres:

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

xmlrpc_client::setSSLVerifyHost ( $ i )

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

Paramètres:

int $i public

Références $i.

xmlrpc_client::setSSLVerifyPeer ( $ i )

Set attributes for SSL communication: verify server certificate

Paramètres:

bool $i enable/disable verification of peer certificate public

Références $i.

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

Paramètres:

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

Références $method, $parts, $path, $port, et $server.

Documentation des données membres

xmlrpc_client::$accepted_charset_encodings = array()

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

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

xmlrpc_client::$authtype = 1

Référencé par sendPayloadCURL(), sendPayloadHTTP10(), et sendPayloadHTTPS().

xmlrpc_client::$cacert = ''

Référencé par sendPayloadCURL(), sendPayloadHTTPS(), et setCaCertificate().

xmlrpc_client::$cacertdir = ''

Référencé par sendPayloadCURL(), et sendPayloadHTTPS().

xmlrpc_client::$cert = ''

Référencé par sendPayloadCURL(), sendPayloadHTTPS(), et setCertificate().

xmlrpc_client::$certpass = ''

Référencé par sendPayloadCURL(), sendPayloadHTTPS(), et setCertificate().

xmlrpc_client::$cookies = array()

xmlrpc_client::$debug = 0