xmlrpcval Class Reference

Public Member Functions
	__construct ($val=-1, $type='')
	addScalar ($val, $type='string')
	addArray ($vals)
	addStruct ($vals)
	dump ($ar)
	kindOf ()
	serializedata ($typ, $val, $charset_encoding='')
	serialize ($charset_encoding='')
	serializeval ($o)
	structmemexists ($m)
	structmem ($m)
	structreset ()
	structeach ()
	getval ()
	scalarval ()
	scalartyp ()
	arraymem ($m)
	arraysize ()
	structsize ()

Public Attributes
	$me =array()
	$mytype =0
	$_php_class =null

Detailed Description

Definition at line 2695 of file xmlrpc.inc.

Constructor & Destructor Documentation

__construct()

xmlrpcval::__construct	(		$val = -1,
			$type = ''
	)

Parameters

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

Definition at line 2705 of file xmlrpc.inc.

Member Function Documentation

addArray()

xmlrpcval::addArray

(

$vals

)

Add an array of xmlrpcval objects to an xmlrpcval

Parameters

array

$vals

Returns

int 1 or 0 on failure @access public

Definition at line 2821 of file xmlrpc.inc.

addScalar()

xmlrpcval::addScalar	(		$val,
			$type = 'string'
	)

Add a single php value to an (unitialized) xmlrpcval

Parameters

mixed	$val
string	$type

Returns

int 1 or 0 on failure

Definition at line 2765 of file xmlrpc.inc.

addStruct()

xmlrpcval::addStruct

(

$vals

)

Add an array of named xmlrpcval objects to an xmlrpcval

Parameters

array

$vals

Returns

int 1 or 0 on failure @access public

Definition at line 2850 of file xmlrpc.inc.

arraymem()

xmlrpcval::arraymem

(

$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)

Returns

xmlrpcval @access public

Definition at line 3132 of file xmlrpc.inc.

arraysize()

xmlrpcval::arraysize

(

)

Returns the number of members in an xmlrpcval of array type

Returns

integer @access public

Definition at line 3142 of file xmlrpc.inc.

dump()

xmlrpcval::dump

(

$ar

)

Definition at line 2873 of file xmlrpc.inc.

getval()

xmlrpcval::getval

(

)

Definition at line 3059 of file xmlrpc.inc.

kindOf()

xmlrpcval::kindOf

(

)

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

Returns

string @access public

Definition at line 2893 of file xmlrpc.inc.

scalartyp()

xmlrpcval::scalartyp

(

)

Returns the type of the xmlrpcval. For integers, 'int' is always returned in place of 'i4'

Returns

string @access public

Definition at line 3115 of file xmlrpc.inc.

scalarval()

xmlrpcval::scalarval

(

)

Returns the value of a scalar xmlrpcval

Returns

mixed @access public

Definition at line 3102 of file xmlrpc.inc.

serialize()

xmlrpcval::serialize

(

$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

Returns

string @access public

Definition at line 2990 of file xmlrpc.inc.

serializedata()

xmlrpcval::serializedata	(		$typ,
			$val,
			$charset_encoding = ''
	)

@access private

Definition at line 2914 of file xmlrpc.inc.

serializeval()

xmlrpcval::serializeval

(

$o

)

Definition at line 3002 of file xmlrpc.inc.

structeach()

xmlrpcval::structeach

(

)

Return next member element for xmlrpcvals of type struct.

Returns

xmlrpcval @access public

Definition at line 3052 of file xmlrpc.inc.

structmem()

xmlrpcval::structmem

(

$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

Returns

xmlrpcval @access public

Definition at line 3033 of file xmlrpc.inc.

structmemexists()

xmlrpcval::structmemexists

(

$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

Returns

boolean @access public

Definition at line 3021 of file xmlrpc.inc.

structreset()

xmlrpcval::structreset

(

)

Reset internal pointer for xmlrpcvals of type struct. @access public

Definition at line 3042 of file xmlrpc.inc.

structsize()

xmlrpcval::structsize

(

)

Returns the number of members in an xmlrpcval of struct type

Returns

integer @access public

Definition at line 3152 of file xmlrpc.inc.

Member Data Documentation

$_php_class

xmlrpcval::$_php_class =null

Definition at line 2699 of file xmlrpc.inc.

$me

xmlrpcval::$me =array()

Definition at line 2697 of file xmlrpc.inc.

$mytype

xmlrpcval::$mytype =0

Definition at line 2698 of file xmlrpc.inc.

---

The documentation for this class was generated from the following file:

• xmlrpc/lib/xmlrpc.inc