FORKED by cyking until commits are merged into source repo.
- option to use urlfetch in
Client.php
instead of curl. - option to auto-detect application output for an ['error'] array
- new exception class for custom application errors.
- Alternative server binding for 1 to 1 procedure to class method.
<?php
use JsonRPC\Client;
$client = new Client('http://localhost/server.php');
$client->use_curl = false;
$result = $client->execute('addition', [3, 5]);
var_dump($result);
server.php
<?php
require 'JsonRPC/Server.php';
use JsonRPC\Server;
$server = new Server;
// detect output for ['error'] arrray element
$server->detect_output_error = true;
// Procedures registration
$server->register('randomToTen', function ($start, $end)
{
if(intval($end) > 10)
{
$return['error'] = array();
$return['error']['code'] = 10;
$return['error']['message'] = 'must below 10';
$return['error']['data'] = 'end=' . $end;
return $return;
} // if
return mt_rand($start, $end);
});
// Return the response to the client
$result = $server->execute();
?>
client.php
<?php
require 'JsonRPC/Client.php';
use JsonRPC\Client;
$client = new Client('server.php');
// use urlfetch instead of curl.
$client->use_curl = false;
$result = '';
try
{
$result = $client->execute('randomToTen', [3, 15]);
} // try
catch (JsonRPC\CustomApplicationError $e)
{
echo 'Caught a Custom Application Error: <br /> <br />' . $e . '<br />';
echo 'CustomAppError: '. htmlspecialchars(json_encode($e->getCustomAppError())) . '<br />';
}
catch(Exception $e)
{
echo 'Caught an Exception Error: <br /> <br />' . $e . '<br />';
} // catch
echo $result;
?>
server2.php
<?php
require 'JsonRPC/Server.php';
use JsonRPC\Server;
$server = new Server;
// Procedures registration
$server->register('randomToTen', function ($start, $end)
{
if(intval($end) > 10)
{
$return['error'] = array();
$return['error']['code'] = 10;
$return['error']['message'] = 'must below 10';
$return['error']['data'] = 'end=' . $end;
throw new CustomApplicationError('Custom application error', intVal($error['code']), $error);
} // if
return mt_rand($start, $end);
});
// Return the response to the client
$result = $server->execute();
?>
client2.php
<?php
require 'JsonRPC/Client.php';
use JsonRPC\Client;
$client = new Client('server2.php');
// use urlfetch instead of curl.
$client->use_curl = false;
$result = '';
try
{
$result = $client->execute('randomToTen', [3, 15]);
} // try
catch (JsonRPC\CustomApplicationError $e)
{
echo 'Caught a Custom Application Error: <br /> <br />' . $e . '<br />';
echo 'CustomAppError: '. htmlspecialchars(json_encode($e->getCustomAppError())) . '<br />';
}
catch(Exception $e)
{
echo 'Caught an Exception Error: <br /> <br />' . $e . '<br />';
} // catch
echo $result;
?>
old way:
$server->bind('addition', 'MyMathClass', 'addition');
alternative way:
$server->bind('addition', 'MyMathClass');
A simple Json-RPC client/server that just works.
- JSON-RPC 2.0 protocol only
- The server support batch requests and notifications
- Authentication and IP based client restrictions
- Minimalist: there is only 2 files
- Fully unit tested
- License: Unlicense http://unlicense.org/
- The only dependency is the cURL extension
- PHP >= 5.3
composer require fguillot/json-rpc dev-master
Callback binding:
<?php
use JsonRPC\Server;
$server = new Server;
// Procedures registration
$server->register('addition', function ($a, $b) {
return $a + $b;
});
$server->register('random', function ($start, $end) {
return mt_rand($start, $end);
});
// Return the response to the client
echo $server->execute();
Class/Method binding:
<?php
use JsonRPC\Server;
class Api
{
public function doSomething($arg1, $arg2 = 3)
{
return $arg1 + $arg2;
}
}
$server = new Server;
// Bind the method Api::doSomething() to the procedure myProcedure
$server->bind('myProcedure', 'Api', 'doSomething');
// Use a class instance instead of the class name
$server->bind('mySecondProcedure', new Api, 'doSomething');
echo $server->execute();
Example with positional parameters:
<?php
use JsonRPC\Client;
$client = new Client('http://localhost/server.php');
$result = $client->execute('addition', [3, 5]);
var_dump($result);
Example with named arguments:
<?php
require 'JsonRPC/Client.php';
use JsonRPC\Client;
$client = new Client('http://localhost/server.php');
$result = $client->execute('random', ['end' => 10, 'start' => 1]);
var_dump($result);
Arguments are called in the right order.
Examples with shortcut methods:
<?php
use JsonRPC\Client;
$client = new Client('http://localhost/server.php');
$result = $client->random(50, 100);
var_dump($result);
The example above use positional arguments for the request and this one use named arguments:
$result = $client->random(['end' => 10, 'start' => 1]);
Call several procedures in a single HTTP request:
<?php
use JsonRPC\Client;
$client = new Client('http://localhost/server.php');
$results = $client->batch();
->foo(['arg1' => 'bar'])
->random(1, 100);
->add(4, 3);
->execute('add', [2, 5])
->send();
print_r($results);
All results are stored at the same position of the call.
BadFunctionCallException
: Procedure not found on the serverInvalidArgumentException
: Wrong procedure argumentsRuntimeException
: Protocol error
You can enable the debug to see the JSON request and response:
<?php
use JsonRPC\Client;
$client = new Client('http://localhost/server.php');
$client->debug = true;
The debug output is sent to the PHP's system logger.
You can configure the log destination in your php.ini
.
Output example:
==> Request:
{
"jsonrpc": "2.0",
"method": "removeCategory",
"id": 486782327,
"params": [
1
]
}
==> Response:
{
"jsonrpc": "2.0",
"id": 486782327,
"result": true
}
The server can allow only some IP adresses:
<?php
use JsonRPC\Server;
$server = new Server;
// IP client restrictions
$server->allowHosts(['192.168.0.1', '127.0.0.1']);
// Procedures registration
[...]
// Return the response to the client
echo $server->execute();
If the client is blocked, you got a 403 Forbidden HTTP response.
If you use HTTPS, you can allow client by using a username/password.
<?php
use JsonRPC\Server;
$server = new Server;
// List of users to allow
$server->authentication(['jsonrpc' => 'toto']);
// Procedures registration
[...]
// Return the response to the client
echo $server->execute();
On the client, set credentials like that:
<?php
use JsonRPC\Client;
$client = new Client('http://localhost/server.php');
$client->authentication('jsonrpc', 'toto');
If the authentication failed, the client throw a RuntimeException.