Class: xmlrpcval

Source Location: /libraries/phpxmlrpc/xmlrpc.php

Class xmlrpcval

Class Overview

Located in /libraries/phpxmlrpc/xmlrpc.php [line 2639]

Property Summary

mixed	$me
mixed	$mytype
mixed	$_php_class

[ Top ]

Method Summary

xmlrpcval	xmlrpcval()
int	addArray()	Add an array of xmlrpcval objects to an xmlrpcval
int	addScalar()	Add a single php value to an (unitialized) xmlrpcval
int	addStruct()	Add an array of named xmlrpcval objects to an xmlrpcval
xmlrpcval	arraymem()	Returns the m-th member of an xmlrpcval of struct type
integer	arraysize()	Returns the number of users in an xmlrpcval of array type
void	dump()
void	getval()
string	kindOf()	Returns a string containing "struct", "array" or "scalar" describing the base type of the value
string	scalartyp()	Returns the type of the xmlrpcval.
mixed	scalarval()	Returns the value of a scalar xmlrpcval
string	serialize()	Returns xml representation of the value. XML prologue not included
void	serializedata()
void	serializeval()
xmlrpcval	structeach()	Return next member element for xmlrpcvals of type struct.
xmlrpcval	structmem()	Returns the value of a given struct member (an xmlrpcval object in itself).
boolean	structmemexists()	Checks wheter a struct member with a given name is present.
void	structreset()	Reset internal pointer for xmlrpcvals of type struct.
integer	structsize()	Returns the number of users in an xmlrpcval of struct type

[ Top ]

Properties

mixed $me = array() [line 2641]

[ Top ]

mixed $mytype [line 2642]

[ Top ]

mixed $_php_class = null [line 2643]

[ Top ]

Methods

Constructor xmlrpcval [line 2649]

xmlrpcval xmlrpcval(
[mixed
$val = -1], [string
$type = ''] 
)

Parameters:

mixed	$val:
string	$type:	any valid xmlrpc type name (lowercase). If null, 'string' is assumed

[ Top ]

addArray [line 2765]

int addArray(
array
$vals 
)

Add an array of xmlrpcval objects to an xmlrpcval

Parameters:

array

$vals:

API Tags:

Return:	1 or 0 on failure
Access:	public

Information Tags:

Todo:

add some checking for $vals to be an array of xmlrpcvals?

[ Top ]

addScalar [line 2709]

int addScalar(
mixed
$val, [string
$type = 'string'] 
)

Add a single php value to an (unitialized) xmlrpcval

Parameters:

mixed	$val:
string	$type:

API Tags:

Return:

1 or 0 on failure

[ Top ]

addStruct [line 2794]

int addStruct(
array
$vals 
)

Add an array of named xmlrpcval objects to an xmlrpcval

Parameters:

array

$vals:

API Tags:

Return:	1 or 0 on failure
Access:	public

Information Tags:

Todo:

add some checking for $vals to be an array?

[ Top ]

arraymem [line 3076]

xmlrpcval arraymem(
integer
$m 
)

Returns the m-th member of an xmlrpcval of struct type

Parameters:

integer

$m:

the index of the value to be retrieved (zero based)

API Tags:

Access:

public

[ Top ]

arraysize [line 3086]

integer arraysize(
)

Returns the number of users in an xmlrpcval of array type

API Tags:

Access:

public

[ Top ]

dump [line 2817]

void dump(

$ar 
)

Parameters:

$ar:

[ Top ]

getval [line 3003]

void getval(
)

[ Top ]

kindOf [line 2837]

string kindOf(
)

Returns a string containing "struct", "array" or "scalar" describing the base type of the value

API Tags:

Access:

public

[ Top ]

scalartyp [line 3059]

string scalartyp(
)

Returns the type of the xmlrpcval.

For integers, 'int' is always returned in place of 'i4'

API Tags:

Access:

public

[ Top ]

scalarval [line 3046]

mixed scalarval(
)

Returns the value of a scalar xmlrpcval

API Tags:

Access:

public

[ Top ]

serialize [line 2934]

string serialize(
[string
$charset_encoding = ''] 
)

Returns xml representation of the value. XML prologue not included

Parameters:

string

$charset_encoding:

the charset to be used for serialization. if null, US-ASCII is assumed

API Tags:

Access:

public

[ Top ]

serializedata [line 2858]

void serializedata(

$typ, 
$val, [
$charset_encoding = ''] 
)

Parameters:

	$typ:
	$val:
	$charset_encoding:

API Tags:

Access:

private

[ Top ]

serializeval [line 2946]

void serializeval(

$o 
)

Parameters:

$o:

[ Top ]

structeach [line 2996]

xmlrpcval structeach(
)

Return next member element for xmlrpcvals of type struct.

API Tags:

Access:

public

[ Top ]

structmem [line 2977]

xmlrpcval structmem(
string
$m 
)

Returns the value of a given struct member (an xmlrpcval object in itself).

Will raise a php warning if struct member of given name does not exist

Parameters:

string

$m:

the name of the struct member to be looked up

API Tags:

Access:

public

[ Top ]

structmemexists [line 2965]

boolean structmemexists(
string
$m 
)

Checks wheter a struct member with a given name is present.

Works only on xmlrpcvals of type struct.

Parameters:

string

$m:

the name of the struct member to be looked up

API Tags:

Access:

public

[ Top ]

structreset [line 2986]

void structreset(
)

Reset internal pointer for xmlrpcvals of type struct.

API Tags:

Access:

public

[ Top ]

structsize [line 3096]

integer structsize(
)

Returns the number of users in an xmlrpcval of struct type

API Tags:

Access:

public

[ 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 23:27:05 -0200 by phpDocumentor 1.4.3

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

[ class tree: Joomla-Framework ] [ index: Joomla-Framework ] [ all elements ]