Skip to content

jalallinux/php-json-rpc-client

Repository files navigation

Latest Version on Packagist Tests Total Downloads

This Package helps developers to easily connect to RPC servers.

Installation

You can install the package via composer:

composer require jalallinux/php-json-rpc-client

Usage

Create instance:

Supported options: https://docs.guzzlephp.org/en/stable/request-options.html#auth

$rpc = new RpcClient('http://localhost:8000/rpc/server', '2.0');

Defaults

  • rpc version: 2.0

  • options:

{
    "http_errors": false,
    "headers": {
      "Content-Type": "application/json",
      "Accept": "application/json"
    }
}

Set options:

$rpc->setOption('connect_timeout', 3.14);

Set headers:

$rpc->withHeaders(['api-key' => 'php-json-rpc-client-api-key']);

Set BasicAuth credential:

$rpc->withBasicAuth(['username', 'password']);

Set JWT authorization token:

$rpc->withJwtAuth('Bearer php-json-rpc-client-jwt-token');

Add RPC request:

$rpc->request('user.get', ['username' => 'jalallinux']);
$rpc->request('user.get', ['username' => 'jalallinux'], '1');

Add RPC notification:

Description: https://www.jsonrpc.org/specification#notification

$rpc->notify('user.get', ['username' => 'jalallinux']);

Send final requests:

$rpc->send();

Full Example:

$rpc = new RpcClient('http://localhost:8000/rpc/server', '2.0');

$response = $rpc->setOption('connect_timeout', 3.14);
                ->withHeaders(['api-key' => 'php-json-rpc-client-api-key']);
                ->withBasicAuth(['username', 'password']);
                ->withJwtAuth('Bearer php-json-rpc-client-jwt-token');
                ->request('user.get', ['username' => 'jalallinux']);
                ->request('user.get', ['username' => 'jalallinux'], '1');
                ->notify('user.get', ['username' => 'jalallinux']);
                ->send();

Response Methods:

$response->body(): string
$response->array(): array
$response->object(): object
$response->status(): int
$response->successful(): bool
$response->ok(): bool
$response->failed(): bool
$response->clientError(): bool
$response->serverError(): bool
$response->header(string $header): string
$response->headers(): array

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Sponsor this project

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages