\r
/**\r
* Enables/disables the echoing to screen of the xmlrpc responses received\r
- * @param integer $debug values 0, 1 and 2 are supported (2 = echo sent msg too, before received response)\r
+ * @param integer $in values 0, 1 and 2 are supported (2 = echo sent msg too, before received response)\r
* @access public\r
*/\r
function setDebug($in)\r
\r
/**\r
* Add a CA certificate to verify server with (see man page about\r
- * CURLOPT_CAINFO for more details\r
+ * CURLOPT_CAINFO for more details)\r
* @param string $cacert certificate file name (or dir holding certificates)\r
* @param bool $is_dir set to true to indicate cacert is a dir. defaults to false\r
* @access public\r
/**\r
* Directly set cURL options, for extra flexibility\r
* It allows eg. to bind client to a specific IP interface / address\r
- * @param $options array\r
+ * @param array $options\r
*/\r
function SetCurlOptions( $options )\r
{\r
}\r
else\r
{\r
- // reset errno and errstr on succesful socket connection\r
+ // reset errno and errstr on successful socket connection\r
$this->errstr = '';\r
}\r
// G. Giunta 2005/10/24: close socket before parsing.\r
- // should yeld slightly better execution times, and make easier recursive calls (e.g. to follow http redirects)\r
+ // should yield slightly better execution times, and make easier recursive calls (e.g. to follow http redirects)\r
$ipd='';\r
do\r
{\r
// return the header too\r
curl_setopt($curl, CURLOPT_HEADER, 1);\r
\r
- // will only work with PHP >= 5.0\r
// NB: if we set an empty string, CURL will add http header indicating\r
// ALL methods it is supporting. This is possibly a better option than\r
// letting the user tell what curl can / cannot do...\r
* @param array $msgs an array of xmlrpcmsg objects\r
* @param integer $timeout connection timeout (in seconds)\r
* @param string $method the http protocol variant to be used\r
- * @param boolean fallback When true, upon receiveing an error during multicall, multiple single calls will be attempted\r
+ * @param boolean fallback When true, upon receiving an error during multicall, multiple single calls will be attempted\r
* @return array\r
* @access public\r
*/\r
* with attributes being e.g. 'expires', 'path', domain'.\r
* NB: cookies sent as 'expired' by the server (i.e. with an expiry date in the past)\r
* are still present in the array. It is up to the user-defined code to decide\r
- * how to use the received cookies, and wheter they have to be sent back with the next\r
+ * how to use the received cookies, and whether they have to be sent back with the next\r
* request to the server (using xmlrpc_client::setCookie) or not\r
* @return array array of cookies received from the server\r
* @access public\r
\r
/**\r
* @param string $meth the name of the method to invoke\r
- * @param array $pars array of parameters to be paased to the method (xmlrpcval objects)\r
+ * @param array $pars array of parameters to be passed to the method (xmlrpcval objects)\r
*/\r
function xmlrpcmsg($meth, $pars=0)\r
{\r
\r
/**\r
* Returns xml representation of the message. XML prologue included\r
+ * @param string $charset_encoding\r
* @return string the xml representation of the message, xml prologue included\r
* @access public\r
*/\r
* infinite loop in that case, because we cannot trust the caller\r
* to give us a valid pointer to an open file...\r
* @access public\r
+ * @param resource $fp stream pointer\r
* @return xmlrpcresp\r
* @todo add 2nd & 3rd param to be passed to ParseResponse() ???\r
*/\r
}\r
\r
/**\r
- * Checks wheter a struct member with a given name is present.\r
+ * Checks whether a struct member with a given name is present.\r
* Works only on xmlrpcvals of type struct.\r
* @param string $m the name of the struct member to be looked up\r
* @return boolean\r
* we SHOULD assume it is strictly US-ASCII. But we try to be more tolerant of unconforming (legacy?) clients/servers,\r
* which will be most probably using UTF-8 anyway...\r
*\r
- * @param string $httpheaders the http Content-type header\r
+ * @param string $httpheader the http Content-type header\r
* @param string $xmlchunk xml content buffer\r
* @param string $encoding_prefs comma separated list of character encodings to be used as default (when mb extension is enabled)\r
+ * @return string\r
*\r
* @todo explore usage of mb_http_input(): does it detect http headers + post data? if so, use it instead of hand-detection!!!\r
*/\r
* if it is a valid subset of any encoding in the list\r
* @param string $encoding charset to be tested\r
* @param mixed $validlist comma separated list of valid charsets (or array of charsets)\r
+ * @return bool\r
*/\r
function is_valid_charset($encoding, $validlist)\r
{\r
foreach ($validlist as $allowed)\r
if (in_array($allowed, $charset_supersets[$encoding]))\r
return true;\r
- return false;\r
+ return false;\r
}\r
}\r
\r
git://git.onelab.eu / plcapi.git / blobdiff