A

AutoloaderClass in namespace PhpXmlRpc
In the unlikely event that you are not using Composer to manage class autoloading, here's an autoloader for this lib.
Autoloader::autoload() — Method in class Autoloader
Handles autoloading of classes.
Builder::applyXslt() — Method in class Builder
$ ClientProperty in class Client
$ ClientProperty in class Client
List of http compression methods accepted by the client for responses.
$ ClientProperty in class Client
Request::addParam() — Method in class Request
Add a parameter to the list of parameters to be used upon method invocation.
$ ServerProperty in class Server
List of http compression methods accepted by the server for requests. Set at constructor time.
$ ServerProperty in class Server
$ ServerProperty in class Server
List of charset encodings natively accepted for requests.
Server::add_to_map() — Method in class Server
Add a method to the dispatch map.
Value::addScalar() — Method in class Value
Add a single php value to an xmlrpc value.
Value::addArray() — Method in class Value
Add an array of xmlrpc value objects to an xmlrpc value.
Value::addStruct() — Method in class Value
Merges an array of named xmlrpc value objects into an xmlrpc value.
Value::arraymem() — Method in class Value
Returns the m-th member of an xmlrpc value of array type.
Value::arraysize() — Method in class Value
Returns the number of members in an xmlrpc value of array type.

B

BuilderClass in namespace PhpXmlRpc
Builder::buildDir() — Method in class Builder
Wrapper::buildWrapMethodSource() — Method in class Wrapper

C

ClientClass in namespace PhpXmlRpc
Used to represent a client of an XML-RPC server.
$ ClientProperty in class Client
$ ClientProperty in class Client
$ ClientProperty in class Client
$ ClientProperty in class Client
$ ClientProperty in class Client
CharsetClass in namespace PhpXmlRpc\Helper
$ RequestProperty in class Request
Request::createPayload() — Method in class Request
$ ResponseProperty in class Response
Response::cookies() — Method in class Response
Returns an array with the cookies received from the server.
$ ServerProperty in class Server
When set to true, it will enable HTTP compression of the response, in case the client has declared its support for compression in the request.
Value::count() — Method in class Value
Returns the number of members in an xmlrpc value: - 0 for uninitialized values - 1 for scalar values - the number of elements for struct and array values
xmlrpcval::count() — Method in class xmlrpcval
Returns the number of members in an xmlrpc value: - 0 for uninitialized values - 1 for scalar values - the number of elements for struct and array values

D

Builder::distDir() — Method in class Builder
Builder::distFiles() — Method in class Builder
$ ClientProperty in class Client
Encoder::decode() — Method in class Encoder
Takes an xmlrpc value in object format and translates it into native PHP types.
Encoder::decodeXml() — Method in class Encoder
Convert the xml representation of a method response, method request or single xmlrpc value into the appropriate object (a.k.a. deserialize).
DateClass in namespace PhpXmlRpc\Helper
Http::decodeChunked() — Method in class Http
Decode a string that is encoded with "chunked" transfer encoding as defined in rfc2068 par. 19.4.6 Code shamelessly stolen from nusoap library by Dietrich Ayala.
Logger::debugMessage() — Method in class Logger
Echoes a debug message, taking care of escaping it when not in console mode.
$ RequestProperty in class Request
$ ServerProperty in class Server
Controls whether the server is going to echo debugging messages back to the client as comments in response body.

E

$ ClientProperty in class Client
$ ClientProperty in class Client
$ ClientProperty in class Client
EncoderClass in namespace PhpXmlRpc
A helper class to easily convert between Value objects and php native values
Encoder::encode() — Method in class Encoder
Takes native php types and encodes them into xmlrpc PHP object format.
Charset::encodeEntities() — Method in class Charset
Convert a string to the correct XML representation in a target charset.
PhpXmlRpc::exportGlobals() — Method in class PhpXmlRpc
A function to be used for compatibility with legacy code: it creates all global variables which used to be declared, such as library version etc.
$ ResponseProperty in class Response
$ ResponseProperty in class Response
$ ServerProperty in class Server
Controls behaviour of server when the invoked user function throws an exception: 0 = catch it and return an 'internal error' xmlrpc response (default) 1 = catch it and return an xmlrpc response with the error corresponding to the exception 2 = allow the exception to float to the upper layers
Server::error_occurred() — Method in class Server
xmlrpc_server::echoInput() — Method in class xmlrpc_server
A debugging routine: just echoes back the input packet as a string value

F

Response::faultCode() — Method in class Response
Returns the error code of the response.
Response::faultString() — Method in class Response
Returns the error code of the response.
$ ServerProperty in class Server
Defines how functions in dmap will be invoked: either using an xmlrpc request object or plain php values.

