X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=src%2FResponse.php;h=7e2ebb66bb38ef312337bfeab58a882a915910fc;hb=cc67a43993662a5a3f92801b96b89ee6e3998532;hp=626fd64ffe687713f0ecf8ae5168bccce774bba8;hpb=c0e827c303b8228e64d461a9719ada6eaef7c61a;p=plcapi.git diff --git a/src/Response.php b/src/Response.php index 626fd64..7e2ebb6 100644 --- a/src/Response.php +++ b/src/Response.php @@ -18,13 +18,13 @@ class Response public $raw_data = ''; /** - * @param mixed $val either an xmlrpcval obj, a php value or the xml serialization of an xmlrpcval (a string) + * @param mixed $val either an xmlrpc value obj, a php value or the xml serialization of an xmlrpc value (a string) * @param integer $fCode set it to anything but 0 to create an error response * @param string $fString the error string, in case of an error response * @param string $valType either 'xmlrpcvals', 'phpvals' or 'xml' * * @todo add check that $val / $fCode / $fString is of correct type??? - * NB: as of now we do not do it, since it might be either an xmlrpcval or a plain + * NB: as of now we do not do it, since it might be either an xmlrpc value or a plain * php val, or a complete xml chunk, depending on usage of Client::send() inside which creator is called... */ public function __construct($val, $fCode = 0, $fString = '', $valType = '') @@ -33,7 +33,6 @@ class Response // error response $this->errno = $fCode; $this->errstr = $fString; - //$this->errstr = htmlspecialchars($fString); // XXX: encoding probably shouldn't be done here; fix later. } else { // successful response $this->val = $val; @@ -76,7 +75,7 @@ class Response /** * Returns the value received by the server. * - * @return mixed the xmlrpcval object returned by the server. Might be an xml string or php value if the response has been created by specially configured Client objects + * @return Value|string|mixed the xmlrpc value object returned by the server. Might be an xml string or php value if the response has been created by specially configured Client objects */ public function value() {