X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=src%2FValue.php;h=e3db3a177e964ed7af9b14d154969c410026378d;hb=526b0d2257ba1faa0cfcbdb0515d4f395f22ce2c;hp=c9fc61406b39afad04a1f223a7c3e0b58df0ab1a;hpb=f4978078febfc4289bb4f45db6ca3f9e6c8c4f94;p=plcapi.git diff --git a/src/Value.php b/src/Value.php index c9fc614..e3db3a1 100644 --- a/src/Value.php +++ b/src/Value.php @@ -3,13 +3,15 @@ namespace PhpXmlRpc; use PhpXmlRpc\Helper\Charset; +use PhpXmlRpc\Helper\Logger; /** - * This class enables the creation and encapsulation of values for XML-RPC. + * 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"; @@ -23,6 +25,7 @@ class Value implements \Countable, \IteratorAggregate, \ArrayAccess public static $xmlrpcTypes = array( "i4" => 1, + "i8" => 1, "int" => 1, "boolean" => 1, "double" => 1, @@ -35,8 +38,14 @@ class Value implements \Countable, \IteratorAggregate, \ArrayAccess ); /// @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; /** @@ -44,7 +53,7 @@ class Value implements \Countable, \IteratorAggregate, \ArrayAccess * * 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 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. @@ -61,6 +70,7 @@ class Value implements \Countable, \IteratorAggregate, \ArrayAccess $this->me['string'] = $val; break; case 'i4': + case 'i8': case 'int': case 'double': case 'string': @@ -80,7 +90,7 @@ class Value implements \Countable, \IteratorAggregate, \ArrayAccess $this->me['struct'] = $val; break; default: - error_log("XML-RPC: " . __METHOD__ . ": not a known type ($type)"); + Logger::instance()->errorLog("XML-RPC: " . __METHOD__ . ": not a known type ($type)"); } } } @@ -93,7 +103,7 @@ class Value implements \Countable, \IteratorAggregate, \ArrayAccess * Fails if the xmlrpc value is not an array and already initialized. * * @param mixed $val - * @param string $type allowed values: i4, int, boolean, string, double, dateTime.iso8601, base64, null. + * @param string $type allowed values: i4, i8, int, boolean, string, double, dateTime.iso8601, base64, null. * * @return int 1 or 0 on failure */ @@ -105,12 +115,12 @@ class Value implements \Countable, \IteratorAggregate, \ArrayAccess } if ($typeOf !== 1) { - error_log("XML-RPC: " . __METHOD__ . ": not a scalar type ($type)"); + Logger::instance()->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'))) { @@ -122,10 +132,10 @@ class Value implements \Countable, \IteratorAggregate, \ArrayAccess switch ($this->mytype) { case 1: - error_log('XML-RPC: ' . __METHOD__ . ': scalar xmlrpc value can have only one value'); + Logger::instance()->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'); + Logger::instance()->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 @@ -167,7 +177,7 @@ class Value implements \Countable, \IteratorAggregate, \ArrayAccess return 1; } else { - error_log('XML-RPC: ' . __METHOD__ . ': already initialized as a [' . $this->kindOf() . ']'); + Logger::instance()->errorLog('XML-RPC: ' . __METHOD__ . ': already initialized as a [' . $this->kindOf() . ']'); return 0; } } @@ -198,7 +208,7 @@ class Value implements \Countable, \IteratorAggregate, \ArrayAccess return 1; } else { - error_log('XML-RPC: ' . __METHOD__ . ': already initialized as a [' . $this->kindOf() . ']'); + Logger::instance()->errorLog('XML-RPC: ' . __METHOD__ . ': already initialized as a [' . $this->kindOf() . ']'); return 0; } } @@ -213,18 +223,21 @@ class Value implements \Countable, \IteratorAggregate, \ArrayAccess 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 = ''; @@ -243,12 +256,12 @@ class Value implements \Countable, \IteratorAggregate, \ArrayAccess $rs .= "<${typ}>" . ($val ? '1' : '0') . ""; break; case static::$xmlrpcString: - // G. Giunta 2005/2/13: do NOT use htmlentities, since - // it will produce named html entities, which are invalid xml + // 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) . ""; break; case static::$xmlrpcInt: case static::$xmlrpcI4: + case static::$xmlrpcI8: $rs .= "<${typ}>" . (int)$val . ""; break; case static::$xmlrpcDouble: @@ -257,7 +270,7 @@ class Value implements \Countable, \IteratorAggregate, \ArrayAccess // 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, '.', '')) . ""; + $rs .= "<${typ}>" . preg_replace('/\\.?0+$/', '', number_format((double)$val, PhpXmlRpc::$xmlpc_double_precision, '.', '')) . ""; break; case static::$xmlrpcDateTime: if (is_string($val)) { @@ -292,6 +305,7 @@ class Value implements \Countable, \IteratorAggregate, \ArrayAccess $rs .= "\n"; } $charsetEncoder = Charset::instance(); + /** @var Value $val2 */ foreach ($val as $key2 => $val2) { $rs .= '' . $charsetEncoder->encodeEntities($key2, PhpXmlRpc::$xmlrpc_internalencoding, $charsetEncoding) . "\n"; //$rs.=$this->serializeval($val2); @@ -303,6 +317,7 @@ class Value implements \Countable, \IteratorAggregate, \ArrayAccess case 2: // array $rs .= "\n\n"; + /** @var Value $element */ foreach ($val as $element) { //$rs.=$this->serializeval($val[$i]); $rs .= $element->serialize($charsetEncoding); @@ -325,14 +340,10 @@ class Value implements \Countable, \IteratorAggregate, \ArrayAccess */ 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 '' . $this->serializedata($typ, $val, $charsetEncoding) . "\n"; - //} } /** @@ -348,6 +359,8 @@ class Value implements \Countable, \IteratorAggregate, \ArrayAccess */ public function structmemexists($key) { + //trigger_error('Method ' . __METHOD__ . ' is deprecated', E_USER_DEPRECATED); + return array_key_exists($key, $this->me['struct']); } @@ -363,6 +376,8 @@ class Value implements \Countable, \IteratorAggregate, \ArrayAccess */ public function structmem($key) { + //trigger_error('Method ' . __METHOD__ . ' is deprecated', E_USER_DEPRECATED); + return $this->me['struct'][$key]; } @@ -372,6 +387,8 @@ class Value implements \Countable, \IteratorAggregate, \ArrayAccess */ public function structreset() { + //trigger_error('Method ' . __METHOD__ . ' is deprecated', E_USER_DEPRECATED); + reset($this->me['struct']); } @@ -379,12 +396,15 @@ class Value implements \Countable, \IteratorAggregate, \ArrayAccess * 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']); } /** @@ -394,8 +414,7 @@ class Value implements \Countable, \IteratorAggregate, \ArrayAccess */ public function scalarval() { - reset($this->me); - list(, $b) = each($this->me); + $b = reset($this->me); return $b; } @@ -403,14 +422,14 @@ class Value implements \Countable, \IteratorAggregate, \ArrayAccess /** * 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; } @@ -429,6 +448,8 @@ class Value implements \Countable, \IteratorAggregate, \ArrayAccess */ public function arraymem($key) { + //trigger_error('Method ' . __METHOD__ . ' is deprecated', E_USER_DEPRECATED); + return $this->me['array'][$key]; } @@ -441,6 +462,8 @@ class Value implements \Countable, \IteratorAggregate, \ArrayAccess */ public function arraysize() { + //trigger_error('Method ' . __METHOD__ . ' is deprecated', E_USER_DEPRECATED); + return count($this->me['array']); } @@ -453,6 +476,8 @@ class Value implements \Countable, \IteratorAggregate, \ArrayAccess */ public function structsize() { + //trigger_error('Method ' . __METHOD__ . ' is deprecated', E_USER_DEPRECATED); + return count($this->me['struct']); } @@ -481,9 +506,11 @@ class Value implements \Countable, \IteratorAggregate, \ArrayAccess /** * 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']); @@ -494,12 +521,16 @@ class Value implements \Countable, \IteratorAggregate, \ArrayAccess 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)) { @@ -526,7 +557,7 @@ class Value implements \Countable, \IteratorAggregate, \ArrayAccess 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(''); } @@ -538,7 +569,13 @@ class Value implements \Countable, \IteratorAggregate, \ArrayAccess } } - 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]); @@ -552,7 +589,13 @@ class Value implements \Countable, \IteratorAggregate, \ArrayAccess } } - 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]); @@ -568,7 +611,14 @@ class Value implements \Countable, \IteratorAggregate, \ArrayAccess } } - 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; @@ -576,12 +626,12 @@ class Value implements \Countable, \IteratorAggregate, \ArrayAccess 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 +}