X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=INSTALL.md;h=f78f8f0ee925c3b90d63893f54f30cf9a48c3586;hb=640b8c0e60bb8a13dde241ec4d23ca1f58bb5b8a;hp=19d96abc4918ab7bd85cfc71bbcedd8c3c3041d5;hpb=8ef5517baf3fd7da0dd84bb3f0f7525d93567103;p=plcapi.git diff --git a/INSTALL.md b/INSTALL.md index 19d96ab..f78f8f0 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,4 +1,5 @@ XMLRPC for PHP +============== Requirements ------------ @@ -19,19 +20,19 @@ Installation instructions Installation of the library is quite easy: -1. Via Composer (highly recommended): +1. Via Composer (highly recommended): - 1. Install composer if you don't have it already present on your system. + 1. Install composer if you don't have it already present on your system. Depending on how you install, you may end up with a composer.phar file in your directory. In that case, no worries! Just substitute 'php composer.phar' for 'composer' in the commands below. - 2. If you're creating a new project, create a new empty directory for it. + 2. If you're creating a new project, create a new empty directory for it. - 3. Open a terminal and use Composer to grab the library. + 3. Open a terminal and use Composer to grab the library. $ composer require phpxmlrpc/phpxmlrpc:4.0 - 4. Write your code. + 4. Write your code. Once Composer has downloaded the component(s), all you need to do is include the vendor/autoload.php file that was generated by Composer. This file takes care of autoloading all of the libraries so that you can use them immediately, including phpxmlrpc: @@ -48,21 +49,21 @@ Installation of the library is quite easy: $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, + 5. IMPORTANT! Make sure that the vendor/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. -2. Via manual download and autoload configuration +2. Via manual download and autoload configuration - 1. copy the contents of the src/ folder to any location required by your + 1. copy the contents of the src/ folder to any location required by your application (it can be inside the web server root or not). - 2. configure your app autoloading mechanism so that all classes in the PhpXmlRpc namespace are loaded + 2. configure your app autoloading mechanism so that all classes in the PhpXmlRpc namespace are loaded from that location: any PSR-4 compliant autoloader can do that, if you don't have any there is one available in src/Autoloader.php - 3. Write your code. + 3. Write your code. // File example: script.php @@ -75,11 +76,13 @@ Installation of the library is quite easy: $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, + 5. IMPORTANT! Make sure that the vendor/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 'make' command for installation of the library is -not recommended, as it will generally involve editing of the makefile for a -successful run. +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.