G

Builder::getOpts() — Method in class Builder
Charset::getEntities() — Method in class Charset
Used only for backwards compatibility
XMLParser::guessEncoding() — Method in class XMLParser
xml charset encoding guessing helper function.
Request::getParam() — Method in class Request
Returns the nth parameter in the request. The index zero-based.
Request::getNumParams() — Method in class Request
Returns the number of parameters in the message.
Server::getSystemDispatchMap() — Method in class Server
Server::getCapabilities() — Method in class Server
Value::getIterator() — Method in class Value
Implements the IteratorAggregate interface
xmlrpcval::getval() — Method in class xmlrpcval
xmlrpcval::getIterator() — Method in class xmlrpcval
Implements the IteratorAggregate interface

H

Builder::highlightPhpInHtml() — Method in class Builder
HttpClass in namespace PhpXmlRpc\Helper
XMLParser::hasEncoding() — Method in class XMLParser
Helper function: checks if an xml chunk as a charset declaration (BOM or in the xml declaration)
$ ResponseProperty in class Response

I

Charset::instance() — Method in class Charset
This class is singleton for performance reasons.
Charset::isValidCharset() — Method in class Charset
Checks if a given charset encoding is present in a list of encodings or if it is a valid subset of any encoding in the list.
Date::iso8601Encode() — Method in class Date
Given a timestamp, return the corresponding ISO8601 encoded string.
Date::iso8601Decode() — Method in class Date
Given an ISO8601 date string, return a timet in the localtime, or UTC.
Logger::instance() — Method in class Logger
This class is singleton, so that later we can move to DI patterns.
PhpXmlRpc::importGlobals() — Method in class PhpXmlRpc
A function to be used for compatibility with legacy code: it gets the values of all global variables which used to be declared, such as library version etc.

K

$ ClientProperty in class Client
$ ClientProperty in class Client
$ ClientProperty in class Client
Request::kindOf() — Method in class Request
Kept the old name even if Request class was renamed, for compatibility.
Value::kindOf() — Method in class Value
Returns a string containing either "struct", "array", "scalar" or "undef", describing the base type of the value.

L

Builder::libVersion() — Method in class Builder
LoggerClass in namespace PhpXmlRpc\Helper

M

$ ClientProperty in class Client
Client::multicall() — Method in class Client
Send an array of requests and return an array of responses.
$ RequestProperty in class Request
Request::method() — Method in class Request
Gets/sets the xmlrpc method to be invoked.
$ ValueProperty in class Value
$ ValueProperty in class Value

N

$ ClientProperty in class Client

O

Builder::option() — Method in class Builder
Value::offsetSet() — Method in class Value
Value::offsetExists() — Method in class Value
Value::offsetUnset() — Method in class Value
Value::offsetGet() — Method in class Value
$ WrapperProperty in class Wrapper

P

$ ClientProperty in class Client
$ ClientProperty in class Client
$ ClientProperty in class Client
$ ClientProperty in class Client
$ ClientProperty in class Client
$ ClientProperty in class Client
$ ClientProperty in class Client
$ ClientProperty in class Client
Http::parseResponseHeaders() — Method in class Http
Parses HTTP an http response headers and separates them from the body.
PhpXmlRpcClass in namespace PhpXmlRpc
Manages global configuration for operation of the library.
$ RequestProperty in class Request
$ RequestProperty in class Request
Request::parseResponseFile() — Method in class Request
Given an open file handle, read all data available and parse it as an xmlrpc response.
Request::parseResponse() — Method in class Request
Parse the xmlrpc response contained in the string $data and return a Response object.
$ ResponseProperty in class Response
$ ServerProperty in class Server
Option used for fine-tuning the encoding the php values returned from functions registered in the dispatch map when the functionsparameterstypes member is set to 'phpvals'
Server::parseRequest() — Method in class Server
Parse an xml chunk containing an xmlrpc request and execute the corresponding php function registered with the server.
Wrapper::php2XmlrpcType() — Method in class Wrapper
Given a string defining a php type or phpxmlrpc type (loosely defined: strings accepted come from javadoc blocks), return corresponding phpxmlrpc type.

R

Autoloader::register() — Method in class Autoloader
Registers PhpXmlRpc\Autoloader as an SPL autoloader.
$ ClientProperty in class Client
Name of compression scheme to be used for sending requests.
$ ClientProperty in class Client
The charset encoding that will be used for serializing request sent by the client.
$ ClientProperty in class Client
Decides the content of Response objects returned by calls to send() and multicall().
RequestClass in namespace PhpXmlRpc
This class provides the representation of a request to an XML-RPC server.
ResponseClass in namespace PhpXmlRpc
This class provides the representation of the response of an XML-RPC server.
$ ResponseProperty in class Response
$ ServerProperty in class Server
Charset encoding to be used for response.

