3 A php library for building xml-rpc clients and servers.
7 The recommended way to install this library is using Composer.
9 Detailed installation instructions are in the [INSTALL.md](INSTALL.md) file, along with system requirements listing.
14 See the documentation page at [gggeek.github.io/phpxmlrpc](https://gggeek.github.io/phpxmlrpc) for a list of the
15 library main features and all project related information.
17 The user manual can be found in the doc/manual directory, in Asciidoc format: [phpxmlrpc_manual.adoc](doc/manual/phpxmlrpc_manual.adoc)
19 Older release tarballs also contain HTML and PDF versions of the manual, as well as an automatically generated API documentation.
21 *NB: the user manual has not been updated yet with all the changes made in version 4. Please consider it unreliable!*
23 *You are encouraged to look instead the code examples found in the demo/ directory*
27 If you are upgrading from version 3 or earlier you have two options:
29 1. adapt your code to the new API (all changes needed are described in [doc/api_changes_v4.md](doc/api_changes_v4.md))
31 2. use instead the *compatibility layer* which is provided. Instructions and pitfalls described in [doc/api_changes_v4.md](doc/api_changes_v4.md##enabling-compatibility-with-legacy-code)
33 In any case, read carefully the docs in [doc/api_changes_v4.md](doc/api_changes_v4.md) and report back any undocumented
39 The recommended way to run the library test suite is via the provided Docker containers.
40 A handy shell script is available that simplifies usage of Docker.
42 The full sequence of operations is:
44 ./tests/ci/vm.sh build
45 ./tests/ci/vm.sh start
46 ./tests/ci/vm.sh runtests
49 # and, once you have finished all testing related work:
50 ./tests/ci/vm.sh cleanup
52 By default tests are run using php 7.2 in a Container based on Ubuntu 18 Bionic.
53 You can change the version of PHP and Ubuntu in use by setting the environment variables PHP_VERSION and UBUNTU_VERSION
54 before building the Container.
56 To generate the code-coverage report, run `./tests/ci/vm.sh runcoverage`
60 Use of this software is subject to the terms in the [license.txt](license.txt) file
63 [![License](https://poser.pugx.org/phpxmlrpc/phpxmlrpc/license)](https://packagist.org/packages/phpxmlrpc/phpxmlrpc)
64 [![Latest Stable Version](https://poser.pugx.org/phpxmlrpc/phpxmlrpc/v/stable)](https://packagist.org/packages/phpxmlrpc/phpxmlrpc)
65 [![Total Downloads](https://poser.pugx.org/phpxmlrpc/phpxmlrpc/downloads)](https://packagist.org/packages/phpxmlrpc/phpxmlrpc)
67 [![Build Status](https://github.com/gggeek/phpxmlrpc/actions/workflows/ci.yml/badge.svg)](https://github.com/gggeek/phpxmlrpc/actions/workflows/ci.yml)
68 [![Code Coverage](https://scrutinizer-ci.com/g/gggeek/phpxmlrpc/badges/coverage.png)](https://scrutinizer-ci.com/g/gggeek/phpxmlrpc)