Class dom_xmlrpc_client

Description

Provides basic XML-RPC client functionality

Located in /includes/domit/dom_xmlrpc_client.php (line 32)

php_http_request
   |
   --php_http_client_generic
      |
      --dom_xmlrpc_client
Variable Summary
boolean $isMultiCall
string $responseType
Method Summary
dom_xmlrpc_client dom_xmlrpc_client ([string $host = ''], [string $path = '/'], [int $port = 80], [string $proxy = ''], int $timeout)
object A &arraysToObjects (array &$myArray)
mixed evaluateMessage (mixed &$message)
string &formatResponse (string $response)
string getResponseType ()
string &returnAsArray (string $response)
string &returnAsXML (string $response)
string &send (string &$message)
string &sendAndDisconnect (string $message)
void setHeaders ()
void setResponseType (array $type)
Variables
boolean $isMultiCall = false (line 36)
  • var: True if multiple method calls are to be made in a single request
string $responseType = DOM_XMLRPC_RESPONSE_TYPE_XML_DOMIT (line 34)
  • var: The method response type requested by the client

Inherited Variables

Inherited from php_http_client_generic

php_http_client_generic::$connection
php_http_client_generic::$events
php_http_client_generic::$response
php_http_client_generic::$responseHeadersAsObject

Inherited from php_http_request

php_http_request::$headers
php_http_request::$protocol
php_http_request::$protocolVersion
php_http_request::$requestMethod
php_http_request::$requestPath
Methods
Constructor dom_xmlrpc_client (line 46)

XML-RPC Client constructor

dom_xmlrpc_client dom_xmlrpc_client ([string $host = ''], [string $path = '/'], [int $port = 80], [string $proxy = ''], int $timeout)
  • string $host: The client connection host name, with or without its protocol prefix
  • string $path: The client connection path, not including the host name
  • int $port: The port to establish the client connection on
  • string $proxy: A proxy connection host name, with or without its protocol prefix
  • int $timeout: The timeout value for the client connection
arraysToObjects (line 192)

Converts PHP arrays to stdclass objects

  • return: stdclass object
object A &arraysToObjects (array &$myArray)
  • array &$myArray: The PHP array
evaluateMessage (line 70)

Determines whether message is multicall

  • return: The evaluated message
mixed evaluateMessage (mixed &$message)
  • mixed &$message: The message
formatResponse (line 116)

Returns the message response, formatted according to the specified response type

  • return: The formatted response
string &formatResponse (string $response)
  • string $response: The unformatted response
getResponseType (line 240)

Returns the current method response type

  • return: The current method response type
string getResponseType ()
returnAsArray (line 173)

Returns the message response as a PHP array

  • return: A PHP array representation of the method response
string &returnAsArray (string $response)
  • string $response: The unformatted response
returnAsXML (line 139)

Returns the message response as an XML document of the specified type

  • return: An XML document representing the method response
string &returnAsXML (string $response)
  • string $response: The unformatted response
send (line 87)

Sends data through the client connection

  • return: The http response
string &send (string &$message)
  • string &$message: The message to be sent

Redefinition of:
php_http_client_generic::send()
Sends data through the client connection
sendAndDisconnect (line 105)

Sends data through the client connection and disconnects

  • return: The http response
string &sendAndDisconnect (string $message)
  • string $message: The message to be sent
setHeaders (line 58)

Sets the headers for the client connection

void setHeaders ()

Redefinition of:
php_http_request::setHeaders()
Default method for setting headers; meant to be overridden in subclasses
setResponseType (line 219)

Sets the method response type to the specified type

void setResponseType (array $type)
  • array $type: The requested method response type

Inherited Methods

Inherited From php_http_client_generic

php_http_client_generic::php_http_client_generic()
php_http_client_generic::connect()
php_http_client_generic::decodeChunkedData()
php_http_client_generic::defaultHTTPEventHandler()
php_http_client_generic::disconnect()
php_http_client_generic::fireEvent()
php_http_client_generic::generateResponseHeadersAsObject()
php_http_client_generic::get()
php_http_client_generic::getHTTPEvent()
php_http_client_generic::get_custom()
php_http_client_generic::head()
php_http_client_generic::head_custom()
php_http_client_generic::isConnected()
php_http_client_generic::normalizeResponseIfChunked()
php_http_client_generic::post()
php_http_client_generic::post_custom()
php_http_client_generic::printHTML()
php_http_client_generic::send()
php_http_client_generic::setHTTPEvent()

Inherited From php_http_request

php_http_request::getHeaders()
php_http_request::setAuthorization()
php_http_request::setHeader()
php_http_request::setHeaders()
php_http_request::setProtocolVersion()
php_http_request::setRequestMethod()
php_http_request::setRequestPath()

Documentation generated on Fri, 4 Mar 2005 13:55:59 +1000 by phpDocumentor 1.3.0RC3