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 xmlrpcresp

Description
Description | Variables (details) | Methods (details)

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

Class xmlrpcresp
Variable Summary
Description | Variables (details) | Methods (details)
Variable mixed $content_type
Variable mixed $errno
Variable mixed $errstr
Variable mixed $hdrs
Variable mixed $payload
Variable mixed $raw_data
Variable mixed $val
Variable mixed $valtyp
Variable mixed $_cookies
Method Summary
Description | Variables (details) | Methods (details)
Constructor xmlrpcresp xmlrpcresp (mixed $val, [integer $fcode = 0], [string $fstr = ''], [string $valtyp = ''])
Method array cookies ()
Method integer faultCode ()
Method string faultString ()
Method string serialize ([string $charset_encoding = ''])
Method mixed value ()
Variables
Description | Variables (details) | Methods (details)
mixed $content_type = 'text/xml' (line 1878)
mixed $errno = 0 (line 1873)
mixed $errstr = '' (line 1874)
mixed $hdrs = array() (line 1876)
mixed $payload (line 1875)
mixed $raw_data = '' (line 1879)
mixed $val = 0 (line 1871)
mixed $valtyp (line 1872)
mixed $_cookies = array() (line 1877)
Methods
Description | Variables (details) Methods (details)
Constructor xmlrpcresp (line 1891)
  • todo: add check that $val / $fcode / $fstr is of correct type??? NB: as of now we do not do it, since it might be either an xmlrpcval or a plain php val, or a complete xml chunk, depending on usage of xmlrpc_client::send() inside which creator is called...
xmlrpcresp xmlrpcresp (mixed $val, integer $fcode, [string $fstr = ''], [string $valtyp = ''])
  • mixed $val: either an xmlrpcval obj, a php value or the xml serialization of an xmlrpcval (a string)
  • integer $fcode: set it to anything but 0 to create an error response
  • string $fstr: the error string, in case of an error response
  • string $valtyp: either 'xmlrpcvals', 'phpvals' or 'xml'
cookies (line 1970)

Returns an array with the cookies received from the server.

Array has the form: $cookiename => array ('value' => $val, $attr1 => $val1, $attr2 = $val2, ...) with attributes being e.g. 'expires', 'path', domain'. NB: cookies sent as 'expired' by the server (i.e. with an expiry date in the past) are still present in the array. It is up to the user-defined code to decide how to use the received cookies, and wheter they have to be sent back with the next request to the server (using xmlrpc_client::setCookie) or not

  • return: array of cookies received from the server
  • access: public
array cookies ()
faultCode (line 1934)

Returns the error code of the response.

  • return: the error code of this response (0 for not-error responses)
  • access: public
integer faultCode ()
faultString (line 1944)

Returns the error code of the response.

  • return: the error string of this response ('' for not-error responses)
  • access: public
string faultString ()
serialize (line 1981)

Returns xml representation of the response. XML prologue not included

  • return: the xml representation of the response
  • access: public
string serialize ([string $charset_encoding = ''])
  • string $charset_encoding: the charset to be used for serialization. if null, US-ASCII is assumed
value (line 1954)

Returns the value received by the server.

  • return: the xmlrpcval object returned by the server. Might be an xml string or php value if the response has been created by specially configured xmlrpc_client objects
  • access: public
mixed value ()
Documentation generated on Mon, 22 Sep 2008 12:18:12 +0100 by phpDocumentor 1.3.1