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

Class: xmlrpcmsg

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

Class xmlrpcmsg

Property Summary
mixed   $content_type  
mixed   $debug  
mixed   $methodname  
mixed   $params  
mixed   $payload  

[ Top ]
Method Summary
xmlrpcmsg   xmlrpcmsg()  
boolean   addParam()   Add a parameter to the list of parameters to be used upon method invocation
integer   getNumParams()   Returns the number of parameters in the messge.
xmlrpcval   getParam()   Returns the nth parameter in the message. The index zero-based.
string   method()   Gets/sets the xmlrpc method to be invoked
xmlrpcresp   &parseResponse()   Parse the xmlrpc response contained in the string $data and return an xmlrpcresp object.
xmlrpcresp   &parseResponseFile()   Given an open file handle, read all data available and parse it as axmlrpc response.
string   serialize()   Returns xml representation of the message. XML prologue included

[ Top ]
Properties
mixed   $content_type = 'text/xml' [line 2082]

[ Top ]
mixed   $debug [line 2081]

[ Top ]
mixed   $methodname [line 2079]

[ Top ]
mixed   $params = array() [line 2080]

[ Top ]
mixed   $payload [line 2078]

[ Top ]
Methods
Constructor xmlrpcmsg  [line 2088]

  xmlrpcmsg xmlrpcmsg( string $meth, [array $pars = 0]  )

Parameters:
string   $meth:  the name of the method to invoke
array   $pars:  array of parameters to be paased to the method (xmlrpcval objects)


[ Top ]
addParam  [line 2185]

  boolean addParam( xmlrpcval $par  )

Add a parameter to the list of parameters to be used upon method invocation

Parameters:
xmlrpcval   $par: 

API Tags:
Return:  false on failure
Access:  public


[ Top ]
getNumParams  [line 2212]

  integer getNumParams( )

Returns the number of parameters in the messge.


API Tags:
Return:  the number of parameters currently set
Access:  public


[ Top ]
getParam  [line 2205]

  xmlrpcval getParam( integer $i  )

Returns the nth parameter in the message. The index zero-based.

Parameters:
integer   $i:  the index of the parameter to fetch (zero based)

API Tags:
Return:  the i-th parameter
Access:  public


[ Top ]
method  [line 2159]

  string method( [string $meth = '']  )

Gets/sets the xmlrpc method to be invoked

Parameters:
string   $meth:  the method to be set (leave empty not to set it)

API Tags:
Return:  the method that will be invoked
Access:  public


[ Top ]
parseResponse  [line 2475]

  xmlrpcresp &parseResponse( [string $data = ''], [bool $headers_processed = false], [string $return_type = 'xmlrpcvals']  )

Parse the xmlrpc response contained in the string $data and return an xmlrpcresp object.

Parameters:
string   $data:  the xmlrpc response, eventually including http headers
bool   $headers_processed:  when true prevents parsing HTTP headers for interpretation of content-encoding and consequent decoding
string   $return_type:  decides return type, i.e. content of response->value(). Either 'xmlrpcvals', 'xml' or 'phpvals'

API Tags:
Access:  public


[ Top ]
parseResponseFile  [line 2221]

  xmlrpcresp &parseResponseFile( $fp  )

Given an open file handle, read all data available and parse it as axmlrpc response.

NB: the file handle is not closed by this function.

Parameters:
   $fp: 

API Tags:
Access:  public

Information Tags:
Todo:  add 2nd & 3rd param to be passed to ParseResponse() ???

[ Top ]
serialize  [line 2173]

  string serialize( [ $charset_encoding = '']  )

Returns xml representation of the message. XML prologue included

Parameters:
   $charset_encoding: 

API Tags:
Return:  the xml representation of the message, xml prologue included
Access:  public


[ Top ]