From e75bfc4ad39a6f30b0b9840f3c63b2f14a1c12c4 Mon Sep 17 00:00:00 2001 From: gggeek Date: Sun, 22 Mar 2015 18:51:02 +0000 Subject: [PATCH] Improve phpdocs; fix Request dumping http headers with proper format --- src/Request.php | 21 ++++++++++----------- src/Value.php | 8 ++++---- 2 files changed, 14 insertions(+), 15 deletions(-) diff --git a/src/Request.php b/src/Request.php index 835767a..a136bb3 100644 --- a/src/Request.php +++ b/src/Request.php @@ -19,7 +19,7 @@ class Request /** * @param string $methodName the name of the method to invoke - * @param array $params array of parameters to be passed to the method (xmlrpcval objects) + * @param Value[] $params array of parameters to be passed to the method (Value objects) */ public function __construct($methodName, $params = array()) { @@ -74,7 +74,7 @@ class Request /** * Gets/sets the xmlrpc method to be invoked. * - * @param string $meth the method to be set (leave empty not to set it) + * @param string $methodName the method to be set (leave empty not to set it) * * @return string the method that will be invoked */ @@ -104,7 +104,7 @@ class Request /** * Add a parameter to the list of parameters to be used upon method invocation. * - * @param Value $par + * @param Value $param * * @return boolean false on failure */ @@ -133,7 +133,7 @@ class Request } /** - * Returns the number of parameters in the messge. + * Returns the number of parameters in the message. * * @return integer the number of parameters currently set */ @@ -143,7 +143,7 @@ class Request } /** - * Given an open file handle, read all data available and parse it as axmlrpc response. + * 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). @@ -297,17 +297,16 @@ class Request } $data = substr($data, $bd); - - /// @todo when in CLI mode, do not html-encode the output + if ($this->debug && count($this->httpResponse['headers'])) { - print "\n"; + $msg = ''; foreach ($this->httpResponse['headers'] as $header => $value) { - print htmlentities("HEADER: $header: $value\n"); + $msg .= "HEADER: $header: $value\n"; } foreach ($this->httpResponse['cookies'] as $header => $value) { - print htmlentities("COOKIE: $header={$value['value']}\n"); + $msg .= "COOKIE: $header={$value['value']}\n"; } - print "\n"; + $this->debugMessage($msg); } // if CURL was used for the call, http headers have been processed, diff --git a/src/Value.php b/src/Value.php index 76d3a02..e47e954 100644 --- a/src/Value.php +++ b/src/Value.php @@ -154,7 +154,7 @@ class Value /** * Add an array of xmlrpcval objects to an xmlrpcval. * - * @param array $vals + * @param Value[] $vals * * @return int 1 or 0 on failure * @@ -182,7 +182,7 @@ class Value /** * Add an array of named xmlrpcval objects to an xmlrpcval. * - * @param array $vals + * @param Value[] $vals * * @return int 1 or 0 on failure * @@ -372,7 +372,7 @@ class Value * * @param string $m the name of the struct member to be looked up * - * @return xmlrpcval + * @return Value */ public function structmem($m) { @@ -467,7 +467,7 @@ class Value * * @param integer $m the index of the value to be retrieved (zero based) * - * @return xmlrpcval + * @return Value */ public function arraymem($m) { -- 2.43.0