psx/json

Read and transform JSON documents through JSON-Patch/Pointer

v3.0.2 2024-05-10 17:25 UTC

Requires

• php: >=8.0
• ext-json: *
• psx/record: ^3.0

Requires (Dev)

• phpunit/phpunit: ^9.0
• vimeo/psalm: ^5.0

Apache-2.0

• Christoph Kappestein

• json
• json-rpc
• json-patch
• json-pointer

README

About

Library which contains classes to handle JSON data. It implements the JSON patch and pointer specification and provides a simple JSON RPC server.

Usage

Patch/Pointer

<?php

$document = Document::from(\json_decode(\file_get_contents('/test.json')));
// or
$document = Document::from(\json_decode('{"author": {"name": "foo"}}'));

// get a value through a json pointer
$name = $document->pointer('/author/name');

// compare whether this document is equal to another document
$document->equals(['foo' => 'bar']);

// apply patch operations on the document
$document->patch([
    (object) ['op' => 'add', 'path' => '/author/uri', 'value' => 'http://google.com'],
]);

// convert the document back to a json string
echo $document->toString();

RPC Server

The following example shows a super simple JSON RPC server using plain PHP. It is also easy possible to integrate the server into any existing framework.

<?php

use PSX\Json\RPC\Server;
use PSX\Json\RPC\Exception\MethodNotFoundException;

$server = new Server(function($method, $arguments){
    if ($method === 'sum') {
        return array_sum($arguments);
    } else {
        throw new MethodNotFoundException('Method not found');
    }
});

$return = $server->invoke(\json_decode(file_get_contents('php://input')));

header('Content-Type: application/json');
echo \json_encode($return, JSON_PRETTY_PRINT);