Class: dom_xmlrpc_builder

Source Location: /includes/domit/dom_xmlrpc_builder.php

Class dom_xmlrpc_builder

Class Overview

A utility for building string representations of XML-RPC documents

Located in /includes/domit/dom_xmlrpc_builder.php [line 24]

Author(s):

John Heinstein <johnkarl@nbnet.nb.ca>

Information Tags:

Properties

Methods

[ Top ]

Descendants

Child 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

[ Top ]

Property Summary

string	$methodType
string	$objectMarshalling
string	$params

[ Top ]

Method Summary

void	add()	Generates an XML-RPC param from the unspecified value
void	addArray()	Generates an XML-RPC param from the array and adds it to the method params
void	addArrayByRef()	Generates an XML-RPC param from the array reference and adds it to the method params
void	addByRef()	Generates an XML-RPC param from the unspecified reference
void	addList()	Generates an XML-RPC param from list of values
void	addObject()	Generates an XML-RPC param from the object and adds it to the method params
void	addObjectByRef()	Generates an XML-RPC param from the object reference and adds it to the method params
void	addScalar()	Generates an XML-RPC param from the scalar and adds it to the method params
void	addStruct()	Generates an XML-RPC param from the struct and adds it to the method params
void	addStructByRef()	Generates an XML-RPC param from the struct reference and adds it to the method params
void	create()	Generates an XML-RPC param from the value and adds it to the method params
string	createArray()	Creates an XML-RPC representation of a PHP array
object The	&createBase64()	Creates a dom_xmlrpc_base64 object from the binary data
object The	&createBase64FromFile()	Creates a dom_xmlrpc_base64 object from the file
object The	&createDateTimeISO()	Creates a dom_xmlrpc_datetime_iso8601 object from the PHP time
string	createMember()	Creates an XML-RPC representation of a member
string	createObject()	Creates an XML-RPC representation of a PHP object
string	createScalar()	Creates an XML-RPC representation of a scalar value (e.g. string, double, boolean)
string	createStruct()	Creates an XML-RPC representation of a struct
void	setObjectMarshalling()	Invokes the ability to pass PHP objects in addition to basic native types such as int and string

[ Top ]

Properties

string $methodType [line 26]

[ Top ]

string $objectMarshalling = DOM_XMLRPC_OBJECT_MARSHALLING_ANONYMOUS [line 30]

[ Top ]

string $params = "" [line 28]

[ Top ]

Methods

add [line 336]

void add(
mixed
$value, [
$type = ''] 
)

Generates an XML-RPC param from the unspecified value

Parameters:

mixed	$value:	The value to be converted to XML-RPC notation
	$type:

[ Top ]

addArray [line 130]

void addArray(
array
$myArray 
)

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

Parameters:

array

$myArray:

The array to be converted to XML-RPC notation

[ Top ]

addArrayByRef [line 138]

void addArrayByRef(
array
&$myArray 
)

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

Parameters:

array

&$myArray:

The array reference to be converted to XML-RPC notation

[ Top ]

addByRef [line 344]

void addByRef(
mixed
&$value, [
$type = ''] 
)

Generates an XML-RPC param from the unspecified reference

Parameters:

mixed	&$value:	The reference to be converted to XML-RPC notation
	$type:

[ Top ]

addList [line 351]

void addList(
)

Generates an XML-RPC param from list of values

[ Top ]

addObject [line 211]

void addObject(
object The
$myObject 
)

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

Parameters:

object The

$myObject:

object to be converted to XML-RPC notation

[ Top ]

addObjectByRef [line 219]

void addObjectByRef(
object The
&$myObject 
)

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

Parameters:

object The

&$myObject:

object reference to be converted to XML-RPC notation

[ Top ]

addScalar [line 102]

void addScalar(
mixed
$value, [string
$type = ''] 
)

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

Parameters:

mixed	$value:	The value to be converted to XML-RPC notation
string	$type:	The type of the value (will be autodetected if omitted)

[ Top ]

addStruct [line 270]

void addStruct(
mixed
$myStruct 
)

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

Parameters:

mixed

$myStruct:

The struct to be converted to XML-RPC notation

[ Top ]

addStructByRef [line 278]

void addStructByRef(
mixed
&$myStruct 
)

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

Parameters:

mixed

&$myStruct:

The struct reference to be converted to XML-RPC notation

[ Top ]

create [line 303]

void create(
mixed
&$value, [
$type = ''] 
)

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

Parameters:

mixed	&$value:	The value to be converted to XML-RPC notation
	$type:

[ Top ]

createArray [line 111]

string createArray(
array
&$myArray 
)

Creates an XML-RPC representation of a PHP array

Parameters:

array

&$myArray:

The array to be converted to XML-RPC notation

API Tags:

Return:

An XML-RPC representation of the array

[ Top ]

createBase64 [line 364]

object The &createBase64(
mixed
$binaryData 
)

Creates a dom_xmlrpc_base64 object from the binary data

Parameters:

mixed

$binaryData:

The binary data

API Tags:

Return:

base64 encoded data

[ Top ]

createBase64FromFile [line 377]

object The &createBase64FromFile(
string
$fileName 
)

Creates a dom_xmlrpc_base64 object from the file

Parameters:

string

$fileName:

The file path

API Tags:

Return:

base64 encoded data

[ Top ]

createDateTimeISO [line 390]

object The &createDateTimeISO(
string
$time 
)

Creates a dom_xmlrpc_datetime_iso8601 object from the PHP time

Parameters:

string

$time:

The time

API Tags:

Return:

dom_xmlrpc_datetime_iso8601 object

[ Top ]

createMember [line 287]

string createMember(
mixed
$name, 
&$value, 
$type 
)

Creates an XML-RPC representation of a member

Parameters:

mixed	$name:	The member to be converted to XML-RPC notation
	&$value:
	$type:

API Tags:

Return:

An XML-RPC representation of the member

[ Top ]

createObject [line 147]

string createObject(
object The
&$myObject 
)

Creates an XML-RPC representation of a PHP object

Parameters:

object The

&$myObject:

object to be converted to XML-RPC notation

API Tags:

Return:

An XML-RPC representation of the object

[ Top ]

createScalar [line 57]

string createScalar(
mixed
$value, [string
$type = ''] 
)

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

Parameters:

mixed	$value:	The value to be converted to XML-RPC notation
string	$type:	The type of the value (will be autodetected if omitted)

API Tags:

Return:

An XML-RPC representation of the value

[ Top ]

createStruct [line 228]

string createStruct(
mixed
&$myStruct 
)

Creates an XML-RPC representation of a struct

Parameters:

mixed

&$myStruct:

The struct to be converted to XML-RPC notation

API Tags:

Return:

An XML-RPC representation of the struct

[ Top ]

setObjectMarshalling [line 36]

void setObjectMarshalling(
string
$type 
)

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

Parameters:

string

$type:

The type of object marshalling to be invoked: either anonymous, named, or serialized

[ Top ]

The site fititnt.org is not affiliated with or endorsed by the Joomla! Project or Open Source Matters. If you are looking for official documentation, visit api.joomla.org and docs.joomla.org.

Documentation generated on Mon, 26 Oct 2009 22:52:45 -0200 by phpDocumentor 1.4.3

Visit fititnt.org, and look for some extension or more Joomla Framework info	dom-xmlrpc

[ class tree: dom-xmlrpc ] [ index: dom-xmlrpc ] [ all elements ]