"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
*/
public function __construct($val = -1, $type = '')
{
- /// @todo: optimization creep - do not call addXX, do it all inline.
- /// downside: booleans will not be coerced anymore
+ // optimization creep - do not call addXX, do it all inline.
+ // downside: booleans will not be coerced anymore
if ($val !== -1 || $type != '') {
// optimization creep: inlined all work done by constructor
switch ($type) {
default:
error_log("XML-RPC: " . __METHOD__ . ": not a known type ($type)");
}
- /*if($type=='')
+ /* was:
+ if($type=='')
{
$type='string';
}
}
/**
- * 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
*/
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;
return 0;
case 2:
// we're adding a scalar value to an array here
- //$ar=$this->me['array'];
- //$ar[]=new Value($val, $type);
- //$this->me['array']=$ar;
- // Faster (?) avoid all the costly array-copy-by-val done here...
$this->me['array'][] = new Value($val, $type);
return 1;
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 {
}
/**
- * 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 {
}
}
- private function serializedata($typ, $val, $charset_encoding = '')
+ protected function serializedata($typ, $val, $charsetEncoding = '')
{
$rs = '';
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()->encode_entities($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:
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;
}
$charsetEncoder = Charset::instance();
foreach ($val as $key2 => $val2) {
- $rs .= '<member><name>' . $charsetEncoder->encode_entities($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>';
$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;
/**
* 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";
- //}
- }
-
- // DEPRECATED
- public function serializeval($o)
- {
- // add check? slower, but helps to avoid recursion in serializing broken xmlrpcvals...
- //if (is_object($o) && (get_class($o) == 'xmlrpcval' || is_subclass_of($o, 'xmlrpcval')))
- //{
- $ar = $o->me;
- reset($ar);
- list($typ, $val) = each($ar);
-
- return '<value>' . $this->serializedata($typ, $val) . "</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()
{
}
/**
- * 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()
{
return each($this->me['struct']);
}
- // DEPRECATED! this code looks like it is very fragile and has not been fixed
- // for a long long time. Shall we remove it for 2.0?
- public function getval()
- {
- // UNSTABLE
- reset($this->me);
- list($a, $b) = each($this->me);
- // contributed by I Sofer, 2001-03-24
- // add support for nested arrays to scalarval
- // i've created a new method here, so as to
- // preserve back compatibility
-
- if (is_array($b)) {
- @reset($b);
- while (list($id, $cont) = @each($b)) {
- $b[$id] = $cont->scalarval();
- }
- }
-
- // add support for structures directly encoding php objects
- if (is_object($b)) {
- $t = get_object_vars($b);
- @reset($t);
- while (list($id, $cont) = @each($t)) {
- $t[$id] = $cont->scalarval();
- }
- @reset($t);
- while (list($id, $cont) = @each($t)) {
- @$b->$id = $cont;
- }
- }
- // end contrib
- return $b;
- }
-
/**
- * Returns the value of a scalar xmlrpcval.
+ * Returns the value of a scalar xmlrpc value.
*
* @return mixed
*/
}
/**
- * 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
}
/**
- * 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
*/
}
/**
- * 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
*/