Docs For Class Zend_XmlRpc

Description

Represent a native XML-RPC value entity, used as parameters for the methods called by the Zend_XmlRpc_Client object and as the return value for those calls.

This object as a very important static function Zend_XmlRpc_Value::getXmlRpcValue, this function acts likes a factory for the Zend_XmlRpc_Value objects

Using this function, users/Zend_XmlRpc_Client object can create the Zend_XmlRpc_Value objects from PHP variables, XML string or by specifing the exact XML-RPC natvie type

copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
abstract:
license: New BSD License

Located in /XmlRpc/Value.php (line 37)

Direct descendents

Class	Description
Zend_XmlRpc_Value_Scalar
Zend_XmlRpc_Value_Collection

Class Constant Summary

AUTO_DETECT_TYPE = 'auto_detect'

XMLRPC_TYPE_APACHEI8 = 'ex:i8'

XMLRPC_TYPE_APACHENIL = 'ex:nil'

XMLRPC_TYPE_ARRAY = 'array'

XMLRPC_TYPE_BASE64 = 'base64'

XMLRPC_TYPE_BOOLEAN = 'boolean'

XMLRPC_TYPE_DATETIME = 'dateTime.iso8601'

XMLRPC_TYPE_DOUBLE = 'double'

XMLRPC_TYPE_I4 = 'i4'

XMLRPC_TYPE_I8 = 'i8'

XMLRPC_TYPE_INTEGER = 'int'

XMLRPC_TYPE_NIL = 'nil'

XMLRPC_TYPE_STRING = 'string'

XMLRPC_TYPE_STRUCT = 'struct'

XML_STRING = 'xml'

Variable Summary

static Zend_XmlRpc_Generator_GeneratorAbstract $_generator

mixed $_type

mixed $_value

mixed $_xml

Method Summary

static Zend_XmlRpc_Generator_GeneratorAbstract getGenerator ()

static Zend_XmlRpc_Value getXmlRpcValue (mixed $value, [Zend_XmlRpc_Value::constant $type = self::AUTO_DETECT_TYPE])

static void setEncoding (string $encoding)

static void setGenerator (Zend_XmlRpc_Generator_GeneratorAbstract $generator)

static void _createSimpleXMLElement ( &$xml)

static void _extractTypeAndValue ( $xml, string &$type, string &$value)

static Zend_XmlRpc_Value _phpVarToNativeXmlRpc (mixed $value)

static Zend_XmlRpc_Value _xmlStringToNativeXmlRpc (string|SimpleXMLElement $xml)

void generateXml ()

string getType ()

mixed getValue ()

string saveXml ()

void _setXML ($xml $xml)

Variables

static Zend_XmlRpc_Generator_GeneratorAbstract $_generator (line 61)

access: protected

mixed $_type (line 51)

The native XML-RPC type of this object

One of the XMLRPC_TYPE_* constants

access: protected

mixed $_value (line 45)

The native XML-RPC representation of this object's value

If the native type of this object is array or struct, this will be an array of Zend_XmlRpc_Value objects

access: protected

mixed $_xml (line 56)

XML code representation of this object (will be calculated only once)

access: protected

Methods

static getGenerator (line 105)

Get XML generator instance

access: public

static Zend_XmlRpc_Generator_GeneratorAbstract getGenerator ()

static getXmlRpcValue (line 192)

Creates a Zend_XmlRpc_Value* object, representing a native XML-RPC value

A XmlRpcValue object can be created in 3 ways:

Autodetecting the native type out of a PHP variable (if $type is not set or equal to Zend_XmlRpc_Value::AUTO_DETECT_TYPE)
By specifing the native type ($type is one of the Zend_XmlRpc_Value::XMLRPC_TYPE_* constants)
From a XML string ($type is set to Zend_XmlRpc_Value::XML_STRING)

By default the value type is autodetected according to it's PHP type

access: public

static Zend_XmlRpc_Value getXmlRpcValue (mixed $value, [Zend_XmlRpc_Value::constant $type = self::AUTO_DETECT_TYPE])

mixed $value
Zend_XmlRpc_Value::constant $type

static setEncoding (line 137)

Changes the encoding of the generator

access: public

static void setEncoding (string $encoding)

string $encoding

static setGenerator (line 126)

