namespace PhpXmlRpc;
use PhpXmlRpc\Helper\Charset;
+use PhpXmlRpc\Helper\Logger;
+/**
+ * This class enables the creation of values for XML-RPC, by encapsulating plain php values.
+ */
class Value implements \Countable, \IteratorAggregate, \ArrayAccess
{
public static $xmlrpcI4 = "i4";
+ public static $xmlrpcI8 = "i8";
public static $xmlrpcInt = "int";
public static $xmlrpcBoolean = "boolean";
public static $xmlrpcDouble = "double";
public static $xmlrpcTypes = array(
"i4" => 1,
+ "i8" => 1,
"int" => 1,
"boolean" => 1,
"double" => 1,
"null" => 1,
);
+ protected static $logger;
+ protected static $charsetEncoder;
+
/// @todo: do these need to be public?
+ /** @var Value[]|mixed */
public $me = array();
+ /**
+ * @var int $mytype
+ * @internal
+ */
public $mytype = 0;
+ /** @var string|null $_php_class */
public $_php_class = null;
+ public function getLogger()
+ {
+ if (self::$logger === null) {
+ self::$logger = Logger::instance();
+ }
+ return self::$logger;
+ }
+
+ public static function setLogger($logger)
+ {
+ self::$logger = $logger;
+ }
+
+ public function getCharsetEncoder()
+ {
+ if (self::$charsetEncoder === null) {
+ self::$charsetEncoder = Charset::instance();
+ }
+ return self::$charsetEncoder;
+ }
+
+ public function setCharsetEncoder($charsetEncoder)
+ {
+ self::$charsetEncoder = $charsetEncoder;
+ }
+
/**
* 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
+ * When no value or type is passed in, the value is left uninitialized, and the value can be added later.
+ *
+ * @param Value[]|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 = '')
{
$this->me['string'] = $val;
break;
case 'i4':
+ case 'i8':
case 'int':
case 'double':
case 'string':
$this->me['struct'] = $val;
break;
default:
- error_log("XML-RPC: " . __METHOD__ . ": not a known type ($type)");
+ $this->getLogger()->errorLog("XML-RPC: " . __METHOD__ . ": not a known type ($type)");
}
}
}
/**
- * Add a single php value to an (uninitialized) 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, i8, int, boolean, string, double, dateTime.iso8601, base64, null.
*
* @return int 1 or 0 on failure
*/
}
if ($typeOf !== 1) {
- error_log("XML-RPC: " . __METHOD__ . ": not a scalar type ($type)");
+ $this->getLogger()->errorLog("XML-RPC: " . __METHOD__ . ": not a scalar type ($type)");
return 0;
}
// coerce booleans into correct values
- // NB: we should either do it for datetimes, integers and doubles, too,
+ // NB: we should either do it for datetimes, integers, i8 and doubles, too,
// or just plain remove this check, implemented on booleans only...
if ($type == static::$xmlrpcBoolean) {
if (strcasecmp($val, 'true') == 0 || $val == 1 || ($val == true && strcasecmp($val, 'false'))) {
switch ($this->mytype) {
case 1:
- error_log('XML-RPC: ' . __METHOD__ . ': scalar xmlrpc value can have only one value');
+ $this->getLogger()->errorLog('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');
+ $this->getLogger()->errorLog('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
}
/**
- * 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
*
return 1;
} else {
- error_log('XML-RPC: ' . __METHOD__ . ': already initialized as a [' . $this->kindOf() . ']');
+ $this->getLogger()->errorLog('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
*
return 1;
} else {
- error_log('XML-RPC: ' . __METHOD__ . ': already initialized as a [' . $this->kindOf() . ']');
+ $this->getLogger()->errorLog('XML-RPC: ' . __METHOD__ . ': already initialized as a [' . $this->kindOf() . ']');
return 0;
}
}
/**
- * Returns a string containing "struct", "array", "scalar" or "undef" 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
*/
switch ($this->mytype) {
case 3:
return 'struct';
- break;
case 2:
return 'array';
- break;
case 1:
return 'scalar';
- break;
default:
return 'undef';
}
}
+ /**
+ * @param string typ
+ * @param Value[]|mixed $val
+ * @param string $charsetEncoding
+ * @return string
+ */
protected function serializedata($typ, $val, $charsetEncoding = '')
{
$rs = '';
$rs .= "<${typ}>" . ($val ? '1' : '0') . "</${typ}>";
break;
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, $charsetEncoding) . "</${typ}>";
+ // Do NOT use htmlentities, since it will produce named html entities, which are invalid xml
+ $rs .= "<${typ}>" . $this->getCharsetEncoder()->encodeEntities($val, PhpXmlRpc::$xmlrpc_internalencoding, $charsetEncoding) . "</${typ}>";
break;
case static::$xmlrpcInt:
case static::$xmlrpcI4:
+ case static::$xmlrpcI8:
$rs .= "<${typ}>" . (int)$val . "</${typ}>";
break;
case static::$xmlrpcDouble:
// sprintf('%F') could be most likely ok but it fails eg. on 2e-14.
// The code below tries its best at keeping max precision while avoiding exp notation,
// but there is of course no limit in the number of decimal places to be used...
- $rs .= "<${typ}>" . preg_replace('/\\.?0+$/', '', number_format((double)$val, 128, '.', '')) . "</${typ}>";
+ $rs .= "<${typ}>" . preg_replace('/\\.?0+$/', '', number_format((double)$val, PhpXmlRpc::$xmlpc_double_precision, '.', '')) . "</${typ}>";
break;
case static::$xmlrpcDateTime:
if (is_string($val)) {
} else {
$rs .= "<struct>\n";
}
- $charsetEncoder = Charset::instance();
+ $charsetEncoder = $this->getCharsetEncoder();
+ /** @var Value $val2 */
foreach ($val as $key2 => $val2) {
$rs .= '<member><name>' . $charsetEncoder->encodeEntities($key2, PhpXmlRpc::$xmlrpc_internalencoding, $charsetEncoding) . "</name>\n";
//$rs.=$this->serializeval($val2);
case 2:
// array
$rs .= "<array>\n<data>\n";
+ /** @var Value $element */
foreach ($val as $element) {
//$rs.=$this->serializeval($val[$i]);
$rs .= $element->serialize($charsetEncoding);
}
/**
- * 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
*
*/
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);
+ $val = reset($this->me);
+ $typ = key($this->me);
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 $key the name of the struct member to be looked up
*/
public function structmemexists($key)
{
+ //trigger_error('Method ' . __METHOD__ . ' is deprecated', E_USER_DEPRECATED);
+
return array_key_exists($key, $this->me['struct']);
}
*/
public function structmem($key)
{
+ //trigger_error('Method ' . __METHOD__ . ' is deprecated', E_USER_DEPRECATED);
+
return $this->me['struct'][$key];
}
*/
public function structreset()
{
+ //trigger_error('Method ' . __METHOD__ . ' is deprecated', E_USER_DEPRECATED);
+
reset($this->me['struct']);
}
* Return next member element for xmlrpc values of type struct.
*
* @return Value
+ * @throws \Error starting with php 8.0, this function should not be used, as it will always throw
*
* @deprecated iterate directly over the object using foreach instead
*/
public function structeach()
{
- return each($this->me['struct']);
+ //trigger_error('Method ' . __METHOD__ . ' is deprecated', E_USER_DEPRECATED);
+
+ return @each($this->me['struct']);
}
/**
- * 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
*/
public function scalarval()
{
- reset($this->me);
- list(, $b) = each($this->me);
+ $b = reset($this->me);
return $b;
}
/**
* Returns the type of the xmlrpc value.
- * For integers, 'int' is always returned in place of 'i4'.
+ *
+ * For integers, 'int' is always returned in place of 'i4'. 'i8' is considered a separate type and returned as such
*
* @return string
*/
public function scalartyp()
{
reset($this->me);
- list($a,) = each($this->me);
+ $a = key($this->me);
if ($a == static::$xmlrpcI4) {
$a = static::$xmlrpcInt;
}
}
/**
- * 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)
*
*/
public function arraymem($key)
{
+ //trigger_error('Method ' . __METHOD__ . ' is deprecated', E_USER_DEPRECATED);
+
return $this->me['array'][$key];
}
*/
public function arraysize()
{
+ //trigger_error('Method ' . __METHOD__ . ' is deprecated', E_USER_DEPRECATED);
+
return count($this->me['array']);
}
*/
public function structsize()
{
+ //trigger_error('Method ' . __METHOD__ . ' is deprecated', E_USER_DEPRECATED);
+
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
+ * - 1 for scalar values
+ * - the number of elements for struct and array values
*
* @return integer
*/
/**
* Implements the IteratorAggregate interface
*
- * @return ArrayIterator
+ * @return \ArrayIterator
+ * @internal required to be public to implement an Interface
*/
- public function getIterator() {
+ public function getIterator()
+ {
switch ($this->mytype) {
case 3:
return new \ArrayIterator($this->me['struct']);
default:
return new \ArrayIterator();
}
- return new \ArrayIterator();
}
-
- public function offsetSet($offset, $value) {
-
+ /**
+ * @internal required to be public to implement an Interface
+ * @param mixed $offset
+ * @param mixed $value
+ * @throws \Exception
+ */
+ public function offsetSet($offset, $value)
+ {
switch ($this->mytype) {
case 3:
if (!($value instanceof \PhpXmlRpc\Value)) {
case 1:
// todo: handle i4 vs int
reset($this->me);
- list($type,) = each($this->me);
+ $type = key($this->me);
if ($type != $offset) {
throw new \Exception('');
}
}
}
- public function offsetExists($offset) {
+ /**
+ * @internal required to be public to implement an Interface
+ * @param mixed $offset
+ * @return bool
+ */
+ public function offsetExists($offset)
+ {
switch ($this->mytype) {
case 3:
return isset($this->me['struct'][$offset]);
}
}
- public function offsetUnset($offset) {
+ /**
+ * @internal required to be public to implement an Interface
+ * @param mixed $offset
+ * @throws \Exception
+ */
+ public function offsetUnset($offset)
+ {
switch ($this->mytype) {
case 3:
unset($this->me['struct'][$offset]);
}
}
- public function offsetGet($offset) {
+ /**
+ * @internal required to be public to implement an Interface
+ * @param mixed $offset
+ * @return mixed|Value|null
+ * @throws \Exception
+ */
+ public function offsetGet($offset)
+ {
switch ($this->mytype) {
case 3:
return isset($this->me['struct'][$offset]) ? $this->me['struct'][$offset] : null;
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);
+ $value = reset($this->me);
+ $type = key($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