jalallinux/php-json-rpc-client

This Package helps developers to easily connect to RPC servers.

1.1.0 2022-11-24 17:49 UTC

Requires

• php: ^7.4|^8.0|^8.1|^8.2
• ext-json: *
• guzzlehttp/guzzle: ^7.2

Requires (Dev)

• pestphp/pest: ^1.20
• spatie/ray: ^1.28

MIT

• JalalLinuX

• jalallinux
• php-json-rpc-client

README

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

• JalalLinuX
• All Contributors

License

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