Sets XML generator instance

access: public

static void setGenerator (Zend_XmlRpc_Generator_GeneratorAbstract $generator)

Zend_XmlRpc_Generator_GeneratorAbstract $generator

static _createSimpleXMLElement (line 431)

access: protected

static void _createSimpleXMLElement ( &$xml)

&$xml

static _extractTypeAndValue (line 454)

Extract XML/RPC type and value from SimpleXMLElement object

access: protected

static void _extractTypeAndValue ( $xml, string &$type, string &$value)

SimpleXMLElement $xml
string &$type: Type bind variable
string &$value: Value bind variable

static _phpVarToNativeXmlRpc (line 264)

Transform a PHP native variable into a XML-RPC native value

access: protected

static Zend_XmlRpc_Value _phpVarToNativeXmlRpc (mixed $value)

mixed $value: The PHP variable for convertion

static _xmlStringToNativeXmlRpc (line 334)

Transform an XML string into a XML-RPC native value

access: protected

static Zend_XmlRpc_Value _xmlStringToNativeXmlRpc (string|SimpleXMLElement $xml)

string|SimpleXMLElement $xml: A SimpleXMLElement object represent the XML string It can be also a valid XML string for convertion

generateXml (line 171)

Generate XML code that represent a native XML/RPC value

access: public

void generateXml ()

getType (line 95)

Get the native XML-RPC type (the type is one of the Zend_XmlRpc_Value::XMLRPC_TYPE_* constants)

access: public

string getType ()

getValue (line 149)

Return the value of this object, convert the XML-RPC native value into a PHP variable

abstract:
access: public

mixed getValue ()

Redefined in descendants as:

Zend_XmlRpc_Value_Base64::getValue() : Return the value of this object, convert the XML-RPC native base64 value into a PHP string We return this value decoded (a normal string)
Zend_XmlRpc_Value_Double::getValue() : Return the value of this object, convert the XML-RPC native double value into a PHP float
Zend_XmlRpc_Value_Boolean::getValue() : Return the value of this object, convert the XML-RPC native boolean value into a PHP boolean
Zend_XmlRpc_Value_DateTime::getValue() : Return the value of this object as iso8601 dateTime value
Zend_XmlRpc_Value_Nil::getValue() : Return the value of this object, convert the XML-RPC native nill value into a PHP NULL
Zend_XmlRpc_Value_String::getValue() : Return the value of this object, convert the XML-RPC native string value into a PHP string
Zend_XmlRpc_Value_Integer::getValue() : Return the value of this object, convert the XML-RPC native integer value into a PHP integer
Zend_XmlRpc_Value_BigInteger::getValue() : Return bigint value object
Zend_XmlRpc_Value_Collection::getValue() : Return the value of this object, convert the XML-RPC native collection values into a PHP array

saveXml (line 157)

Return the XML code that represent a native MXL-RPC value

access: public

string saveXml ()

_setXML (line 480)

access: protected

void _setXML ($xml $xml)

$xml $xml

Class Constants

AUTO_DETECT_TYPE = 'auto_detect' (line 66)

Specify that the XML-RPC native type will be auto detected from a PHP variable type

XMLRPC_TYPE_APACHEI8 = 'ex:i8' (line 79)

XMLRPC_TYPE_APACHENIL = 'ex:nil' (line 88)

XMLRPC_TYPE_ARRAY = 'array' (line 85)

XMLRPC_TYPE_BASE64 = 'base64' (line 84)

XMLRPC_TYPE_BOOLEAN = 'boolean' (line 81)

XMLRPC_TYPE_DATETIME = 'dateTime.iso8601' (line 83)

XMLRPC_TYPE_DOUBLE = 'double' (line 80)

XMLRPC_TYPE_I4 = 'i4' (line 76)

All the XML-RPC native types

XMLRPC_TYPE_I8 = 'i8' (line 78)

XMLRPC_TYPE_INTEGER = 'int' (line 77)

XMLRPC_TYPE_NIL = 'nil' (line 87)

XMLRPC_TYPE_STRING = 'string' (line 82)

XMLRPC_TYPE_STRUCT = 'struct' (line 86)

XML_STRING = 'xml' (line 71)

Specify that the XML-RPC value will be parsed out from a given XML code