X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=src%2FValue.php;h=f544fa588745a0b75638b225afff9f86a87c470e;hb=b19b4df8cca4856106ed6d19c9fec5d3e2fdcab3;hp=b9d34fe9f692bff0e2fd65e28c90421f9d53880b;hpb=9ff27b2483717ec728dda6a9045d2146e85bde86;p=plcapi.git

diff --git a/src/Value.php b/src/Value.php
index b9d34fe..f544fa5 100644
--- a/src/Value.php
+++ b/src/Value.php
@@ -31,12 +31,14 @@ class Value
         "null" => 1,
     );
 
-    /// @todo: does these need to be public?
+    /// @todo: do these need to be public?
     public $me = array();
     public $mytype = 0;
     public $_php_class = null;
 
     /**
+     * Build an xmlrpc value
+     *
      * @param mixed $val
      * @param string $type any valid xmlrpc type name (lowercase). If null, 'string' is assumed
      */
@@ -94,7 +96,7 @@ class Value
     }
 
     /**
-     * Add a single php value to an (unitialized) xmlrpcval.
+     * Add a single php value to an (unitialized) xmlrpc value.
      *
      * @param mixed $val
      * @param string $type
@@ -103,12 +105,12 @@ class Value
      */
     public function addScalar($val, $type = 'string')
     {
-        $typeof = null;
+        $typeOf = null;
         if (isset(static::$xmlrpcTypes[$type])) {
-            $typeof = static::$xmlrpcTypes[$type];
+            $typeOf = static::$xmlrpcTypes[$type];
         }
 
-        if ($typeof !== 1) {
+        if ($typeOf !== 1) {
             error_log("XML-RPC: " . __METHOD__ . ": not a scalar type ($type)");
 
             return 0;
@@ -142,31 +144,31 @@ class Value
             default:
                 // a scalar, so set the value and remember we're scalar
                 $this->me[$type] = $val;
-                $this->mytype = $typeof;
+                $this->mytype = $typeOf;
 
                 return 1;
         }
     }
 
     /**
-     * Add an array of xmlrpcval objects to an xmlrpcval.
+     * Add an array of xmlrpc values objects to an xmlrpc value.
      *
-     * @param Value[] $vals
+     * @param Value[] $values
      *
      * @return int 1 or 0 on failure
      *
-     * @todo add some checking for $vals to be an array of xmlrpcvals?
+     * @todo add some checking for $values to be an array of xmlrpc values?
      */
-    public function addArray($vals)
+    public function addArray($values)
     {
         if ($this->mytype == 0) {
             $this->mytype = static::$xmlrpcTypes['array'];
-            $this->me['array'] = $vals;
+            $this->me['array'] = $values;
 
             return 1;
         } elseif ($this->mytype == 2) {
             // we're adding to an array here
-            $this->me['array'] = array_merge($this->me['array'], $vals);
+            $this->me['array'] = array_merge($this->me['array'], $values);
 
             return 1;
         } else {
@@ -177,24 +179,24 @@ class Value
     }
 
     /**
-     * Add an array of named xmlrpcval objects to an xmlrpcval.
+     * Add an array of named xmlrpc value objects to an xmlrpc value.
      *
-     * @param Value[] $vals
+     * @param Value[] $values
      *
      * @return int 1 or 0 on failure
      *
-     * @todo add some checking for $vals to be an array?
+     * @todo add some checking for $values to be an array?
      */
-    public function addStruct($vals)
+    public function addStruct($values)
     {
         if ($this->mytype == 0) {
             $this->mytype = static::$xmlrpcTypes['struct'];
-            $this->me['struct'] = $vals;
+            $this->me['struct'] = $values;
 
             return 1;
         } elseif ($this->mytype == 3) {
             // we're adding to a struct here
-            $this->me['struct'] = array_merge($this->me['struct'], $vals);
+            $this->me['struct'] = array_merge($this->me['struct'], $values);
 
             return 1;
         } else {
@@ -226,7 +228,7 @@ class Value
         }
     }
 
-    protected function serializedata($typ, $val, $charset_encoding = '')
+    protected function serializedata($typ, $val, $charsetEncoding = '')
     {
         $rs = '';
 
@@ -246,7 +248,7 @@ class Value
                     case static::$xmlrpcString:
                         // G. Giunta 2005/2/13: do NOT use htmlentities, since
                         // it will produce named html entities, which are invalid xml
-                        $rs .= "<${typ}>" . Charset::instance()->encodeEntities($val, PhpXmlRpc::$xmlrpc_internalencoding, $charset_encoding) . "</${typ}>";
+                        $rs .= "<${typ}>" . Charset::instance()->encodeEntities($val, PhpXmlRpc::$xmlrpc_internalencoding, $charsetEncoding) . "</${typ}>";
                         break;
                     case static::$xmlrpcInt:
                     case static::$xmlrpcI4:
@@ -281,7 +283,7 @@ class Value
                         break;
                     default:
                         // no standard type value should arrive here, but provide a possibility
-                        // for xmlrpcvals of unknown type...
+                        // for xmlrpc values of unknown type...
                         $rs .= "<${typ}>${val}</${typ}>";
                 }
                 break;
@@ -294,9 +296,9 @@ class Value
                 }
                 $charsetEncoder = Charset::instance();
                 foreach ($val as $key2 => $val2) {
-                    $rs .= '<member><name>' . $charsetEncoder->encodeEntities($key2, PhpXmlRpc::$xmlrpc_internalencoding, $charset_encoding) . "</name>\n";
+                    $rs .= '<member><name>' . $charsetEncoder->encodeEntities($key2, PhpXmlRpc::$xmlrpc_internalencoding, $charsetEncoding) . "</name>\n";
                     //$rs.=$this->serializeval($val2);
-                    $rs .= $val2->serialize($charset_encoding);
+                    $rs .= $val2->serialize($charsetEncoding);
                     $rs .= "</member>\n";
                 }
                 $rs .= '</struct>';
@@ -306,7 +308,7 @@ class Value
                 $rs .= "<array>\n<data>\n";
                 foreach ($val as $element) {
                     //$rs.=$this->serializeval($val[$i]);
-                    $rs .= $element->serialize($charset_encoding);
+                    $rs .= $element->serialize($charsetEncoding);
                 }
                 $rs .= "</data>\n</array>";
                 break;
@@ -320,50 +322,50 @@ class Value
     /**
      * Returns xml representation of the value. XML prologue not included.
      *
-     * @param string $charset_encoding the charset to be used for serialization. if null, US-ASCII is assumed
+     * @param string $charsetEncoding the charset to be used for serialization. if null, US-ASCII is assumed
      *
      * @return string
      */
-    public function serialize($charset_encoding = '')
+    public function serialize($charsetEncoding = '')
     {
-        // add check? slower, but helps to avoid recursion in serializing broken xmlrpcvals...
+        // add check? slower, but helps to avoid recursion in serializing broken xmlrpc values...
         //if (is_object($o) && (get_class($o) == 'xmlrpcval' || is_subclass_of($o, 'xmlrpcval')))
         //{
         reset($this->me);
         list($typ, $val) = each($this->me);
 
-        return '<value>' . $this->serializedata($typ, $val, $charset_encoding) . "</value>\n";
+        return '<value>' . $this->serializedata($typ, $val, $charsetEncoding) . "</value>\n";
         //}
     }
 
     /**
      * Checks whether a struct member with a given name is present.
-     * Works only on xmlrpcvals of type struct.
+     * Works only on xmlrpc values of type struct.
      *
-     * @param string $m the name of the struct member to be looked up
+     * @param string $key the name of the struct member to be looked up
      *
      * @return boolean
      */
-    public function structmemexists($m)
+    public function structmemexists($key)
     {
-        return array_key_exists($m, $this->me['struct']);
+        return array_key_exists($key, $this->me['struct']);
     }
 
     /**
-     * Returns the value of a given struct member (an xmlrpcval object in itself).
+     * Returns the value of a given struct member (an xmlrpc value object in itself).
      * Will raise a php warning if struct member of given name does not exist.
      *
-     * @param string $m the name of the struct member to be looked up
+     * @param string $key the name of the struct member to be looked up
      *
      * @return Value
      */
-    public function structmem($m)
+    public function structmem($key)
     {
-        return $this->me['struct'][$m];
+        return $this->me['struct'][$key];
     }
 
     /**
-     * Reset internal pointer for xmlrpcvals of type struct.
+     * Reset internal pointer for xmlrpc values of type struct.
      */
     public function structreset()
     {
@@ -371,9 +373,9 @@ class Value
     }
 
     /**
-     * Return next member element for xmlrpcvals of type struct.
+     * Return next member element for xmlrpc values of type struct.
      *
-     * @return xmlrpcval
+     * @return Value
      */
     public function structeach()
     {
@@ -381,7 +383,7 @@ class Value
     }
 
     /**
-     * Returns the value of a scalar xmlrpcval.
+     * Returns the value of a scalar xmlrpc value.
      *
      * @return mixed
      */
@@ -394,7 +396,7 @@ class Value
     }
 
     /**
-     * Returns the type of the xmlrpcval.
+     * Returns the type of the xmlrpc value.
      * For integers, 'int' is always returned in place of 'i4'.
      *
      * @return string
@@ -411,19 +413,19 @@ class Value
     }
 
     /**
-     * Returns the m-th member of an xmlrpcval of struct type.
+     * Returns the m-th member of an xmlrpc value of struct type.
      *
-     * @param integer $m the index of the value to be retrieved (zero based)
+     * @param integer $key the index of the value to be retrieved (zero based)
      *
      * @return Value
      */
-    public function arraymem($m)
+    public function arraymem($key)
     {
-        return $this->me['array'][$m];
+        return $this->me['array'][$key];
     }
 
     /**
-     * Returns the number of members in an xmlrpcval of array type.
+     * Returns the number of members in an xmlrpc value of array type.
      *
      * @return integer
      */
@@ -433,7 +435,7 @@ class Value
     }
 
     /**
-     * Returns the number of members in an xmlrpcval of struct type.
+     * Returns the number of members in an xmlrpc value of struct type.
      *
      * @return integer
      */