From: gggeek Date: Fri, 23 Dec 2022 18:08:04 +0000 (+0000) Subject: remove from the manual all dupe info; update docs X-Git-Tag: 4.9.4~47 X-Git-Url: http://git.onelab.eu/?a=commitdiff_plain;h=c32e95b2695acd52d71021e51b0bbe4a1c2df534;p=plcapi.git remove from the manual all dupe info; update docs --- diff --git a/INSTALL.md b/INSTALL.md index 0664ad1c..a0a2d944 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -52,7 +52,6 @@ Installation of the library is quite easy: as leaving it open to access means that any visitor can trigger execution of php code such as the built-in debugger. - 2. Via manual download and autoload configuration 1. copy the contents of the src/ folder to any location required by your diff --git a/NEWS.md b/NEWS.md index af87b804..3aee8194 100644 --- a/NEWS.md +++ b/NEWS.md @@ -340,7 +340,7 @@ * improved: all of the API documentation has been moved out of the manual and into the source code phpdoc comments * fixed: when the internal character set is set to UTF-8 and the client sends requests (or the server responses), too - many characters were encoded as numeric entities, whereas some, like åäö, needed not not be + many characters were encoded as numeric entities, whereas some, like åäö, needed not to be * fixed: the 'valtyp' property of Response was not present in all cases; the ValType property had been added by error and has been removed @@ -353,8 +353,7 @@ This release does away with the past and starts a transition to modern-world php Code has been heavily refactored, taking care to preserve backwards compatibility as much as possible, but some breackage is to be expected. -The minimum required php version has been increased to 5.3, even though we strongly urge you to use -more recent versions. +The minimum required php version has been increased to 5.3, even though we strongly urge you to use more recent versions. PLEASE READ CAREFULLY THE NOTES BELOW to insure a smooth upgrade. @@ -461,12 +460,10 @@ See the Changelog file or the pdf docs for a complete list of changes. ## XML-RPC for PHP version 3.0.0 beta - 2009/09/05 This is the first release of the library to only support PHP 5. -Some legacy code has been removed, and support for features such as exceptions -and dateTime objects introduced. +Some legacy code has been removed, and support for features such as exceptions and dateTime objects introduced. -The "beta" tag is meant to indicate the fact that the refactoring has been more widespread -than in precedent releases and that more changes are likely to be introduced with time - -the library is still considered to be production quality. +The "beta" tag is meant to indicate the fact that the refactoring has been more widespread than in precedent releases +and that more changes are likely to be introduced with time - the library is still considered to be production quality. * improved: removed all usage of php functions deprecated in php 5.3, usage of assign-by-ref when creating new objects etc... @@ -487,10 +484,9 @@ the library is still considered to be production quality. ## XML-RPC for PHP version 2.2.2 - 2009/03/16 -This release corrects all bugs that have been reported and successfully reproduced since -version 2.2.1. -Regardless of the intimidating message about dropping PHP 4 support, it still does -support that ancient, broken and insecure platform. +This release corrects all bugs that have been reported and successfully reproduced since version 2.2.1. +Regardless of the intimidating message about dropping PHP 4 support, it still does support that ancient, broken and +insecure platform. * fixed: php warning when receiving 'false' in a bool value * fixed: improve robustness of the debugger when parsing weird results from non-compliant servers @@ -530,8 +526,8 @@ This release corrects a couple of bugs and adds a few minor features. * fixed: wrap_xmlrpc_method() generated code failed to properly encode php objects * improved: slightly faster encoding of data which is internally UTF-8 * improved: debugger always generates a 'null' id for jsonrpc if user omits it -* new: debugger can take advantage of a graphical value builder - (it has to be downloaded separately, as part of jsxmlrpc package) +* new: debugger can take advantage of a graphical value builder (it has to be downloaded separately, as part of + jsxmlrpc package) * new: support for the xmlrpc extension * new: server support for the system.getCapabilities xmlrpc extension * new: wrap_xmlrpc_method() accepts two new options: debug and return_on_fault @@ -749,6 +745,12 @@ included documentation, or, even better, take a look at the source code, which is commented in javadoc style quite a bit. +## XML-RPC for PHP version 1.2.1 - 2005/09 + +This release restores compatibility with PHP3, which had been broken in release 1.2. +The only other changes are some minor documentation updates and removal of unused +files that had been erroneously packed in 1.2. + ## XML-RPC for PHP version 1.2 - 2005/08/14 This removes all use of eval(), which is a potential security problem. diff --git a/README.md b/README.md index 8c1e6f6d..e27fc973 100644 --- a/README.md +++ b/README.md @@ -2,21 +2,21 @@ XMLRPC for PHP ============== A php library for building xml-rpc clients and servers. -Installation ------------- +Requirements and Installation +----------------------------- The recommended way to install this library is using Composer. Detailed installation instructions are in the [INSTALL.md](INSTALL.md) file, along with system requirements listing. Documentation ------------- - See the documentation page at [gggeek.github.io/phpxmlrpc](https://gggeek.github.io/phpxmlrpc) for a list of the library main features and all project related information. -The user manual can be found in the doc/manual directory, in AsciiDoc format: [phpxmlrpc_manual.adoc](doc/manual/phpxmlrpc_manual.adoc) +The user manual can be found in the doc/manual directory: [phpxmlrpc_manual.adoc](doc/manual/phpxmlrpc_manual.adoc) -Older release tarballs also contain HTML and PDF versions of the manual, as well as an automatically generated API documentation. +Older release tarballs also contain HTML and PDF versions of the manual, as well as an automatically generated API +documentation. The documentation for the API is currently available online at [http://gggeek.github.io/phpxmlrpc/doc-4/api/index.html](http://gggeek.github.io/phpxmlrpc/doc-4/api/index.html) *NB: the user manual has not been updated yet with all the changes made in version 4. Please consider it unreliable!* diff --git a/doc/manual/images/progxmlrpc.s.gif b/doc/manual/images/progxmlrpc.s.gif deleted file mode 100644 index d1dcea5d..00000000 Binary files a/doc/manual/images/progxmlrpc.s.gif and /dev/null differ diff --git a/doc/manual/index.html b/doc/manual/index.html index 8abeb3d5..9695b973 100644 --- a/doc/manual/index.html +++ b/doc/manual/index.html @@ -5,12 +5,22 @@ +

