use PhpXmlRpc\Helper\Charset;
-class Value
+class Value implements \Countable, \IteratorAggregate, \ArrayAccess
{
public static $xmlrpcI4 = "i4";
public static $xmlrpcInt = "int";
"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
+ * Build an xmlrpc value.
+ * When no value or type is passed in, the value is left uninitialized, and the value can be added later
*
* @param mixed $val
* @param string $type any valid xmlrpc type name (lowercase). If null, 'string' is assumed
// 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) {
case '':
$this->mytype = 1;
default:
error_log("XML-RPC: " . __METHOD__ . ": not a known type ($type)");
}
- /* was:
- if($type=='')
- {
- $type='string';
- }
- if(static::$xmlrpcTypes[$type]==1)
- {
- $this->addScalar($val,$type);
- }
- elseif(static::$xmlrpcTypes[$type]==2)
- {
- $this->addArray($val);
- }
- elseif(static::$xmlrpcTypes[$type]==3)
- {
- $this->addStruct($val);
- }*/
}
}
/**
- * Add a single php value to an (unitialized) xmlrpc value.
+ * Add a single php value to an (uninitialized) 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;
}
switch ($this->mytype) {
case 1:
error_log('XML-RPC: ' . __METHOD__ . ': scalar xmlrpc value can have only one value');
-
return 0;
case 3:
error_log('XML-RPC: ' . __METHOD__ . ': cannot add anonymous scalar to struct xmlrpc value');
-
return 0;
case 2:
// we're adding a scalar value to an array here
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 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 xmlrpc values?
+ * @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 {
error_log('XML-RPC: ' . __METHOD__ . ': already initialized as a [' . $this->kindOf() . ']');
-
return 0;
}
}
/**
* 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 {
error_log('XML-RPC: ' . __METHOD__ . ': already initialized as a [' . $this->kindOf() . ']');
-
return 0;
}
}
/**
- * Returns a string containing "struct", "array" or "scalar" describing the base type of the value.
+ * Returns a string containing "struct", "array", "scalar" or "undef" describing the base type of the value.
*
* @return string
*/
}
}
- protected 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()->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:
}
$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>';
$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 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 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
+ *
+ * @deprecated use array access, e.g. isset($val[$key])
*/
- 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 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
+ *
+ * @deprecated use array access, e.g. $val[$key]
*/
- public function structmem($m)
+ public function structmem($key)
{
- return $this->me['struct'][$m];
+ return $this->me['struct'][$key];
}
/**
* Reset internal pointer for xmlrpc values of type struct.
+ * @deprecated iterate directly over the object using foreach instead
*/
public function structreset()
{
* Return next member element for xmlrpc values of type struct.
*
* @return Value
+ *
+ * @deprecated iterate directly over the object using foreach instead
*/
public function structeach()
{
/**
* 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
+ *
+ * @deprecated use array access, e.g. $val[$key]
*/
- 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 xmlrpc value of array type.
*
* @return integer
+ *
+ * @deprecated use count() instead
*/
public function arraysize()
{
* Returns the number of members in an xmlrpc value of struct type.
*
* @return integer
+ *
+ * @deprecated use count() instead
*/
public function structsize()
{
return count($this->me['struct']);
}
-}
+
+ /**
+ * Returns the number of members in an xmlrpc value:
+ * - 0 for uninitialized values
+ * - 1 for scalars
+ * - the number of elements for structs and arrays
+ *
+ * @return integer
+ */
+ public function count()
+ {
+ switch ($this->mytype) {
+ case 3:
+ return count($this->me['struct']);
+ case 2:
+ return count($this->me['array']);
+ case 1:
+ return 1;
+ default:
+ return 0;
+ }
+ }
+
+ /**
+ * Implements the IteratorAggregate interface
+ *
+ * @return ArrayIterator
+ */
+ public function getIterator() {
+ switch ($this->mytype) {
+ case 3:
+ return new \ArrayIterator($this->me['struct']);
+ case 2:
+ return new \ArrayIterator($this->me['array']);
+ case 1:
+ return new \ArrayIterator($this->me);
+ default:
+ return new \ArrayIterator();
+ }
+ return new \ArrayIterator();
+ }
+
+
+ public function offsetSet($offset, $value) {
+
+ switch ($this->mytype) {
+ case 3:
+ if (!($value instanceof \PhpXmlRpc\Value)) {
+ throw new \Exception('It is only possible to add Value objects to an XML-RPC Struct');
+ }
+ if (is_null($offset)) {
+ // disallow struct members with empty names
+ throw new \Exception('It is not possible to add anonymous members to an XML-RPC Struct');
+ } else {
+ $this->me['struct'][$offset] = $value;
+ }
+ return;
+ case 2:
+ if (!($value instanceof \PhpXmlRpc\Value)) {
+ throw new \Exception('It is only possible to add Value objects to an XML-RPC Array');
+ }
+ if (is_null($offset)) {
+ $this->me['array'][] = $value;
+ } else {
+ // nb: we are not checking that $offset is above the existing array range...
+ $this->me['array'][$offset] = $value;
+ }
+ return;
+ case 1:
+// todo: handle i4 vs int
+ reset($this->me);
+ list($type,) = each($this->me);
+ if ($type != $offset) {
+ throw new \Exception('');
+ }
+ $this->me[$type] = $value;
+ return;
+ default:
+ // it would be nice to allow empty values to be be turned into non-empty ones this way, but we miss info to do so
+ throw new \Exception("XML-RPC Value is of type 'undef' and its value can not be set using array index");
+ }
+ }
+
+ public function offsetExists($offset) {
+ switch ($this->mytype) {
+ case 3:
+ return isset($this->me['struct'][$offset]);
+ case 2:
+ return isset($this->me['array'][$offset]);
+ case 1:
+// todo: handle i4 vs int
+ return $offset == $this->scalartyp();
+ default:
+ return false;
+ }
+ }
+
+ public function offsetUnset($offset) {
+ switch ($this->mytype) {
+ case 3:
+ unset($this->me['struct'][$offset]);
+ return;
+ case 2:
+ unset($this->me['array'][$offset]);
+ return;
+ case 1:
+ // can not remove value from a scalar
+ throw new \Exception("XML-RPC Value is of type 'scalar' and its value can not be unset using array index");
+ default:
+ throw new \Exception("XML-RPC Value is of type 'undef' and its value can not be unset using array index");
+ }
+ }
+
+ public function offsetGet($offset) {
+ switch ($this->mytype) {
+ case 3:
+ return isset($this->me['struct'][$offset]) ? $this->me['struct'][$offset] : null;
+ case 2:
+ return isset($this->me['array'][$offset]) ? $this->me['array'][$offset] : null;
+ case 1:
+// on bad type: null or exception?
+ reset($this->me);
+ list($type, $value) = each($this->me);
+ return $type == $offset ? $value : null;
+ default:
+// return null or exception?
+ throw new \Exception("XML-RPC Value is of type 'undef' and can not be accessed using array index");
+ }
+ }
+}
\ No newline at end of file
git://git.onelab.eu / plcapi.git / blobdiff