Class: dom_xmlrpc_array_document

Source Location: /includes/domit/dom_xmlrpc_array_document.php

Class dom_xmlrpc_array_document

Class Overview

An array of XML-RPC data wrapped in the DOM XML-RPC API

Located in /includes/domit/dom_xmlrpc_array_document.php [line 25]

Author(s):

John Heinstein <johnkarl@nbnet.nb.ca>

Information Tags:

Properties

Methods

[ Top ]

Property Summary

int	$faultCode
string	$faultString
string	$methodName
string	$methodType
string	$params

[ Top ]

Method Summary

dom_xmlrpc_array_document	dom_xmlrpc_array_document()	dom_xmlrpc_array_document constructor
int	getFaultCode()	Returns the current fault code
string	getFaultString()	Returns the current fault string
string	getMethodName()	Returns the method name
string	getMethodType()	Returns the method type
mixed	&getParam()	Returns a reference to the specified param
int	getParamCount()	Returns the number of params in the params array
array	&getParams()	Returns a reference to the params array
string	getParamType()	Returns the type of the specified param
boolean	isFault()	Determines whether the method response is a fault
string	toNormalizedString()	Returns a formatted string representation of the parameters array
string	toString()	Returns a string representation of the parameters array

[ Top ]

Properties

int $faultCode = null [line 33]

[ Top ]

string $faultString = null [line 35]

[ Top ]

string $methodName = "" [line 29]

[ Top ]

string $methodType [line 27]

[ Top ]

string $params = array() [line 31]

[ Top ]

Methods

Constructor dom_xmlrpc_array_document [line 40]

dom_xmlrpc_array_document dom_xmlrpc_array_document(
)

dom_xmlrpc_array_document constructor

[ Top ]

getFaultCode [line 98]

int getFaultCode(
)

Returns the current fault code

API Tags:

Return:

The current fault code

[ Top ]

getFaultString [line 106]

string getFaultString(
)

Returns the current fault string

API Tags:

Return:

The current fault string

[ Top ]

getMethodName [line 56]

string getMethodName(
)

Returns the method name

API Tags:

Return:

The method name

[ Top ]

getMethodType [line 48]

string getMethodType(
)

Returns the method type

API Tags:

Return:

The method type

[ Top ]

getParam [line 74]

mixed &getParam(
int
$index 
)

Returns a reference to the specified param

Parameters:

int

$index:

The param index in the params array

API Tags:

Return:

A reference to the param

[ Top ]

getParamCount [line 82]

int getParamCount(
)

Returns the number of params in the params array

API Tags:

Return:

The number of params in the params array

[ Top ]

getParams [line 65]

array &getParams(
)

Returns a reference to the params array

API Tags:

Return:

A reference to the params array

[ Top ]

getParamType [line 115]

string getParamType(
mixed
$param 
)

Returns the type of the specified param

Parameters:

mixed

$param:

The param to be tested

API Tags:

Return:

The type of the specified param

[ Top ]

isFault [line 90]

boolean isFault(
)

Determines whether the method response is a fault

API Tags:

Return:

True if the method response is a fault

[ Top ]

toNormalizedString [line 138]

string toNormalizedString(
)

Returns a formatted string representation of the parameters array

API Tags:

Return:

A formatted string representation of the parameters array

[ Top ]

toString [line 124]

string toString(
)

Returns a string representation of the parameters array

API Tags:

Return:

A string representation of the parameters array

[ 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:43 -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 ]