X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=src%2FValue.php;h=c9fc61406b39afad04a1f223a7c3e0b58df0ab1a;hb=f4978078febfc4289bb4f45db6ca3f9e6c8c4f94;hp=0d963b53ba1d9c4b1d522da86df0d7d2d2a818e4;hpb=779732528b1a39798fbebc2443ea8f2e0b562e3f;p=plcapi.git diff --git a/src/Value.php b/src/Value.php index 0d963b5..c9fc614 100644 --- a/src/Value.php +++ b/src/Value.php @@ -4,7 +4,10 @@ namespace PhpXmlRpc; use PhpXmlRpc\Helper\Charset; -class Value +/** + * This class enables the creation and encapsulation of values for XML-RPC. + */ +class Value implements \Countable, \IteratorAggregate, \ArrayAccess { public static $xmlrpcI4 = "i4"; public static $xmlrpcInt = "int"; @@ -31,23 +34,27 @@ 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 + * Build an xmlrpc value. * - * @param mixed $val - * @param string $type any valid xmlrpc type name (lowercase). If null, 'string' is assumed + * When no value or type is passed in, the value is left uninitialized, and the value can be added later. + * + * @param mixed $val if passing in an array, all array elements should be PhpXmlRpc\Value themselves + * @param string $type any valid xmlrpc type name (lowercase): i4, int, boolean, string, double, dateTime.iso8601, + * base64, array, struct, null. + * If null, 'string' is assumed. + * You should refer to http://www.xmlrpc.com/spec for more information on what each of these mean. */ public function __construct($val = -1, $type = '') { // 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; @@ -75,31 +82,18 @@ class Value 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 xmlrpc value. + * + * If the xmlrpc value is an array, the php value is added as its last element. + * If the xmlrpc value is empty (uninitialized), this method makes it a scalar value, and sets that value. + * Fails if the xmlrpc value is not an array and already initialized. * * @param mixed $val - * @param string $type + * @param string $type allowed values: i4, int, boolean, string, double, dateTime.iso8601, base64, null. * * @return int 1 or 0 on failure */ @@ -112,7 +106,6 @@ class Value if ($typeOf !== 1) { error_log("XML-RPC: " . __METHOD__ . ": not a scalar type ($type)"); - return 0; } @@ -130,11 +123,9 @@ class Value 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 @@ -151,7 +142,11 @@ class Value } /** - * Add an array of xmlrpc values objects to an xmlrpc value. + * Add an array of xmlrpc value objects to an xmlrpc value. + * + * If the xmlrpc value is an array, the elements are appended to the existing ones. + * If the xmlrpc value is empty (uninitialized), this method makes it an array value, and sets that value. + * Fails otherwise. * * @param Value[] $values * @@ -173,13 +168,16 @@ class Value 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. + * Merges an array of named xmlrpc value objects into an xmlrpc value. + * + * If the xmlrpc value is a struct, the elements are merged with the existing ones (overwriting existing ones). + * If the xmlrpc value is empty (uninitialized), this method makes it a struct value, and sets that value. + * Fails otherwise. * * @param Value[] $values * @@ -201,13 +199,12 @@ class Value 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 either "struct", "array", "scalar" or "undef", describing the base type of the value. * * @return string */ @@ -320,7 +317,7 @@ class Value } /** - * Returns xml representation of the value. XML prologue not included. + * Returns the xml representation of the value. XML prologue not included. * * @param string $charsetEncoding the charset to be used for serialization. if null, US-ASCII is assumed * @@ -340,11 +337,14 @@ class Value /** * Checks whether a struct member with a given name is present. + * * Works only on xmlrpc values of type struct. * * @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) { @@ -358,6 +358,8 @@ class Value * @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) { @@ -366,6 +368,7 @@ class Value /** * Reset internal pointer for xmlrpc values of type struct. + * @deprecated iterate directly over the object using foreach instead */ public function structreset() { @@ -376,6 +379,8 @@ class Value * Return next member element for xmlrpc values of type struct. * * @return Value + * + * @deprecated iterate directly over the object using foreach instead */ public function structeach() { @@ -383,7 +388,7 @@ class Value } /** - * Returns the value of a scalar xmlrpc value. + * Returns the value of a scalar xmlrpc value (base 64 decoding is automatically handled here) * * @return mixed */ @@ -397,6 +402,7 @@ class Value /** * Returns the type of the xmlrpc value. + * * For integers, 'int' is always returned in place of 'i4'. * * @return string @@ -413,11 +419,13 @@ class Value } /** - * Returns the m-th member of an xmlrpc value of struct type. + * Returns the m-th member of an xmlrpc value of array type. * * @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) { @@ -428,6 +436,8 @@ class Value * Returns the number of members in an xmlrpc value of array type. * * @return integer + * + * @deprecated use count() instead */ public function arraysize() { @@ -438,9 +448,140 @@ class Value * 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 scalar values + * - the number of elements for struct and array values + * + * @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