xmlrpc_client
Located in /phpxmlrpc/xmlrpc.php (line 719)
xmlrpc_client
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
Name of compression scheme to be used for sending requests.
Either null, gzip or deflate
Decides the content of xmlrpcresp objects returned by calls to send()
valid strings are 'xmlrpcvals', 'phpvals' or 'xml'
CURL handle: used for keep-alive connections (PHP 4.3.8 up, see:
http://curl.haxx.se/docs/faq.html#7.3)
- 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
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...
- array $msgs: an array of xmlrpcmsg objects
- integer $timeout: connection timeout (in seconds)
- string $method: the http protocol variant to be used
- boolen $fallback: fallback When true, upon receiveing an error during multicall, multiple single calls will be attempted
Send an xmlrpc request
- 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
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.
- string $compmethod: either 'gzip', 'deflate', 'any' or ''
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
- string $name
- string $value
- string $path
- string $domain
- string $port
Set proxy info
- 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_MTLM to use NTLM auth with proxy
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)
- string $compmethod: either 'gzip', 'deflate' or ''
Documentation generated on Mon, 05 Mar 2007 21:32:41 +0000 by phpDocumentor 1.3.1