XML-RPC for PHP

diff --git a/doc/manual/phpxmlrpc_manual.adoc b/doc/manual/phpxmlrpc_manual.adoc index 877f8507..07428a8d 100644 --- a/doc/manual/phpxmlrpc_manual.adoc +++ b/doc/manual/phpxmlrpc_manual.adoc @@ -1,126 +1,11 @@ -= XML-RPC for PHP -:revision: 4.9.23 += XML-RPC for PHP User Manual +:revision: 4.9.3 :keywords: xmlrpc, xml, rpc, webservices, http :toc: left :imagesdir: images :source-highlighter: highlightjs -[preface] -== Introduction - -This collection of PHP classes provides a framework for writing XML-RPC clients and servers in PHP. - -Main goals of the project are ease of use, flexibility and completeness. - -The original author is Edd Dumbill of http://usefulinc.com/[Useful Information Company]. As of the 1.0 stable -release, the project was opened to wider involvement and moved to https://sourceforge.net/projects/phpxmlrpc/[SourceForge]; -later, to https://github.com/gggeek/phpxmlrpc[Github] - -XML-RPC is a format devised by http://www.userland.com[Userland Software] for achieving remote procedure call -via XML using HTTP as the transport. XML-RPC has its own web site, http://xmlrpc.com - -=== Acknowledgements - -Daniel E. Baumann - -James Bercegay - -Leon Blackwell - -Stephane Bortzmeyer - -Daniel Convissor - -Geoffrey T. Dairiki - -Stefan Esser - -James Flemer - -Ernst de Haan - -Tom Knight - -Axel Kollmorgen - -Peter Kocks - -Daniel Krippner - -S . Kuip - -A . Lambert - -Frederic Lecointre - -Dan Libby - -Arnaud Limbourg - -Ernest MacDougal Campbell III - -Lukasz Mach - -Kjartan Mannes - -Ben Margolin - -Nicolay Mausz - -Justin Miller - -Jan Pfeifer - -Giancarlo Pinerolo - -Peter Russel - -Jean-Jacques Sarton - -Viliam Simko - -Idan Sofer - -Douglas Squirrel - -Heiko Stübner - -Anatoly Techtonik - -Tommaso Trani - -Eric van der Vlist - -Christian Wenz - -Jim Winstead - -Przemyslaw Wroblewski - -Bruno Zanetti Melotti - -And all the contributors listed on https://github.com/gggeek/phpxmlrpc/graphs/contributors[Github] - - -[[requirements]] -== System Requirements - -The library has been designed with goals of flexibility and backward compatibility. As such, it supports a wide range of -PHP installs. Note that not all features of the lib are available in every configuration. - -The __minimum supported__ PHP version is 5.3. - -If you wish to use HTTPS, HTTP 1.1 or HTTP2 to communicate with remote servers, or to use NTLM authentication, you need -the *curl* extension compiled into your PHP installation. - -If you wish to receive XML-RPC requests or responses in any other character set than US-ASCII, ISO-8859-1 or UTF-8, you -will need the *mbstring* extension compiled into your PHP installation. - -The *xmlrpc* native extension is not required to be compiled into your PHP installation, but if it is, there will be no -interference with the operation of this library. - - [[manifest]] == Files in the distribution @@ -139,12 +24,6 @@ src/*:: the XML-RPC library classes. You can autoload these via Composer, or via tests/*:: the test suite for the library, written using PhpUnit, and the configuration to run it either on GitHub Actions or in a local Docker container -[[bugs]] -== Known Bugs - -Known bugs are tracked using the https://github.com/gggeek/phpxmlrpc/issues[GitHub issue tracker] - - [[limitations]] == Known limitations @@ -167,43 +46,6 @@ the part of the user. Extensions to the XMLRPC protocol, such as the `++` tag, have to be manually enabled before usage. -[[news]] -== What's new - -The list of changes is available online at https://github.com/gggeek/phpxmlrpc/blob/master/NEWS.md. -The detailed changelog is available on GitHub: https://github.com/gggeek/phpxmlrpc/commits[changes from the git era], -https://github.com/gggeek/phpxmlrpc/blob/master/doc/ChangeLog[changes from the SourceForge era]. - - -[[support]] -== Support - -=== Online Support - -XML-RPC for PHP is offered "as-is" without any warranty or commitment to support. However, informal advice and help is -available via the XML-RPC for PHP website and mailing list. - -* The __XML-RPC for PHP__ development is hosted at https://github.com/gggeek/phpxmlrpc[github.com/gggeek/phpxmlrpc]. - Bugs, feature requests and patches can be posted to the https://github.com/gggeek/phpxmlrpc/issues[project's website]. - -* The __PHP XML-RPC interest mailing list__ is run by the original author. More details can be found - https://lists.usefulinc.com/cgi-bin/mailman/listinfo/phpxmlrpc[here]. - -[[jellyfish]] -=== The Jellyfish Book - -image::progxmlrpc.s.gif[The Jellyfish Book] -Together with Simon St.Laurent and Joe Johnston, Edd Dumbill wrote a book on XML-RPC for O'Reilly and Associates on -XML-RPC. It features a rather fetching jellyfish on the cover. - -Complete details of the book are available from https://www.oreilly.com/library/view/programming-web-services/0596001193/[O'Reilly's web site]. - -Edd is responsible for the chapter on PHP, which includes a worked example of creating a forum server, and hooking it up -the (now discontinued) O'Reilly's Meerkat service in order to allow commenting on news stories from around the Web. - -If you've benefited from the effort that has been put into writing this software, then please consider buying the book! - - [[apidocs]] == API documentation