Updated examples

Author: johnstevenson

Diff for: README.md

@@ -50,6 +50,8 @@ Alternatively, you can [download][download] and extract it, or clone this repo.
 ## Usage
 If you downloaded the library through `composer` then everything is ready to run, otherwise you must point a `PSR-0` autoloader to the `src` directory so that the classes are automatically included.
 
+If you just want to have a quick play, point your browser to `example/client.php` and everything will run automatically.
+
 ## Client usage
 Firstly you need to instantiate a `JsonRpc\Client`. You do this by giving it the url you want to send your requests to:
 
@@ -64,7 +66,7 @@ Next you send your request by using the `$client->call` function. This takes the
 $success = $client->call('method', array($param1, $param2));
 ```
 
-The function returns true or false. If **true** then the result of the method will be in the `$client->result` property. The type of the result depends on what has been returned by the server, so it could be a scalar, an indexed array, an object `stdClass` or null.
+The function returns true or false. If **true** then the result of the method will be in the `$client->result` property. The type of the result depends on what has been returned by the server, so it could be a scalar, an indexed array, an object `stdClass`, or null.
 
 If **false** then an error has occured, either in sending or processing the request. This is reported in the `$client->error` property, which is a string. Putting it all together:
 

Diff for: example/README.md

@@ -1,3 +1,5 @@
-#Example
+# Example
 
-Run `client.php` in your browser, which communicates with `server.php` in the same directory. Experiment by uncommenting the `/*..*/` blocks to get different results.
+Run `client.php` in your browser, which communicates with `server.php` in the same directory. Experiment by uncommenting the `/*..*/` blocks to send Notify and Batch requests.
+
+Note that all required classes are automatically loaded.

Diff for: example/ServerMethods.php

@@ -4,8 +4,8 @@
   ini_set('default_charset', 'UTF-8');
   ini_set('display_errors', '1');
 
-  # autoload for the example directory
-  require('autoload.php');
+  # bootstrap for the example directory
+  require('bootstrap.php');
 
   # get the url of the server script
   $url = getServerUrl();
@@ -15,70 +15,49 @@
 
   # set up our rpc call with a method and params
   $method = 'divide';
-  $params1 = array(42, 6);
+  $params = array(42, 6);
 
-  $params2 = new stdClass();
-  $params2->dividend = 42;
-  $params2->divisor = 6;
+  $success = false;
 
-  $params3 = new stdClass();
-  $params3->divisor = 6;
-  $params3->dividend = 42;
-
-  $params4 = new stdClass();
-  $params4->int = true;
-  $params4->dividend = 23;
-  $params4->divisor = 6;
-
-  //$param1 = 'Hello';
-
-  //$param2 = new \stdClass();
-  //$param2->name = 'Client';
-
-  $res = $Client->call($method, $params4);
+  $success = $Client->call($method, $params);
 
   /*
   # notify
-  $res = $Client->notify($method);
+  $success = $Client->notify($method);
   */
 
   /*
   # batch sending
   $Client->batchOpen();
-  $Client->call($method, array($param1, $param2));
-  $Client->notify($method, array($param1));
-  $Client->call($method, array($param1, $param2));
-  $Client->notify($method, array($param1, $param2));
-  $Client->call($method, $param2);
-  $res = $Client->batchSend();
+  $Client->call($method, $params);
+  $Client->notify($method, $params);
+  $Client->call($method, $params);
+  $Client->notify($method, $params);
+  $Client->call($method, $params);
+  $success = $Client->batchSend();
   */
 
   echo '<form method="GET">';
-  echo '<input type="submit" value="Run Example">';
+  echo '<input type="submit" value="Run Example"> Last run: ' . date(DATE_RFC822);
   echo '</form>';
   echo '<pre>';
 
   echo '<b>return:</b> ';
-  echo $res ? 'true' : 'false';
+  echo $success ? 'true' : 'false';
   echo '<br /><br />';
 
-  if (!$res)
+  if (!$success)
   {
-    echo '<b>fault:</b> ', $Client->fault;
+    echo '<b>error:</b> ', $Client->error;
     echo '<br /><br />';
   }
 
-  if ($Client->error)
-  {
-    echo '<b>error:</b> ', print_r($Client->error, 1);
-    echo '<br /><br />';
-  }
-  elseif ($Client->batch)
+  if ($Client->batch)
   {
     echo '<b>batch:</b> ', print_r($Client->batch, 1);
     echo '<br /><br />';
   }
-  else
+  elseif ($Client->result)
   {
     echo '<b>result:</b> ', print_r($Client->result, 1);
     echo '<br /><br />';

Diff for: example/autoload.php renamed to example/bootstrap.php

@@ -6,19 +6,46 @@
   # we don't want any PHP errors being output
   ini_set('display_errors', '0');
 
-  # so we will log them. Exception will be logged as well
+  # so we will log them. Exceptions will be logged as well
   ini_set('log_errors', '1');
   ini_set('error_log', 'server-errors.log');
 
-  # autoload for the example directory
-  require('autoload.php');
+  # bootstrap for the example directory
+  require('bootstrap.php');
 
   # set up our method handler class
-  require('ServerMethods.php');
   $methods = new ServerMethods();
 
   # create our server object, passing it the method handler class
   $Server = new JsonRpc\Server($methods);
 
   # and tell the server to do its stuff
   $Server->receive();
+
+
+
+/**
+* Our methods class
+*/
+class ServerMethods
+{
+
+  public $error = null;
+
+
+  public function divide($dividend, $divisor, $int = false)
+  {
+
+    if (!$divisor)
+    {
+      $this->error = 'Cannot divide by zero';
+    }
+    else
+    {
+      $quotient = $dividend / $divisor;
+      return $int ? (int) $quotient : $quotient;
+    }
+
+  }
+
+}