Class dom_xmlrpc_builder

Description

A utility for building string representations of XML-RPC documents

Located in /includes/domit/dom_xmlrpc_builder.php (line 24)


	
			
Direct descendents
Class Description
dom_xmlrpc_methodcall A representation of an XML-RPC method call
dom_xmlrpc_methodresponse A representation of an XML-RPC method response
dom_xmlrpc_methodresponse_fault Encapsulates an XML-RPC fault
Variable Summary
string $methodType
string $params
Method Summary
void add (mixed $value, [mixed $type = ''])
void addArray (array $myArray)
void addArrayByRef (array &$myArray)
void addByRef (mixed &$value, [mixed $type = ''])
void addList ()
void addObject (object The $myObject)
void addObjectByRef (object The &$myObject)
void addScalar (mixed $value, [string $type = ''])
void addStruct (mixed $myStruct)
void addStructByRef (mixed &$myStruct)
void create (mixed &$value, [mixed $type = ''])
string createArray (array &$myArray)
object The &createBase64 (mixed $binaryData)
object The &createBase64FromFile (string $fileName)
object The &createDateTimeISO (string $time)
string createMember (mixed $name, mixed &$value, mixed $type)
string createObject (object The &$myObject)
string createScalar (mixed $value, [string $type = ''])
string createStruct (mixed &$myStruct)
void setObjectMarshalling (string $type)
Variables
string $methodType (line 26)
  • var: The method type of the XML-RPC data, e.g., DOM_XMLRPC_TYPE_METHODRESPONSE
string $objectMarshalling = DOM_XMLRPC_OBJECT_MARSHALLING_ANONYMOUS (line 30)
  • var: The type of object marshalling to be used, if this option is enabled
string $params = "" (line 28)
  • var: The XML string representing the method params
Methods
add (line 336)

Generates an XML-RPC param from the unspecified value

void add (mixed $value, [mixed $type = ''])
  • mixed $value: The value to be converted to XML-RPC notation
addArray (line 130)

Generates an XML-RPC param from the array and adds it to the method params

void addArray (array $myArray)
  • array $myArray: The array to be converted to XML-RPC notation
addArrayByRef (line 138)

Generates an XML-RPC param from the array reference and adds it to the method params

void addArrayByRef (array &$myArray)
  • array &$myArray: The array reference to be converted to XML-RPC notation
addByRef (line 344)

Generates an XML-RPC param from the unspecified reference

void addByRef (mixed &$value, [mixed $type = ''])
  • mixed &$value: The reference to be converted to XML-RPC notation
addList (line 351)

Generates an XML-RPC param from list of values

void addList ()
addObject (line 211)

Generates an XML-RPC param from the object and adds it to the method params

void addObject (object The $myObject)
  • object The $myObject: object to be converted to XML-RPC notation
addObjectByRef (line 219)

Generates an XML-RPC param from the object reference and adds it to the method params

void addObjectByRef (object The &$myObject)
  • object The &$myObject: object reference to be converted to XML-RPC notation
addScalar (line 102)

Generates an XML-RPC param from the scalar and adds it to the method params

void addScalar (mixed $value, [string $type = ''])
  • mixed $value: The value to be converted to XML-RPC notation
  • string $type: The type of the value (will be autodetected if omitted)
addStruct (line 270)

Generates an XML-RPC param from the struct and adds it to the method params

void addStruct (mixed $myStruct)
  • mixed $myStruct: The struct to be converted to XML-RPC notation
addStructByRef (line 278)

Generates an XML-RPC param from the struct reference and adds it to the method params

void addStructByRef (mixed &$myStruct)
  • mixed &$myStruct: The struct reference to be converted to XML-RPC notation
create (line 303)

Generates an XML-RPC param from the value and adds it to the method params

void create (mixed &$value, [mixed $type = ''])
  • mixed &$value: The value to be converted to XML-RPC notation
createArray (line 111)

Creates an XML-RPC representation of a PHP array

  • return: An XML-RPC representation of the array
string createArray (array &$myArray)
  • array &$myArray: The array to be converted to XML-RPC notation
createBase64 (line 364)

Creates a dom_xmlrpc_base64 object from the binary data

  • return: base64 encoded data
object The &createBase64 (mixed $binaryData)
  • mixed $binaryData: The binary data
createBase64FromFile (line 377)

Creates a dom_xmlrpc_base64 object from the file

  • return: base64 encoded data
object The &createBase64FromFile (string $fileName)
  • string $fileName: The file path
createDateTimeISO (line 390)

Creates a dom_xmlrpc_datetime_iso8601 object from the PHP time

  • return: dom_xmlrpc_datetime_iso8601 object
object The &createDateTimeISO (string $time)
  • string $time: The time
createMember (line 287)

Creates an XML-RPC representation of a member

  • return: An XML-RPC representation of the member
string createMember (mixed $name, mixed &$value, mixed $type)
  • mixed $name: The member to be converted to XML-RPC notation
createObject (line 147)

Creates an XML-RPC representation of a PHP object

  • return: An XML-RPC representation of the object
string createObject (object The &$myObject)
  • object The &$myObject: object to be converted to XML-RPC notation
createScalar (line 57)

Creates an XML-RPC representation of a scalar value (e.g. string, double, boolean)

  • return: An XML-RPC representation of the value
string createScalar (mixed $value, [string $type = ''])
  • mixed $value: The value to be converted to XML-RPC notation
  • string $type: The type of the value (will be autodetected if omitted)
createStruct (line 228)

Creates an XML-RPC representation of a struct

  • return: An XML-RPC representation of the struct
string createStruct (mixed &$myStruct)
  • mixed &$myStruct: The struct to be converted to XML-RPC notation
setObjectMarshalling (line 36)

Invokes the ability to pass PHP objects in addition to basic native types such as int and string

void setObjectMarshalling (string $type)
  • string $type: The type of object marshalling to be invoked: either anonymous, named, or serialized

Documentation generated on Fri, 4 Mar 2005 13:55:59 +1000 by phpDocumentor 1.3.0RC3