From 2d5b6d9bbd3e67610bcc5b048ea0f3b7b198587d Mon Sep 17 00:00:00 2001 From: gggeek Date: Mon, 9 Jan 2023 12:31:01 +0000 Subject: [PATCH] docs --- NEWS.md | 4 ++-- README.md | 12 ++++++------ doc/manual/phpxmlrpc_manual.adoc | 7 +++++-- 3 files changed, 13 insertions(+), 10 deletions(-) diff --git a/NEWS.md b/NEWS.md index fceec593..5b1c5941 100644 --- a/NEWS.md +++ b/NEWS.md @@ -3,10 +3,10 @@ * improved: revised all demo files. Showcase more features in client demos; isolate better testsuite functions in server demos and make sure they are not active unless triggered by running the tests -* improved: catch php Errors besides Exceptions thrown by method handler functions (ie. server-side) for php 7 and up +* improved: for php 7 and up, catch php Errors besides Exceptions thrown by method handler functions (ie. server-side) * fixed: when using the Exception or Error thrown by a method handler function to build the xml-rpc response, override - fault Code 0, as it makes responses unserializable + fault Code 0, as it breaks response serialization ## XML-RPC for PHP version 4.9.4 - 2023-1-7 diff --git a/README.md b/README.md index 4fdb7ef7..a8299e43 100644 --- a/README.md +++ b/README.md @@ -14,15 +14,15 @@ 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, including information about online resources such as debuggers -and demo servers. +library main features and all project related information, including information about online resources such as +debuggers and demo servers. The user manual can be found in the doc/manual directory: [phpxmlrpc_manual.adoc](doc/manual/phpxmlrpc_manual.adoc). It includes sections about upgrading from previous versions as well as running the library's testing suite and bundled debugger. The manual is formatted as an asciidoc file - if viewing it locally, it is recommended to either use an IDE which can -natively render asciidoc, or view it as html via in-browser rendering by serving it via a webserver and accessing +natively render asciidoc, or view it as html with a browser by serving it via a webserver and accessing /doc/manual/index.html 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,9 +31,9 @@ You are encouraged to look also at the code examples found in the demo/ director Note: to reduce the size of the download, the demo files are not part of the default package installed with Composer. You can either check them out online at https://github.com/gggeek/phpxmlrpc/tree/master/demo, download them as a separate -tarball at https://github.com/gggeek/phpxmlrpc/releases or make sure they are available locally, by installing the library -using Composer option `--prefer-install=source`. Whatever the method chosen, make sure that the demo folder is not directly -accessible from the internet, ie. it is not within the webserver root directory). +tarball from https://github.com/gggeek/phpxmlrpc/releases or make sure they are available locally by installing the +library using Composer option `--prefer-install=source`. Whatever the method chosen, make sure that the demo folder is +not directly accessible from the internet, i.e. it is not within the webserver root directory). License ------- diff --git a/doc/manual/phpxmlrpc_manual.adoc b/doc/manual/phpxmlrpc_manual.adoc index 5c34bf1e..fd554b41 100644 --- a/doc/manual/phpxmlrpc_manual.adoc +++ b/doc/manual/phpxmlrpc_manual.adoc @@ -1546,8 +1546,8 @@ if (!$resp->faultCode()) Note that this will not be 100% accurate, since the xml generated by the response object can be different from the xml received, especially if there is some character set conversion involved, or such (e.g. if you receive an empty string tag -as "", `serialize()` will output ""), or if the server sent back as response something invalid (in -which case the xml generated client side using serialize() will correspond to the error response generated +as "", `serialize()` will output ""), or if the server sent back as response something invalid +(in which case the xml generated client side using serialize() will correspond to the error response generated internally by the lib). 3 - set the client object to return the raw xml received instead of the decoded objects: @@ -1603,6 +1603,9 @@ assumed character set are used. The second method has the added benefits of work encoding used for the xml to be transmitted, and preserving exactly whitespace, whilst incurring in some extra message length and cpu load (for carrying out the base64 encoding/decoding). +See the example given in __demo/client/which.php__ for the possibility of sending "standard xml-rpc" xml which was +generated outside the phpxmlrpc library. + === My server (client) returns an error whenever the client (server) returns accented characters To be documented... -- 2.47.0