Skip to content

Commit bb5bf03

Browse files
committed
docs
1 parent f77b3cd commit bb5bf03

File tree

2 files changed

+25
-42
lines changed

2 files changed

+25
-42
lines changed

INSTALL.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Installation of the library is quite easy:
2929

3030
3. Open a terminal and use Composer to grab the library.
3131

32-
$ composer require phpxmlrpc/phpxmlrpc:^4
32+
$ composer require phpxmlrpc/phpxmlrpc:^4.9
3333

3434
4. Write your code.
3535
Once Composer has downloaded the component(s), all you need to do is include the vendor/autoload.php file that
@@ -75,13 +75,12 @@ Installation of the library is quite easy:
7575
$client = new Client('http://some/server');
7676
$response = $client->send(new Request('method', array(new Value('parameter'))));
7777

78-
5. IMPORTANT! Make sure that the vendor/phpxmlrpc directory is not directly accessible from the internet,
78+
4. IMPORTANT! Make sure that the phpxmlrpc directory is not directly accessible from the internet,
7979
as leaving it open to access means that any visitor can trigger execution of php code such as
8080
the built-in debugger.
8181

8282
Tips
8383
----
8484

85-
Please note that usage of the 'pake' command is not required for installation of the library.
86-
At this moment it is only useful to build the html and pdf versions of the documentation, and the tarballs
87-
for distribution of the library.
85+
* Please note that usage of the 'pake' command is not required for installation of the library.
86+
At this moment it is only useful to build the html and pdf versions of the documentation.

doc/manual/phpxmlrpc_manual.adoc

Lines changed: 21 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
= XML-RPC for PHP
2-
:revision: 4.0.0
2+
:revision: 4.9.2
33
:keywords: xmlrpc, xml, rpc, webservices, http
44
:toc: left
55
:imagesdir: images
@@ -158,9 +158,9 @@ dateTime.iso8601 is supported opaquely. It can't be done natively as the XML-RPC
158158
passing of timezone specifiers in ISO8601 format dates. You can, however, use the PhpXmlRpc\Helper\Date class to do
159159
the encoding and decoding for you.
160160

161-
Very little HTTP response checking is performed (e.g. HTTP redirects are not followed and the Content-Length HTTP
162-
header, mandated by the xml-rpc spec, is not validated); cookie support still involves quite a bit of coding on the
163-
part of the user.
161+
Very little HTTP response checking is performed (e.g. HTTP redirects are not followed by default and the Content-Length
162+
HTTP header, mandated by the xml-rpc spec, is not validated); cookie support still involves quite a bit of coding on
163+
the part of the user.
164164

165165

166166
[[support]]
@@ -202,15 +202,11 @@ If you've benefited from the effort that has been put into writing this software
202202

203203
===== int
204204

205-
The type i4 is accepted as a synonym
206-
for int when creating xmlrpcval objects. The
207-
xml parsing code will always convert i4 to
208-
int: int is regarded
209-
by this implementation as the canonical name for this type.
205+
The type i4 is accepted as a synonym for int when creating xmlrpcval objects. The xml parsing code will always convert i4
206+
to int: int is regarded by this implementation as the canonical name for this type.
210207

211-
The type i8 on the other hand is considered as a separate type.
212-
Note that the library will never output integers as 'i8' on its own,
213-
even when php is compiled in 64-bit mode.
208+
The type i8 on the other hand is considered as a separate type. Note that the library will never output integers as 'i8'
209+
on its own, even when php is compiled in 64-bit mode.
214210

215211
===== base64
216212

@@ -249,9 +245,7 @@ There is no support for encoding ++null++
249245
[[xmlrpcval-creation]]
250246
==== Xmlrpcval creation
251247

252-
The constructor is the normal way to create an
253-
xmlrpcval. The constructor can take these
254-
forms:
248+
The constructor is the normal way to create an xmlrpcval. The constructor can take these forms:
255249

256250
xmlrpcvalnew
257251
xmlrpcval xmlrpcvalnew
@@ -1783,36 +1777,26 @@ In the meantime, see docs about xmlrpc_client::return_type and
17831777
[appendix]
17841778
== Usage of the debugger
17851779

1786-
A webservice debugger is included in the library to help during
1787-
development and testing.
1780+
A webservice debugger is included in the library to help during development and testing.
17881781

1789-
The interface should be self-explicative enough to need little
1790-
documentation.
1782+
The interface should be self-explicative enough to need little documentation.
17911783

17921784
image::debugger.gif[,,,,align="center"]
17931785

1794-
The most useful feature of the debugger is without doubt the "Show
1795-
debug info" option. It allows to have a screen dump of the complete http
1796-
communication between client and server, including the http headers as
1797-
well as the request and response payloads, and is invaluable when
1798-
troubleshooting problems with charset encoding, authentication or http
1786+
The most useful feature of the debugger is without doubt the "Show debug info" option. It allows to have a screen dump
1787+
of the complete http communication between client and server, including the http headers as well as the request and
1788+
response payloads, and is invaluable when troubleshooting problems with charset encoding, authentication or http
17991789
compression.
18001790

1801-
The debugger can take advantage of the JSONRPC library extension, to
1802-
allow debugging of JSON-RPC webservices, and of the JS-XMLRPC library
1803-
visual editor to allow easy mouse-driven construction of the payload for
1804-
remote methods. Both components have to be downloaded separately from the
1805-
sourceforge.net web pages and copied to the debugger directory to enable
1806-
the extra functionality:
1791+
The debugger can take advantage of the JSONRPC library extension, to allow debugging of JSON-RPC webservices, and of the
1792+
JSXMLRPC library visual editor to allow easy mouse-driven construction of the payload for remote methods. Both
1793+
components have to be downloaded separately and copied to the debugger directory to enable the extra functionality:
18071794

18081795

1809-
* to enable jsonrpc functionality, download the PHP-XMLRPC
1810-
EXTRAS package, and copy the file __jsonrpc.inc__
1811-
either to the same directory as the debugger or somewhere in your
1812-
php include path
1796+
* to enable jsonrpc functionality, download the PHP-XMLRPC EXTRAS package, and copy the file __jsonrpc.inc__
1797+
either to the same directory as the debugger or somewhere in your php include path
18131798

1814-
* to enable the visual value editing dialog, download the
1815-
JS-XMLRPC library, and copy somewhere in the web root files
1799+
* to enable the visual value editing dialog, download the JS-XMLRPC library, and copy somewhere in the web root files
18161800
__visualeditor.php__,
18171801
__visualeditor.css__ and the folders
18181802
__yui__ and __img__. Then edit the
@@ -2167,7 +2151,7 @@ Supported encodings are US-ASCII, UTF-8 and ISO-8859-1.
21672151
* Allow a server to NOT respond to system.* method calls (setting the `$server->allow_system_funcs` property).
21682152

21692153
* Implement a new xmlrpcval method to determine if a value of type struct has a member of a given name without having to
2170-
loop trough all members: `xmlrpcval::structMemExists()`
2154+
loop through all members: `xmlrpcval::structMemExists()`
21712155

21722156
* Expand methods `xmlrpcval::addArray`, `addScalar` and `addStruct` allowing extra php values to be added to
21732157
xmlrpcval objects already formed.

0 commit comments

Comments
 (0)