Moodle  2.2.1
http://www.collinsharper.com
Zend_XmlRpc_Value Class Reference
Inheritance diagram for Zend_XmlRpc_Value:

Public Member Functions

 getType ()
 getValue ()
 saveXml ()
 generateXml ()

Static Public Member Functions

static getGenerator ()
static setGenerator (Zend_XmlRpc_Generator_GeneratorAbstract $generator)
static setEncoding ($encoding)
static getXmlRpcValue ($value, $type=self::AUTO_DETECT_TYPE)

Data Fields

const AUTO_DETECT_TYPE = 'auto_detect'
const XML_STRING = 'xml'
const XMLRPC_TYPE_I4 = 'i4'
const XMLRPC_TYPE_INTEGER = 'int'
const XMLRPC_TYPE_I8 = 'i8'
const XMLRPC_TYPE_APACHEI8 = 'ex:i8'
const XMLRPC_TYPE_DOUBLE = 'double'
const XMLRPC_TYPE_BOOLEAN = 'boolean'
const XMLRPC_TYPE_STRING = 'string'
const XMLRPC_TYPE_DATETIME = 'dateTime.iso8601'
const XMLRPC_TYPE_BASE64 = 'base64'
const XMLRPC_TYPE_ARRAY = 'array'
const XMLRPC_TYPE_STRUCT = 'struct'
const XMLRPC_TYPE_NIL = 'nil'
const XMLRPC_TYPE_APACHENIL = 'ex:nil'

Protected Member Functions

 _setXML ($xml)

Static Protected Member Functions

static _phpVarToNativeXmlRpc ($value)
static _xmlStringToNativeXmlRpc ($xml)
static _createSimpleXMLElement (&$xml)
static _extractTypeAndValue (SimpleXMLElement $xml, &$type, &$value)

Protected Attributes

 $_value
 $_type
 $_xml

Static Protected Attributes

static $_generator

Detailed Description

Definition at line 37 of file Value.php.


Member Function Documentation

static _createSimpleXMLElement ( &$  xml) [static, protected]

Definition at line 431 of file Value.php.

Here is the caller graph for this function:

static _extractTypeAndValue ( SimpleXMLElement $  xml,
&$  type,
&$  value 
) [static, protected]

Extract XML/RPC type and value from SimpleXMLElement object

Parameters:
SimpleXMLElement$xml
string&$typeType bind variable
string&$valueValue bind variable
Returns:
void

Definition at line 454 of file Value.php.

Here is the caller graph for this function:

static _phpVarToNativeXmlRpc ( value) [static, protected]

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

Parameters:
mixed$valueThe PHP variable for convertion
Returns:
Zend_XmlRpc_Value

Definition at line 264 of file Value.php.

Here is the caller graph for this function:

_setXML ( xml) [protected]
Parameters:
$xml
Returns:
void

Definition at line 480 of file Value.php.

Here is the call graph for this function:

static _xmlStringToNativeXmlRpc ( xml) [static, protected]

Transform an XML string into a XML-RPC native value

Parameters:
string | SimpleXMLElement$xmlA SimpleXMLElement object represent the XML string It can be also a valid XML string for convertion
Returns:
Zend_XmlRpc_Value

Definition at line 334 of file Value.php.

Here is the call graph for this function:

Here is the caller graph for this function:

Generate XML code that represent a native XML/RPC value

Returns:
void

Definition at line 171 of file Value.php.

Here is the caller graph for this function:

static getGenerator ( ) [static]

Get XML generator instance

Returns:
Zend_XmlRpc_Generator_GeneratorAbstract

Definition at line 105 of file Value.php.

Here is the caller graph for this function:

getType ( )

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

Returns:
string

Definition at line 95 of file Value.php.

static getXmlRpcValue ( value,
type = self::AUTO_DETECT_TYPE 
) [static]

Creates a Zend_XmlRpc_Value* object, representing a native XML-RPC value A XmlRpcValue object can be created in 3 ways: 1. Autodetecting the native type out of a PHP variable (if $type is not set or equal to Zend_XmlRpc_Value::AUTO_DETECT_TYPE) 2. By specifing the native type ($type is one of the Zend_XmlRpc_Value::XMLRPC_TYPE_* constants) 3. 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

Parameters:
mixed$value
Zend_XmlRpc_Value::constant$type
Returns:
Zend_XmlRpc_Value

Definition at line 192 of file Value.php.

Here is the call graph for this function:

Here is the caller graph for this function:

saveXml ( )

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

Returns:
string

Definition at line 157 of file Value.php.

Here is the call graph for this function:

static setEncoding ( encoding) [static]

Changes the encoding of the generator

Parameters:
string$encoding
Returns:
void

Definition at line 137 of file Value.php.

Here is the call graph for this function:

static setGenerator ( Zend_XmlRpc_Generator_GeneratorAbstract generator) [static]

Sets XML generator instance

Parameters:
Zend_XmlRpc_Generator_GeneratorAbstract$generator
Returns:
void

Definition at line 126 of file Value.php.

Here is the caller graph for this function:


Field Documentation

$_generator [static, protected]

Definition at line 61 of file Value.php.

$_type [protected]

The native XML-RPC type of this object One of the XMLRPC_TYPE_* constants

Definition at line 51 of file Value.php.

$_value [protected]

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

Definition at line 45 of file Value.php.

$_xml [protected]

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

Definition at line 56 of file Value.php.

const AUTO_DETECT_TYPE = 'auto_detect'

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

Definition at line 66 of file Value.php.

const XML_STRING = 'xml'

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

Definition at line 71 of file Value.php.

const XMLRPC_TYPE_APACHEI8 = 'ex:i8'

Definition at line 79 of file Value.php.

const XMLRPC_TYPE_APACHENIL = 'ex:nil'

Definition at line 88 of file Value.php.

Definition at line 85 of file Value.php.

const XMLRPC_TYPE_BASE64 = 'base64'

Definition at line 84 of file Value.php.

const XMLRPC_TYPE_BOOLEAN = 'boolean'

Definition at line 81 of file Value.php.

const XMLRPC_TYPE_DATETIME = 'dateTime.iso8601'

Definition at line 83 of file Value.php.

const XMLRPC_TYPE_DOUBLE = 'double'

Definition at line 80 of file Value.php.

const XMLRPC_TYPE_I4 = 'i4'

All the XML-RPC native types

Definition at line 76 of file Value.php.

const XMLRPC_TYPE_I8 = 'i8'

Definition at line 78 of file Value.php.

const XMLRPC_TYPE_INTEGER = 'int'

Definition at line 77 of file Value.php.

const XMLRPC_TYPE_NIL = 'nil'

Definition at line 87 of file Value.php.

const XMLRPC_TYPE_STRING = 'string'

Definition at line 82 of file Value.php.

const XMLRPC_TYPE_STRUCT = 'struct'

Definition at line 86 of file Value.php.


The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Enumerations