Bump requirements to 5.1.0; grammar fixes in comments
[plcapi.git] / lib / xmlrpcs.inc
index 3fe530f..180595c 100644 (file)
        /**\r
        * Add a string to the debug info that can be later seralized by the server\r
        * as part of the response message.\r
-       * Note that for best compatbility, the debug string should be encoded using\r
+       * Note that for best compatibility, the debug string should be encoded using\r
        * the $GLOBALS['xmlrpc_internalencoding'] character set.\r
        * @param string $m\r
        * @access public\r
                * @see php_xmlrpc_encode for a list of values\r
                */\r
                var $phpvals_encoding_options = array( 'auto_dates' );\r
-               /// controls wether the server is going to echo debugging messages back to the client as comments in response body. valid values: 0,1,2,3\r
+               /// controls whether the server is going to echo debugging messages back to the client as comments in response body. valid values: 0,1,2,3\r
                var $debug = 1;\r
                /**\r
                * Controls behaviour of server when invoked user function throws an exception:\r
                var $user_data = null;\r
 \r
                /**\r
-               * @param array $dispmap the dispatch map withefinition of exposed services\r
-               * @param boolean $servicenow set to false to prevent the server from runnung upon construction\r
+               * @param array $dispmap the dispatch map with definition of exposed services\r
+               * @param boolean $servicenow set to false to prevent the server from running upon construction\r
                */\r
                function xmlrpc_server($dispMap=null, $serviceNow=true)\r
                {\r
                * with the standard processing of the php function exposed as method. In\r
                * particular, triggering an USER_ERROR level error will not halt script\r
                * execution anymore, but just end up logged in the xmlrpc response)\r
-               * Note that info added at elevel 2 and 3 will be base64 encoded\r
+               * Note that info added at level 2 and 3 will be base64 encoded\r
                * @access public\r
                */\r
                function setDebug($in)\r
                * Verify type and number of parameters received against a list of known signatures\r
                * @param array $in array of either xmlrpcval objects or xmlrpc type definitions\r
                * @param array $sig array of known signatures to match against\r
+               * @return array\r
                * @access private\r
                */\r
                function verifySignature($in, $sig)\r
 \r
                /**\r
                * Parse http headers received along with xmlrpc request. If needed, inflate request\r
-               * @return null on success or an xmlrpcresp\r
+               * @return mixed null on success or an xmlrpcresp\r
                * @access private\r
                */\r
                function parseRequestHeaders(&$data, &$req_encoding, &$resp_encoding, &$resp_compression)\r
                                }\r
                                /// @BUG this will fail on PHP 5 if charset is not specified in the xml prologue,\r
                                // the encoding is not UTF8 and there are non-ascii chars in the text...\r
-                               /// @todo use an ampty string for php 5 ???\r
+                               /// @todo use an empty string for php 5 ???\r
                                $parser = xml_parser_create($req_encoding);\r
                        }\r
                        else\r
 \r
                /**\r
                * add a string to the 'internal debug message' (separate from 'user debug message')\r
-               * @param string $strings\r
+               * @param string $string\r
                * @access private\r
                */\r
                function debugmsg($string)\r