yocto/yoclib-jsonrpc

This yocLibrary enables your project to encode and decode JSON-RPC messages in PHP.

v1.0.1 2024-05-21 11:19 UTC

Requires

• php: ^7.4||^8
• ext-json: *

Requires (Dev)

• phpunit/phpunit: ^7||^8||^9

GPL-3.0-or-later

• rpc
• php
• json
• composer
• json-rpc
• jsonrpc
• yocto
• yoclib

README

This yocLibrary enables your project to encode and decode JSON-RPC messages in PHP.

Status

Installation

composer require yocto/yoclib-jsonrpc

Use

Serialization

use YOCLIB\JSONRPC\JSONRPCException;
use YOCLIB\JSONRPC\Message;

// Create request
$message = Message::createRequest(123,'getInfo',['payments']);
// Create notification
$message = Message::createNotification('notificationEvent',['payed']);
// Create response
$message = Message::createResponse(123,['payments'=>['$10.12','$23.45','$12.34']]);

$object = $message->toObject();

try{
    $json = Message::encodeJSON($object);
}catch(JSONRPCException $e){
    //Handle encoding exception
}

Deserialization

use YOCLIB\JSONRPC\JSONRPCException;
use YOCLIB\JSONRPC\Message;

$json = file_get_contents('php://input'); // Get request body

try{
    $object = Message::decodeJSON($json);
}catch(JSONRPCException $e){
    //Handle decoding exception
}

if(Message::isBatch($object)){
    foreach($object AS $element){
        try{
            $message = Message::parse($element);
        }catch(JSONRPCException $e){
            //Handle message exception
        }
    }
}else{
    try{
        $message = Message::parse($object);
    }catch(JSONRPCException $e){
        //Handle message exception
    }
}