Server side implementation of the JSON-RPC 2.0 protocol in PHP.
- PHP >= 5.4
use Acme\UserApplication;
use Kilte\JsonRpc\Application;
use Kilte\JsonRpc\Server;
use Kilte\JsonRpc\Request\IOStreamFactory;
use Kilte\JsonRpc\Response\HttpResponse;
$server = new Server(new Application(new UserApplication()), new IOStreamFactory());
$output = $server->handle();
if ($output !== null) {
(new HttpResponse($output))->send();
}You need to create an instance of Kilte\JsonRpc\Application to tell the server about methods that it can call.
Constructor takes a only one argument, which can be an object of some class, or an array of anonymous functions:
use Kilte\JsonRpc\Application;
// An object
class UserApplication
{
public function greet($name)
{
return sprintf('Hello %s!', $name);
}
}
$app = new Application(new UserApplication());
// An array
$userApp1 = [];
$userApp1['greet'] = function ($name) {
return sprintf('Hello %s!', $name);
};
$app1 = new Application($userApp1);Also you can declare namespaces:
$app = new Application(['namespace' => new UserApplication()]);
// Client: {"jsonrpc": "2.0", "method": "namespace.method", "params": [1, 2, 3], "id": 1}RequestFactory is responsible for creating an instance of the request, based on data received from a client for subsequent processing.
The library provides only IOStreamFactory, which receives data from the php://input stream.
You can define your own factory by creating a class that inherits from Kilte\JsonRpc\Request\AbstractFactory:
class ZMQRequestFactory extends AbstractFactory
{
private $responder;
public function __construct(ZMQSocket $responder)
{
$this->responder = $responder;
}
protected function getRequest()
{
$request = $this->responder->recv();
printf("Received message: %s\n", $request);
return $request;
}
}You can register a callback that will be executed before running an application method.
It takes a single argument, which is an instance of the \\Kilte\\JsonRpc\\Request\\Request class.
use Acme\UserApplication;
use Kilte\JsonRpc\Application;
use Kilte\JsonRpc\Server;
use Kilte\JsonRpc\Request\IOStreamFactory;
use Kilte\JsonRpc\Request\Request;
use Kilte\JsonRpc\Response\HttpResponse;
$server = new Server(new Application(new UserApplication()), new IOStreamFactory());
$server->before(function (Request $request) {
var_dump($request->getMethod());
});
$server->before(function (Request $request) {
if ($request->getMethod() == 'test') {
throw new \RuntimeException('Access denied');
}
});
$output = $server->handle();
if ($output !== null) {
(new HttpResponse($output))->send();
}$ composer install
$ vendor/bin/phpunit
- Added middlewares support
- Removed
\Kilte\JsonRpc\Response\ResponseInterface \Kilte\JsonRpc\Server::handle()method now returns json string or null (if notification received).- Improved error handling
- Added namespaces support
- First release
- Fork it
- Create your feature branch (git checkout -b awesome-feature)
- Make your changes
- Write/update tests, if necessary
- Update README.md, if necessary
- Push your branch to origin (git push origin awesome-feature)
- Send pull request
- ???
- PROFIT!!!
Do not forget merge upstream changes:
git remote add upstream https://github.com/Kilte/json-rpc
git checkout master
git pull upstream
git push origin master
Now you can to remove your branch:
git branch -d awesome-feature
git push origin :awesome-feature
THE MIT LICENSE (MIT)
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent