Class Zend_XmlRpc_Response

Description

XmlRpc Response

Container for accessing an XMLRPC return value and creating the XML response.

  • version: $Id: Response.php 3832 2007-03-09 04:18:32Z matthew $
  • copyright: Copyright (c) 2005-2007 Zend Technologies USA Inc. (http://www.zend.com)
  • usedby: Zend_XmlRpc_Response_Http
  • license: New BSD License

Located in /XmlRpc/Response.php (line 42)


	
			
Direct descendents
Class Description
 class Zend_XmlRpc_Response_Http HTTP response
Variable Summary
Method Summary
 void __construct ([mixed $return = null], [string $type = null])
 string getEncoding ()
 mixed getReturnValue ()
 boolean isFault ()
 boolean loadXml (string $response)
 string saveXML ()
 Zend_XmlRpc_Response setEncoding (string $encoding)
 void setReturnValue (mixed $value, [string $type = null])
 string __toString ()
Variables
string $_encoding = 'UTF-8' (line 60)

Response character encoding

  • access: protected
null|Zend_XmlRpc_Fault $_fault = null (line 66)

Fault, if response is a fault response

  • access: protected
mixed $_return (line 48)

Return value

  • access: protected
string $_type (line 54)

Return type

  • access: protected
Methods
Constructor __construct (line 78)

Constructor

Can optionally pass in the return value and type hinting; otherwise, the return value can be set via setReturnValue().

  • access: public
void __construct ([mixed $return = null], [string $type = null])
  • mixed $return
  • string $type
getEncoding (line 100)

Retrieve current response encoding

  • access: public
string getEncoding ()
getFault (line 155)

Returns the fault, if any.

  • access: public
null|Zend_XmlRpc_Fault getFault ()
getReturnValue (line 125)

Retrieve the return value

  • access: public
mixed getReturnValue ()
isFault (line 145)

Is the response a fault response?

  • access: public
boolean isFault ()
loadXml (line 170)

Load a response from an XML response

Attempts to load a response from an XMLRPC response, autodetecting if it is a fault response.

  • return: True if a valid XMLRPC response, false if a fault response or invalid input
  • access: public
boolean loadXml (string $response)
  • string $response
saveXML (line 221)

Return response as XML

  • access: public
string saveXML ()
setEncoding (line 89)

Set encoding to use in response

  • access: public
Zend_XmlRpc_Response setEncoding (string $encoding)
  • string $encoding
setReturnValue (line 114)

Set the return value

Sets the return value, with optional type hinting if provided.

  • access: public
void setReturnValue (mixed $value, [string $type = null])
  • mixed $value
  • string $type
_getXmlRpcReturn (line 135)

Retrieve the XMLRPC value for the return value

  • access: protected
Zend_XmlRpc_Value _getXmlRpcReturn ()
__toString (line 242)

Return XML response

  • access: public
string __toString ()

Redefined in descendants as:

Documentation generated on Sun, 27 May 2007 23:27:12 -0700 by phpDocumentor 1.3.2