S

$ ClientProperty in class Client
$ ClientProperty in class Client
Client::setDebug() — Method in class Client
Enable/disable the echoing to screen of the xmlrpc responses received. The default is not no output anything.
Client::setCredentials() — Method in class Client
Sets the username and password for authorizing the client to the server.
Client::setCertificate() — Method in class Client
Set the optional certificate and passphrase used in SSL-enabled communication with a remote server.
Client::setCaCertificate() — Method in class Client
Add a CA certificate to verify server with in SSL-enabled communication when SetSSLVerifypeer has been set to TRUE.
Client::setKey() — Method in class Client
Set attributes for SSL communication: private SSL key.
Client::setSSLVerifyPeer() — Method in class Client
Set attributes for SSL communication: verify the remote host's SSL certificate, and cause the connection to fail if the cert verification fails.
Client::setSSLVerifyHost() — Method in class Client
Set attributes for SSL communication: verify the remote host's SSL certificate's common name (CN).
Client::setSSLVersion() — Method in class Client
Set attributes for SSL communication: SSL version to use. Best left at 0 (default value ): let cURL decide
Client::setProxy() — Method in class Client
Set proxy info.
Client::setAcceptedCompression() — Method in class Client
Enables/disables reception of compressed xmlrpc responses.
Client::setRequestCompression() — Method in class Client
Enables/disables http compression of xmlrpc request.
Client::setCookie() — Method in class Client
Adds a cookie to list of cookies that will be sent to server with every further request (useful e.g. for keeping session info outside of the xml-rpc payload).
Client::setCurlOptions() — Method in class Client
Directly set cURL options, for extra flexibility (when in cURL mode).
Client::setUserAgent() — Method in class Client
Set user-agent string that will be used by this client instance in http headers sent to the server.
Client::send() — Method in class Client
Send an xmlrpc request to the server.
Request::serialize() — Method in class Request
Returns xml representation of the message. XML prologue included.
Request::setDebug() — Method in class Request
Enables/disables the echoing to screen of the xmlrpc responses received.
Response::serialize() — Method in class Response
Returns xml representation of the response. XML prologue not included.
ServerClass in namespace PhpXmlRpc
Allows effortless implementation of XML-RPC servers
Server::setDebug() — Method in class Server
Set debug level of server.
Server::serializeDebug() — Method in class Server
Return a string with the serialized representation of all debug info.
Server::service() — Method in class Server
Execute the xmlrpc request, printing the response.
Value::serialize() — Method in class Value
Returns the xml representation of the value. XML prologue not included.
Value::structmemexists() — Method in class Value
Checks whether a struct member with a given name is present.
Value::structmem() — Method in class Value
Returns the value of a given struct member (an xmlrpc value object in itself).
Value::structreset() — Method in class Value
Reset internal pointer for xmlrpc values of type struct.
Value::structeach() — Method in class Value
Return next member element for xmlrpc values of type struct.
Value::scalarval() — Method in class Value
Returns the value of a scalar xmlrpc value (base 64 decoding is automatically handled here)
Value::scalartyp() — Method in class Value
Returns the type of the xmlrpc value.
Value::structsize() — Method in class Value
Returns the number of members in an xmlrpc value of struct type.
xmlrpcval::serializeval() — Method in class xmlrpcval

T

Builder::tool() — Method in class Builder

U

$ ClientProperty in class Client
$ ClientProperty in class Client
Sent to servers in http headers.
$ ServerProperty in class Server
Extra data passed at runtime to method handling functions. Used only by EPI layer

V

$ ClientProperty in class Client
$ ClientProperty in class Client
$ ResponseProperty in class Response
$ ResponseProperty in class Response
Response::value() — Method in class Response
Returns the value received by the server. If the Response's faultCode is non-zero then the value returned by this method should not be used (it may not even be an object).
ValueClass in namespace PhpXmlRpc
This class enables the creation of values for XML-RPC, by encapsulating plain php values.

W

