X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=src%2FRequest.php;h=47144894ef7202aa9c4e5a3c1fee085a96b8acdf;hb=3b79b8fac3877418dad98585d9bc73d6b284d241;hp=2c4794086e91bc91608a2bd27dd42551209a5f80;hpb=9c35037a23ea6491bdf710260e8958902fc07605;p=plcapi.git
diff --git a/src/Request.php b/src/Request.php
index 2c47940..4714489 100644
--- a/src/Request.php
+++ b/src/Request.php
@@ -7,6 +7,10 @@ use PhpXmlRpc\Helper\Http;
use PhpXmlRpc\Helper\Logger;
use PhpXmlRpc\Helper\XMLParser;
+/**
+ * This class provides the representation of a request to an XML-RPC server.
+ * A client sends a PhpXmlrpc\Request to a server, and receives back an PhpXmlrpc\Response.
+ */
class Request
{
/// @todo: do these need to be public?
@@ -21,7 +25,7 @@ class Request
/**
* @param string $methodName the name of the method to invoke
- * @param Value[] $params array of parameters to be passed to the method (Value objects)
+ * @param Value[] $params array of parameters to be passed to the method (NB: Value objects, not plain php values)
*/
public function __construct($methodName, $params = array())
{
@@ -53,7 +57,8 @@ class Request
$this->content_type = 'text/xml';
}
$this->payload = $this->xml_header($charsetEncoding);
- $this->payload .= '' . Charset::instance()->encodeEntities($this->methodname, PhpXmlRpc::$xmlrpc_internalencoding, $charsetEncoding) . "\n";
+ $this->payload .= '' . Charset::instance()->encodeEntities(
+ $this->methodname, PhpXmlRpc::$xmlrpc_internalencoding, $charsetEncoding) . "\n";
$this->payload .= "\n";
foreach ($this->params as $p) {
$this->payload .= "\n" . $p->serialize($charsetEncoding) .
@@ -96,13 +101,15 @@ class Request
/**
* Add a parameter to the list of parameters to be used upon method invocation.
*
+ * Checks that $params is actually a Value object and not a plain php value.
+ *
* @param Value $param
*
* @return boolean false on failure
*/
public function addParam($param)
{
- // add check: do not add to self params which are not xmlrpc values
+ // check: do not add to self params which are not xmlrpc values
if (is_object($param) && is_a($param, 'PhpXmlRpc\Value')) {
$this->params[] = $param;
@@ -136,12 +143,11 @@ class Request
/**
* Given an open file handle, read all data available and parse it as an xmlrpc response.
+ *
* NB: the file handle is not closed by this function.
- * NNB: might have trouble in rare cases to work on network streams, as we
- * check for a read of 0 bytes instead of feof($fp).
- * But since checking for feof(null) returns false, we would risk an
- * infinite loop in that case, because we cannot trust the caller
- * to give us a valid pointer to an open file...
+ * NNB: might have trouble in rare cases to work on network streams, as we check for a read of 0 bytes instead of
+ * feof($fp). But since checking for feof(null) returns false, we would risk an infinite loop in that case,
+ * because we cannot trust the caller to give us a valid pointer to an open file...
*
* @param resource $fp stream pointer
*
@@ -161,9 +167,13 @@ class Request
/**
* Parse the xmlrpc response contained in the string $data and return a Response object.
*
- * @param string $data the xmlrpc response, eventually including http headers
- * @param bool $headersProcessed when true prevents parsing HTTP headers for interpretation of content-encoding and consequent decoding
- * @param string $returnType decides return type, i.e. content of response->value(). Either 'xmlrpcvals', 'xml' or 'phpvals'
+ * When $this->debug has been set to a value greater than 0, will echo debug messages to screen while decoding.
+ *
+ * @param string $data the xmlrpc response, possibly including http headers
+ * @param bool $headersProcessed when true prevents parsing HTTP headers for interpretation of content-encoding and
+ * consequent decoding
+ * @param string $returnType decides return type, i.e. content of response->value(). Either 'xmlrpcvals', 'xml' or
+ * 'phpvals'
*
* @return Response
*/
@@ -330,8 +340,8 @@ class Request
if ($xmlRpcParser->_xh['isf']) {
/// @todo we should test here if server sent an int and a string, and/or coerce them into such...
if ($returnType == 'xmlrpcvals') {
- $errNo_v = $v->structmem('faultCode');
- $errStr_v = $v->structmem('faultString');
+ $errNo_v = $v['faultCode'];
+ $errStr_v = $v['faultString'];
$errNo = $errNo_v->scalarval();
$errStr = $errStr_v->scalarval();
} else {