xmlrpcval Class Reference

List of all members.

Public Member Functions

 xmlrpcval ($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 2642 of file xmlrpc.inc.php.


Member Function Documentation

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

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

Todo:
: optimization creep - do not call addXX, do it all inline. downside: booleans will not be coerced anymore

Definition at line 2652 of file xmlrpc.inc.php.

Referenced by 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 2712 of file xmlrpc.inc.php.

References $GLOBALS, and xmlrpcval().

xmlrpcval::addArray ( vals  ) 

Add an array of xmlrpcval objects to an xmlrpcval

Parameters:
array $vals
Returns:
int 1 or 0 on failure public
Todo:
add some checking for $vals to be an array of xmlrpcvals?

Definition at line 2768 of file xmlrpc.inc.php.

References $GLOBALS, and kindOf().

xmlrpcval::addStruct ( vals  ) 

Add an array of named xmlrpcval objects to an xmlrpcval

Parameters:
array $vals
Returns:
int 1 or 0 on failure public
Todo:
add some checking for $vals to be an array?

Definition at line 2797 of file xmlrpc.inc.php.

References $GLOBALS, and kindOf().

xmlrpcval::dump ( ar  ) 

Definition at line 2820 of file xmlrpc.inc.php.

xmlrpcval::kindOf (  ) 

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

Returns:
string public

Definition at line 2840 of file xmlrpc.inc.php.

Referenced by addArray(), and addStruct().

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

private

Definition at line 2861 of file xmlrpc.inc.php.

References $GLOBALS, and xmlrpc_encode_entitites().

Referenced by serialize(), and serializeval().

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 public

Definition at line 2937 of file xmlrpc.inc.php.

References serializedata().

xmlrpcval::serializeval ( o  ) 

Definition at line 2949 of file xmlrpc.inc.php.

References serializedata().

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 public

Definition at line 2968 of file xmlrpc.inc.php.

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 public

Definition at line 2980 of file xmlrpc.inc.php.

xmlrpcval::structreset (  ) 

Reset internal pointer for xmlrpcvals of type struct. public

Definition at line 2989 of file xmlrpc.inc.php.

xmlrpcval::structeach (  ) 

Return next member element for xmlrpcvals of type struct.

Returns:
xmlrpcval public

Definition at line 2999 of file xmlrpc.inc.php.

xmlrpcval::getval (  ) 

Definition at line 3006 of file xmlrpc.inc.php.

References $a.

xmlrpcval::scalarval (  ) 

Returns the value of a scalar xmlrpcval

Returns:
mixed public

Definition at line 3049 of file xmlrpc.inc.php.

xmlrpcval::scalartyp (  ) 

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

Returns:
string public

Definition at line 3062 of file xmlrpc.inc.php.

References $a, and $GLOBALS.

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 public

Definition at line 3079 of file xmlrpc.inc.php.

xmlrpcval::arraysize (  ) 

Returns the number of members in an xmlrpcval of array type

Returns:
integer public

Definition at line 3089 of file xmlrpc.inc.php.

xmlrpcval::structsize (  ) 

Returns the number of members in an xmlrpcval of struct type

Returns:
integer public

Definition at line 3099 of file xmlrpc.inc.php.


Member Data Documentation

xmlrpcval::$me = array()

Definition at line 2644 of file xmlrpc.inc.php.

xmlrpcval::$mytype = 0

Definition at line 2645 of file xmlrpc.inc.php.

xmlrpcval::$_php_class = null

Definition at line 2646 of file xmlrpc.inc.php.


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



Generated on Wed Jun 25 17:26:03 2008 by  doxygen 1.5.5