Support Joomla!

Packages

Package: Unknown

License

Content on this site is copyright © 2005 - 2008 Open Source Matters Inc and can be used in accordance with the Joomla! Electronic Documentation License. Some parts of this website may be subject to other licenses.

 Class xmlrpcval

Description

Located in /phpxmlrpc/xmlrpc.php (line 2639)

Class xmlrpcval
Variable Summary
Variable mixed $me
Variable mixed $mytype
Variable mixed $_php_class
Method Summary
Constructor xmlrpcval xmlrpcval ([mixed $val = -1], [string $type = ''])
Method int addArray (array $vals)
Method int addScalar (mixed $val, [string $type = 'string'])
Method int addStruct (array $vals)
Method xmlrpcval arraymem (integer $m)
Method integer arraysize ()
Method void dump ( $ar)
Method void getval ()
Method string kindOf ()
Method string scalartyp ()
Method mixed scalarval ()
Method string serialize ([string $charset_encoding = ''])
Method void serializeval ( $o)
Method xmlrpcval structmem (string $m)
Method boolean structmemexists (string $m)
Method void structreset ()
Method integer structsize ()
Variables
mixed $me = array() (line 2641)
mixed $mytype (line 2642)
mixed $_php_class = null (line 2643)
Methods
Constructor xmlrpcval (line 2649)
xmlrpcval xmlrpcval ([mixed $val = -1], [string $type = ''])
  • mixed $val
  • string $type: any valid xmlrpc type name (lowercase). If null, 'string' is assumed
addArray (line 2765)

Add an array of xmlrpcval objects to an xmlrpcval

  • return: 1 or 0 on failure
  • todo: add some checking for $vals to be an array of xmlrpcvals?
  • access: public
int addArray (array $vals)
  • array $vals
addScalar (line 2709)

Add a single php value to an (unitialized) xmlrpcval

  • return: 1 or 0 on failure
int addScalar (mixed $val, [string $type = 'string'])
  • mixed $val
  • string $type
addStruct (line 2794)

Add an array of named xmlrpcval objects to an xmlrpcval

  • return: 1 or 0 on failure
  • todo: add some checking for $vals to be an array?
  • access: public
int addStruct (array $vals)
  • array $vals
arraymem (line 3076)

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

  • access: public
xmlrpcval arraymem (integer $m)
  • integer $m: the index of the value to be retrieved (zero based)
arraysize (line 3086)

Returns the number of members in an xmlrpcval of array type

  • access: public
integer arraysize ()
dump (line 2817)
void dump ( $ar)
  • $ar
getval (line 3003)
void getval ()
kindOf (line 2837)

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

  • access: public
string kindOf ()
scalartyp (line 3059)

Returns the type of the xmlrpcval.

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

  • access: public
string scalartyp ()
scalarval (line 3046)

Returns the value of a scalar xmlrpcval

  • access: public
mixed scalarval ()
serialize (line 2934)

Returns xml representation of the value. XML prologue not included

  • access: public
string serialize ([string $charset_encoding = ''])
  • string $charset_encoding: the charset to be used for serialization. if null, US-ASCII is assumed
serializeval (line 2946)
void serializeval ( $o)
  • $o
structeach (line 2996)

Return next member element for xmlrpcvals of type struct.

  • access: public
xmlrpcval structeach ()
structmem (line 2977)

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

  • access: public
xmlrpcval structmem (string $m)
  • string $m: the name of the struct member to be looked up
structmemexists (line 2965)

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

Works only on xmlrpcvals of type struct.

  • access: public
boolean structmemexists (string $m)
  • string $m: the name of the struct member to be looked up
structreset (line 2986)

Reset internal pointer for xmlrpcvals of type struct.

  • access: public
void structreset ()
structsize (line 3096)

Returns the number of members in an xmlrpcval of struct type

  • access: public
integer structsize ()

Documentation generated on Sat, 14 Nov 2009 11:23:33 +0000 by phpDocumentor 1.3.1