xmlrpc_client xmlrpc_client(
string
$path, [string
$server = ''], [integer
$port = ''], [string
$method = '']
)
|
|
Parameters:
|
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 |
array multicall(
array
$msgs, [integer
$timeout = 0], [string
$method = ''], [boolean
$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...
Parameters:
|
array |
$msgs: |
an array of xmlrpcmsg objects |
|
integer |
$timeout: |
connection timeout (in seconds) |
|
string |
$method: |
the http protocol variant to be used |
|
boolean |
$fallback: |
fallback When true, upon receiveing an error during multicall, multiple single calls will be attempted |
API Tags:
xmlrpcresp &send(
mixed
$msg, [integer
$timeout = 0], [string
$method = '']
)
|
|
Send an xmlrpc request
Parameters:
|
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 |
API Tags:
void setAcceptedCompression(
string
$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.
Parameters:
|
string |
$compmethod: |
either 'gzip', 'deflate', 'any' or '' |
API Tags:
void setCaCertificate(
string
$cacert, [bool
$is_dir = false]
)
|
|
Add a CA certificate to verify server with (see man page about
CURLOPT_CAINFO for more details
Parameters:
|
string |
$cacert: |
certificate file name (or dir holding certificates) |
|
bool |
$is_dir: |
set to true to indicate cacert is a dir. defaults to false |
API Tags:
void setCertificate(
string
$cert, string
$certpass
)
|
|
Add a client-side https certificate
Parameters:
|
string |
$cert: |
|
|
string |
$certpass: |
|
API Tags:
void setCookie(
string
$name, [string
$value = ''], [string
$path = ''], [string
$domain = ''], [int
$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
Parameters:
|
string |
$name: |
|
|
string |
$value: |
|
|
string |
$path: |
|
|
string |
$domain: |
|
|
int |
$port: |
|
API Tags:
Information Tags:
| Todo: | check correctness of urlencoding cookie value (copied from php way of doing it...) |
void setCredentials(
string
$u, string
$p, [integer
$t = 1]
)
|
|
Add some http BASIC AUTH credentials, used by the client to authenticate
Parameters:
|
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) |
API Tags:
void setDebug(
$in, integer
$debug
)
|
|
Enables/disables the echoing to screen of the xmlrpc responses received
Parameters:
|
integer |
$debug: |
values 0, 1 and 2 are supported (2 = echo sent msg too, before received response) |
|
|
$in: |
|
API Tags:
void setKey(
string
$key, string
$keypass
)
|
|
Set attributes for SSL communication: private SSL key
NB: does not work in older php/curl installs Thanks to Daniel Convissor
Parameters:
|
string |
$key: |
The name of a file containing a private SSL key |
|
string |
$keypass: |
The secret password needed to use the private SSL key |
API Tags:
void setProxy(
string
$proxyhost, string
$proxyport, [string
$proxyusername = ''], [string
$proxypassword = ''], [int
$proxyauthtype = 1]
)
|
|
Set proxy info
Parameters:
|
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 |
API Tags:
void setRequestCompression(
string
$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)
Parameters:
|
string |
$compmethod: |
either 'gzip', 'deflate' or '' |
API Tags:
void setSSLVerifyHost(
int
$i
)
|
|
Set attributes for SSL communication: verify match of server cert w. hostname
Parameters:
API Tags:
void setSSLVerifyPeer(
bool
$i
)
|
|
Set attributes for SSL communication: verify server certificate
Parameters:
|
bool |
$i: |
enable/disable verification of peer certificate |
API Tags:
