phpDocumentor pond
[ class tree: pond ] [ index: pond ] [ all elements ]

Class: xmlrpcval

Source Location: /qp_inc/_ext/xmlrpc/_xmlrpc.inc.php

Class xmlrpcval

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 members in an xmlrpcval of array type
void   dump()   dummy docblock makes error-free autodocs
void   getval()   dummy docblock makes error-free autodocs
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   serializeval()   dummy docblock makes error-free autodocs
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 members in an xmlrpcval of struct type

[ Top ]
Properties
mixed   $me = array() [line 2710]

[ Top ]
mixed   $mytype [line 2711]

[ Top ]
mixed   $_php_class = null [line 2712]

[ Top ]
Methods
Constructor xmlrpcval  [line 2718]

  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 2834]

  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 2778]

  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 2863]

  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 3154]

  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 3164]

  integer arraysize( )

Returns the number of members in an xmlrpcval of array type


API Tags:
Access:  public


[ Top ]
dump  [line 2889]

  void dump( $ar  )

dummy docblock makes error-free autodocs

Parameters:
   $ar: 


[ Top ]
getval  [line 3081]

  void getval( )

dummy docblock makes error-free autodocs



[ Top ]
kindOf  [line 2909]

  string kindOf( )

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


API Tags:
Access:  public


[ Top ]
scalartyp  [line 3137]

  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 3124]

  mixed scalarval( )

Returns the value of a scalar xmlrpcval


API Tags:
Access:  public


[ Top ]
serialize  [line 3006]

  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 ]
serializeval  [line 3021]

  void serializeval( $o  )

dummy docblock makes error-free autodocs

Parameters:
   $o: 


[ Top ]
structeach  [line 3071]

  xmlrpcval structeach( )

Return next member element for xmlrpcvals of type struct.


API Tags:
Access:  public


[ Top ]
structmem  [line 3052]

  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 3040]

  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 3061]

  void structreset( )

Reset internal pointer for xmlrpcvals of type struct.


API Tags:
Access:  public


[ Top ]
structsize  [line 3174]

  integer structsize( )

Returns the number of members in an xmlrpcval of struct type


API Tags:
Access:  public


[ Top ]