XML-RPC for PHP

version 3.1.0

Edd Dumbill

Gaetano Giunta

Miles Lott

Justin R. Miller

Andres Salomon

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

  • Neither the name of the "XML-RPC for PHP" nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


Table of Contents

1. Introduction
Acknowledgements
2. What's new
3.1.0
3.0.1
3.0.0
3.0.0 beta
2.2.2
2.2.1
2.2
2.1
2.0 final
2.0 Release candidate 3
2.0 Release candidate 2
2.0 Release candidate 1
3. System Requirements
4. Files in the distribution
5. Known bugs and limitations
6. Support
Online Support
The Jellyfish Book
7. Class documentation
xmlrpcval
Notes on types
Creation
Methods
xmlrpcmsg
Creation
Methods
xmlrpc_client
Creation
Methods
Variables
xmlrpcresp
Creation
Methods
xmlrpc_server
Method handler functions
The dispatch map
Method signatures
Delaying the server response
Modifying the server behaviour
Fault reporting
'New style' servers
8. Global variables
"Constant" variables
$xmlrpcerruser
$xmlrpcI4, $xmlrpcInt, $xmlrpcBoolean, $xmlrpcDouble, $xmlrpcString, $xmlrpcDateTime, $xmlrpcBase64, $xmlrpcArray, $xmlrpcStruct, $xmlrpcValue, $xmlrpcNull
$xmlrpcTypes, $xmlrpc_valid_parents, $xmlrpcerr, $xmlrpcstr, $xmlrpcerrxml, $xmlrpc_backslash, $_xh, $xml_iso88591_Entities, $xmlEntities, $xmlrpcs_capabilities
Variables whose value can be modified
xmlrpc_defencoding
xmlrpc_internalencoding
xmlrpcName
xmlrpcVersion
xmlrpc_null_extension
xmlrpc_null_apache_encoding
9. Helper functions
Date functions
iso8601_encode
iso8601_decode
Easy use with nested PHP values
php_xmlrpc_decode
php_xmlrpc_encode
php_xmlrpc_decode_xml
Automatic conversion of php functions into xmlrpc methods (and vice versa)
wrap_xmlrpc_method
wrap_php_function
Functions removed from the library
xmlrpc_decode
xmlrpc_encode
Debugging aids
xmlrpc_debugmsg
10. Reserved methods
system.getCapabilities
system.listMethods
system.methodSignature
system.methodHelp
system.multicall
11. Examples
XML-RPC client: state name query
Executing a multicall call
12. Frequently Asked Questions
How to send custom XML as payload of a method call
Is there any limitation on the size of the requests / responses that can be successfully sent?
My server (client) returns an error whenever the client (server) returns accented characters
How to enable long-lasting method calls
My client returns "XML-RPC Fault #2: Invalid return payload: enable debugging to examine incoming payload": what should I do?
How can I save to a file the xml of the xmlrpc responses received from servers?
Can I use the ms windows character set?
Does the library support using cookies / http sessions?
A. Integration with the PHP xmlrpc extension
B. Substitution of the PHP xmlrpc extension
C. 'Enough of xmlrpcvals!': new style library usage
D. Usage of the debugger