Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gggeek/polyfill-xmlrpc
Provides emulation of the native XML-RPC extension for PHP
https://github.com/gggeek/polyfill-xmlrpc
php xmlrpc
Last synced: 12 days ago
JSON representation
Provides emulation of the native XML-RPC extension for PHP
- Host: GitHub
- URL: https://github.com/gggeek/polyfill-xmlrpc
- Owner: gggeek
- License: other
- Created: 2020-12-23T16:11:00.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-03-06T17:53:21.000Z (8 months ago)
- Last Synced: 2024-04-06T01:01:21.967Z (7 months ago)
- Topics: php, xmlrpc
- Language: PHP
- Homepage:
- Size: 146 KB
- Stars: 6
- Watchers: 2
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: license.txt
Awesome Lists containing this project
README
Polyfill-XMLRPC
===============
A pure-php reimplementation of the API exposed by the native XML-RPC extension.
Originally bundled as part of the [phpxmlrpc/extras](https://github.com/gggeek/phpxmlrpc-extras) package.
Requirements
------------
Any PHP version from 5.4 to 8.3 is supported.
The `phpxmlrpc/phpxmlrpc` library is used as the underlying XML-RPC engine. It will get automatically pulled in for you
when you install via Composer.
Installation and usage
----------------------
Installation: the recommended way to install this library is via usage of Composer. Just add
"phpxmlrpc/polyfill-xmlrpc": "^1.0.0"
to your Composer "require" section.
Usage: once your autoload configuration is set up properly (which is normally taken care for you by Composer), you
can just use in your code all the functions described at https://www.php.net/manual/en/ref.xmlrpc.php
Known differences from the original extension
---------------------------------------------
### Work in Progress!
This library is not _fully_ complete yet, but it should be good enough for most users.
The main features missing are:
- character set handling: at the moment only utf-8 and iso-8859-1 charset encodings are supported; iso-8859-1 as default,
and utf-8 via:
- using the `$encoding` argument to `xmlrpc_decode()` and `xmlrpc_decode_request()`
- setting `'encoding' => 'UTF-8'` and `'escaping' => 'markup'` in the `$options` argument to `xmlrpc_encode_request`
- the `xmlrpc_parse_method_descriptions` and `xmlrpc_server_register_introspection_callback` functions exist but do nothing
- the `xmlrpc_encode_request` function has partial support for the `$options` argument
For a detailed list of all known differences compared to the behaviour of the PHP extension, see comments at the top of
file [XmlRpc.php](src/XmlRpc.php).
### Compatibility goals
We strive to reproduce the same behaviour as the XML-RPC extension to the best "reasonable" extent.
This means that the following are _not_ goals of this package:
- being able to produce the same xml streams as the native extension, where "same" means byte-by-byte identical.
Eg. whitespace and element indentation in the produced xml strings do differ
- reproducing behaviour of the native extension which is clearly buggy
Eg. the native extension will produce invalid xmlrpc requests when some specific values are passed to an
`xmlrpc_encode_request` call
Running tests
-------------
The recommended way to run the library test suite is via the provided Docker containers.
A handy shell script is available that simplifies usage of Docker.
The full sequence of operations is:
./tests/ci/vm.sh build
./tests/ci/vm.sh start
./tests/ci/vm.sh runtests
./tests/ci/vm.sh stop
# and, once you have finished all testing related work:
./tests/ci/vm.sh cleanup
By default, tests are run using php 7.4 in a Container based on Ubuntu 20 Focal.
You can change the version of PHP and Ubuntu in use by setting the environment variables PHP_VERSION and UBUNTU_VERSION
before building the Container.
To generate the code-coverage report, run `./tests/ci/vm.sh runcoverage`
FAQ
---
Q: is it possible to specify the precision used to serialize Double values?
A: yes, by setting a positive integer value to `\PhpXmlRpc\Polyfill\XmlRpc\XmlRpc::$xmlpc_double_precision`
License
-------
Use of this software is subject to the terms in the [license.txt](license.txt) file
[](https://packagist.org/packages/phpxmlrpc/polyfill-xmlrpc)
[](https://packagist.org/packages/phpxmlrpc/polyfill-xmlrpc)
[](https://packagist.org/packages/phpxmlrpc/polyfill-xmlrpc)
[](https://github.com/gggeek/polyfill-xmlrpc/actions/workflows/ci.yml)
[](https://app.codecov.io/gh/gggeek/polyfill-xmlrpc)