3. Open a terminal and use Composer to grab the library.
- $ composer require phpxmlrpc/phpxmlrpc:^4
+ $ composer require phpxmlrpc/phpxmlrpc:^4.9
4. Write your code.
Once Composer has downloaded the component(s), all you need to do is include the vendor/autoload.php file that
$client = new Client('http://some/server');
$response = $client->send(new Request('method', array(new Value('parameter'))));
- 5. IMPORTANT! Make sure that the vendor/phpxmlrpc directory is not directly accessible from the internet,
+ 4. IMPORTANT! Make sure that the phpxmlrpc directory is not directly accessible from the internet,
as leaving it open to access means that any visitor can trigger execution of php code such as
the built-in debugger.
Tips
----
-Please note that usage of the 'pake' command is not required for installation of the library.
-At this moment it is only useful to build the html and pdf versions of the documentation, and the tarballs
-for distribution of the library.
+* Please note that usage of the 'pake' command is not required for installation of the library.
+ At this moment it is only useful to build the html and pdf versions of the documentation.
= XML-RPC for PHP
-:revision: 4.0.0
+:revision: 4.9.2
:keywords: xmlrpc, xml, rpc, webservices, http
:toc: left
:imagesdir: images
passing of timezone specifiers in ISO8601 format dates. You can, however, use the PhpXmlRpc\Helper\Date class to do
the encoding and decoding for you.
-Very little HTTP response checking is performed (e.g. HTTP redirects are not followed and the Content-Length HTTP
- header, mandated by the xml-rpc spec, is not validated); cookie support still involves quite a bit of coding on the
- part of the user.
+Very little HTTP response checking is performed (e.g. HTTP redirects are not followed by default and the Content-Length
+ HTTP header, mandated by the xml-rpc spec, is not validated); cookie support still involves quite a bit of coding on
+ the part of the user.
[[support]]
===== int
-The type i4 is accepted as a synonym
- for int when creating xmlrpcval objects. The
- xml parsing code will always convert i4 to
- int: int is regarded
- by this implementation as the canonical name for this type.
+The type i4 is accepted as a synonym for int when creating xmlrpcval objects. The xml parsing code will always convert i4
+ to int: int is regarded by this implementation as the canonical name for this type.
-The type i8 on the other hand is considered as a separate type.
- Note that the library will never output integers as 'i8' on its own,
- even when php is compiled in 64-bit mode.
+The type i8 on the other hand is considered as a separate type. Note that the library will never output integers as 'i8'
+ on its own, even when php is compiled in 64-bit mode.
===== base64
[[xmlrpcval-creation]]
==== Xmlrpcval creation
-The constructor is the normal way to create an
- xmlrpcval. The constructor can take these
- forms:
+The constructor is the normal way to create an xmlrpcval. The constructor can take these forms:
xmlrpcvalnew
xmlrpcval xmlrpcvalnew
[appendix]
== Usage of the debugger
-A webservice debugger is included in the library to help during
- development and testing.
+A webservice debugger is included in the library to help during development and testing.
-The interface should be self-explicative enough to need little
- documentation.
+The interface should be self-explicative enough to need little documentation.
image::debugger.gif[,,,,align="center"]
-The most useful feature of the debugger is without doubt the "Show
- debug info" option. It allows to have a screen dump of the complete http
- communication between client and server, including the http headers as
- well as the request and response payloads, and is invaluable when
- troubleshooting problems with charset encoding, authentication or http
+The most useful feature of the debugger is without doubt the "Show debug info" option. It allows to have a screen dump
+ of the complete http communication between client and server, including the http headers as well as the request and
+ response payloads, and is invaluable when troubleshooting problems with charset encoding, authentication or http
compression.
-The debugger can take advantage of the JSONRPC library extension, to
- allow debugging of JSON-RPC webservices, and of the JS-XMLRPC library
- visual editor to allow easy mouse-driven construction of the payload for
- remote methods. Both components have to be downloaded separately from the
- sourceforge.net web pages and copied to the debugger directory to enable
- the extra functionality:
+The debugger can take advantage of the JSONRPC library extension, to allow debugging of JSON-RPC webservices, and of the
+ JSXMLRPC library visual editor to allow easy mouse-driven construction of the payload for remote methods. Both
+ components have to be downloaded separately and copied to the debugger directory to enable the extra functionality:
-* to enable jsonrpc functionality, download the PHP-XMLRPC
- EXTRAS package, and copy the file __jsonrpc.inc__
- either to the same directory as the debugger or somewhere in your
- php include path
+* to enable jsonrpc functionality, download the PHP-XMLRPC EXTRAS package, and copy the file __jsonrpc.inc__
+ either to the same directory as the debugger or somewhere in your php include path
-* to enable the visual value editing dialog, download the
- JS-XMLRPC library, and copy somewhere in the web root files
+* to enable the visual value editing dialog, download the JS-XMLRPC library, and copy somewhere in the web root files
__visualeditor.php__,
__visualeditor.css__ and the folders
__yui__ and __img__. Then edit the
* Allow a server to NOT respond to system.* method calls (setting the `$server->allow_system_funcs` property).
* Implement a new xmlrpcval method to determine if a value of type struct has a member of a given name without having to
- loop trough all members: `xmlrpcval::structMemExists()`
+ loop through all members: `xmlrpcval::structMemExists()`
* Expand methods `xmlrpcval::addArray`, `addScalar` and `addStruct` allowing extra php values to be added to
xmlrpcval objects already formed.
git://git.onelab.eu / plcapi.git / commitdiff