Builder::workspaceDir() — Method in class Builder
WrapperClass in namespace PhpXmlRpc
PHP-XMLRPC "wrapper" class - generate stubs to transparently access xmlrpc methods as php functions and vice-versa.
Wrapper::wrapPhpFunction() — Method in class Wrapper
Given a user-defined PHP function, create a PHP 'wrapper' function that can be exposed as xmlrpc method from an xmlrpc server object and called from remote clients (as well as its corresponding signature info).
Wrapper::wrapPhpClass() — Method in class Wrapper
Given a user-defined PHP class or php object, map its methods onto a list of PHP 'wrapper' functions that can be exposed as xmlrpc methods from an xmlrpc server object and called from remote clients (as well as their corresponding signature info).
Wrapper::wrapXmlrpcMethod() — Method in class Wrapper
Given an xmlrpc client and a method name, register a php wrapper function that will call it and return results using native php types for both params and results. The generated php function will return a Response object for failed xmlrpc calls.
Wrapper::wrapXmlrpcServer() — Method in class Wrapper
Similar to wrapXmlrpcMethod, but will generate a php class that wraps all xmlrpc methods exposed by the remote server as own methods.

X

$ ClientProperty in class Client
CURL handle: used for keep-alive connections (PHP 4.3.8 up, see: http://curl.haxx.se/docs/faq.html#7.3).
XMLParserClass in namespace PhpXmlRpc\Helper
Deals with parsing the XML.
$ XMLParserProperty in class XMLParser
XMLParser::xmlrpc_se() — Method in class XMLParser
xml parser handler function for opening element tags.
XMLParser::xmlrpc_se_any() — Method in class XMLParser
Used in decoding xml chunks that might represent single xmlrpc values.
XMLParser::xmlrpc_ee() — Method in class XMLParser
xml parser handler function for close element tags.
XMLParser::xmlrpc_ee_fast() — Method in class XMLParser
Used in decoding xmlrpc requests/responses without rebuilding xmlrpc Values.
XMLParser::xmlrpc_cd() — Method in class XMLParser
xml parser handler function for character data.
XMLParser::xmlrpc_dh() — Method in class XMLParser
xml parser handler function for 'other stuff', ie. not char data or element start/end tag. In fact it only gets called on unknown entities.
$ PhpXmlRpcProperty in class PhpXmlRpc
$ PhpXmlRpcProperty in class PhpXmlRpc
$ PhpXmlRpcProperty in class PhpXmlRpc
$ PhpXmlRpcProperty in class PhpXmlRpc
$ PhpXmlRpcProperty in class PhpXmlRpc
$ PhpXmlRpcProperty in class PhpXmlRpc
$ PhpXmlRpcProperty in class PhpXmlRpc
$ PhpXmlRpcProperty in class PhpXmlRpc
$ PhpXmlRpcProperty in class PhpXmlRpc
$ PhpXmlRpcProperty in class PhpXmlRpc
$ PhpXmlRpcProperty in class PhpXmlRpc
$ PhpXmlRpcProperty in class PhpXmlRpc
Request::xml_header() — Method in class Request
Request::xml_footer() — Method in class Request
Server::xmlrpc_debugmsg() — Method in class Server
Add a string to the debug info that can be later serialized by the server as part of the response message.
$ ValueProperty in class Value
$ ValueProperty in class Value
$ ValueProperty in class Value
$ ValueProperty in class Value
$ ValueProperty in class Value
$ ValueProperty in class Value
$ ValueProperty in class Value
$ ValueProperty in class Value
$ ValueProperty in class Value
$ ValueProperty in class Value
$ ValueProperty in class Value
$ ValueProperty in class Value
Wrapper::xmlrpc2PhpType() — Method in class Wrapper
Given a string defining a phpxmlrpc type return the corresponding php type.
xmlrpc_clientClass in namespace
xmlrpc_serverClass in namespace
xmlrpcmsgClass in namespace
xmlrpcrespClass in namespace
xmlrpcvalClass in namespace

_

Client::__construct() — Method in class Client
$ XMLParserProperty in class XMLParser
Request::__construct() — Method in class Request
$ ResponseProperty in class Response
Response::__construct() — Method in class Response
Server::__construct() — Method in class Server
Server::_xmlrpcs_getCapabilities() — Method in class Server
Server::_xmlrpcs_listMethods() — Method in class Server
Server::_xmlrpcs_methodSignature() — Method in class Server
Server::_xmlrpcs_methodHelp() — Method in class Server
Server::_xmlrpcs_multicall_error() — Method in class Server
Server::_xmlrpcs_multicall_do_call() — Method in class Server
Server::_xmlrpcs_multicall_do_call_phpvals() — Method in class Server
Server::_xmlrpcs_multicall() — Method in class Server
Server::_xmlrpcs_errorHandler() — Method in class Server
Error handler used to track errors that occur during server-side execution of PHP code.
$ ValueProperty in class Value
Value::__construct() — Method in class Value
Build an xmlrpc value.