| 1441 |
ariadna |
1 |
XMLRPC for PHP (a.k.a. PHPXMLRPC)
|
|
|
2 |
=================================
|
|
|
3 |
|
|
|
4 |
A php library for building xml-rpc clients and servers.
|
|
|
5 |
|
|
|
6 |
Requirements and Installation
|
|
|
7 |
-----------------------------
|
|
|
8 |
|
|
|
9 |
The recommended way to install this library is using Composer.
|
|
|
10 |
|
|
|
11 |
Detailed installation instructions are in the [INSTALL.md](INSTALL.md) file, along with system requirements listing.
|
|
|
12 |
|
|
|
13 |
Documentation
|
|
|
14 |
-------------
|
|
|
15 |
|
|
|
16 |
* See the documentation page at [gggeek.github.io/phpxmlrpc](https://gggeek.github.io/phpxmlrpc) for a list of the
|
|
|
17 |
library main features and all project related information, including information about online resources such as
|
|
|
18 |
debuggers and demo servers.
|
|
|
19 |
|
|
|
20 |
* The user manual can be found in the doc/manual directory: [phpxmlrpc_manual.adoc](doc/manual/phpxmlrpc_manual.adoc).
|
|
|
21 |
It includes sections about upgrading from previous versions and the Backwards compatibility promise as well as about
|
|
|
22 |
running the library's testing suite and bundled debugger.
|
|
|
23 |
|
|
|
24 |
The manual is formatted as an asciidoc file - if viewing it locally, it is recommended to either use an IDE which can
|
|
|
25 |
natively render asciidoc, or view it as html with a browser by serving it via a webserver and accessing
|
|
|
26 |
/doc/manual/index.html
|
|
|
27 |
|
|
|
28 |
The latest version of the manual is also accessible online at https://github.com/gggeek/phpxmlrpc/blob/master/doc/manual/phpxmlrpc_manual.adoc
|
|
|
29 |
|
|
|
30 |
* Automatically-generated documentation for the API is available online at [http://gggeek.github.io/phpxmlrpc/doc-4/api/index.html](http://gggeek.github.io/phpxmlrpc/doc-4/api/index.html)
|
|
|
31 |
|
|
|
32 |
* You are encouraged to look also at the code examples found in the demo/ directory.
|
|
|
33 |
|
|
|
34 |
Note: to reduce the size of the download, the demo files are not part of the default package installed with Composer.
|
|
|
35 |
You can either check them out online at https://github.com/gggeek/phpxmlrpc/tree/master/demo, download them as a separate
|
|
|
36 |
tarball from https://github.com/gggeek/phpxmlrpc/releases or make sure they are available locally by installing the
|
|
|
37 |
library using Composer option `--prefer-install=source`. Whatever the method chosen, make sure that the demo folder is
|
|
|
38 |
not directly accessible from the internet, i.e. it is not within the webserver root directory).
|
|
|
39 |
|
|
|
40 |
Extras
|
|
|
41 |
------
|
|
|
42 |
|
|
|
43 |
* This library does include a visual debugger which can be used to troubleshoot connections to 3rd party xml-rpc servers.
|
|
|
44 |
In case you'd like to use the debugger but do not have a working PHP installation, you can run it standalone as a
|
|
|
45 |
Container image. Instructions can be found at https://github.com/gggeek/phpxmlrpc-debugger
|
|
|
46 |
|
|
|
47 |
* A companion PHP library, which adds support for the JSON-RPC protocol, is available at https://github.com/gggeek/phpxmlrpc-jsonrpc
|
|
|
48 |
|
|
|
49 |
* A companion PHP library, which adds support for XML-RPC servers to automatically generate API documentation, and more,
|
|
|
50 |
is available at https://github.com/gggeek/phpxmlrpc-extras
|
|
|
51 |
|
|
|
52 |
* Lats but not least, a Javascript library, implementing both XML-RPC and JSON-RPC clients using a very similar API, is
|
|
|
53 |
available at https://github.com/gggeek/jsxmlrpc
|
|
|
54 |
|
|
|
55 |
License
|
|
|
56 |
-------
|
|
|
57 |
Use of this software is subject to the terms in the [license.txt](license.txt) file
|
|
|
58 |
|
|
|
59 |
|
|
|
60 |
[](https://packagist.org/packages/phpxmlrpc/phpxmlrpc)
|
|
|
61 |
[](https://packagist.org/packages/phpxmlrpc/phpxmlrpc)
|
|
|
62 |
[](https://packagist.org/packages/phpxmlrpc/phpxmlrpc)
|
|
|
63 |
|
|
|
64 |
[](https://github.com/gggeek/phpxmlrpc/actions/workflows/ci.yml)
|
|
|
65 |
[](https://app.codecov.io/gh/gggeek/phpxmlrpc)
|