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
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
return 1;
} else {
error_log('XML-RPC: ' . __METHOD__ . ': already initialized as a [' . $this->kindOf() . ']');
-
return 0;
}
}
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
*/
* @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($key)
{
* @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($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()
{
* @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($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