XML_RPC2
[ class tree: XML_RPC2 ] [ index: XML_RPC2 ] [ all elements ]
Packages:
XML_RPC2


Classes:
XML_RPC2_Backend
XML_RPC2_Backend_Php_Client
XML_RPC2_Backend_Php_Request
XML_RPC2_Backend_Php_Response
XML_RPC2_Backend_Php_Server
XML_RPC2_Backend_Php_Value
XML_RPC2_Backend_Php_Value_Array
XML_RPC2_Backend_Php_Value_Base64
XML_RPC2_Backend_Php_Value_Boolean
XML_RPC2_Backend_Php_Value_Datetime
XML_RPC2_Backend_Php_Value_Double
XML_RPC2_Backend_Php_Value_Integer
XML_RPC2_Backend_Php_Value_Scalar
XML_RPC2_Backend_Php_Value_String
XML_RPC2_Backend_Php_Value_Struct
XML_RPC2_Backend_Xmlrpcext_Client
XML_RPC2_Backend_Xmlrpcext_Server
XML_RPC2_Backend_Xmlrpcext_Value
XML_RPC2_CachedClient
XML_RPC2_CachedServer
XML_RPC2_Client
XML_RPC2_CurlException
XML_RPC2_DecodeException
XML_RPC2_EncodeException
XML_RPC2_Exception
XML_RPC2_FaultException
XML_RPC2_InvalidDateFormatException
XML_RPC2_InvalidDebugException
XML_RPC2_InvalidPrefixException
XML_RPC2_InvalidSslverifyException
XML_RPC2_InvalidTypeEncodeException
XML_RPC2_InvalidUriException
XML_RPC2_ReceivedInvalidStatusCodeException
XML_RPC2_Server
XML_RPC2_Server_CallHandler
XML_RPC2_Server_Callhandler_Class
XML_RPC2_Server_Callhandler_Instance
XML_RPC2_Server_Method
XML_RPC2_TransportException
XML_RPC2_UnknownMethodException
XML_RPC2_Util_HTTPRequest
XML_RPC2_Value
XML_RPC2
   XML_RPC2_InvalidTypeException
Files:
Array.php
Backend.php
Base64.php
Boolean.php
CachedClient.php
CachedServer.php
CallHandler.php
Class.php
Client.php
Client.php
Client.php
Datetime.php
Double.php
Exception.php
HTTPRequest.php
Instance.php
Integer.php
Method.php
Request.php
Response.php
Scalar.php
Server.php
Server.php
Server.php
String.php
Struct.php
Value.php
Value.php
Value.php

Class: XML_RPC2_Backend_Php_Response

Source Location: /XML_RPC2-1.0.5/XML/RPC2/Backend/Php/Response.php

Class Overview




XML-RPC response backend class.




Author(s):






          
          


Copyright:


    
  
  • 2004-2006 Sergio Carvalho
    • 








Methods
















Inherited Variables





Inherited Methods














Class Details



[line 61]

XML-RPC response backend class.
This class represents an XML_RPC request, exposing the methods  needed to encode/decode an xml-rpc response.









[ Top ]








Method Detail



	
	
decode   [line 125]

	

    

    

		mixed decode(
SimpleXMLElement
$xml)
    

    


	
		Parse a response and either return the native PHP result.
This method receives an XML-RPC response document, in SimpleXML format, decodes it and returns the payload value.


    

  • Return: The response payload
    • 

  • See: http://www.xmlrpc.com/spec
    • 

  • Throws: XML_RPC2_FaultException Signals the decoded response was an XML-RPC fault
    • 

  • Throws: XML_RPC2_DecodeException Signals an ill formed payload response section
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        SimpleXmlElement  
        $xml  
        — 
        The Transport XML
      

        

    


        
[ Top ]

  

  
  
	
	
encode   [line 80]

	

    

    

		string encode(
mixed
$param, [string
$encoding = 'iso-8859-1'])
    

    


	
		Encode a normal XML-RPC response, containing the provided value
You may supply a php-native value, or an XML_RPC2_Backend_Php_Value instance, to be returned. Usually providing a native value  is more convenient. However, for some types, XML_RPC2_Backend_Php_Value::createFromNative can't properly choose the xml-rpc  type. In these cases, constructing an XML_RPC2_Backend_Php_Value and using it as param here is the only way to return the desired  type.








        
Parameters:

    

    

          

        mixed  
        $param  
        — 
        The result value which the response will envelop
      

          

        string  
        $encoding  
        — 
        encoding
      

        

    


        
[ Top ]

  

  
  
	
	
encodeFault   [line 102]

	

    

    

		string encodeFault(
int
$code, string
$message, [string
$encoding = 'iso-8859-1'])
    

    


	
		Encode a fault XML-RPC response, containing the provided code and message








        
Parameters:

    

    

          

        int  
        $code  
        — 
        Response code
      

          

        string  
        $message  
        — 
        Response message
      

          

        string  
        $encoding  
        — 
        encoding
      

        

    


        
[ Top ]

  

  
  



        

		    

		    Documentation generated on Mon, 11 Mar 2019 15:25:27 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright ©  PHP Group 2004.