getdkan/rooted-json-data

Access and modify JSON-based data objects while enforcing JSON Schema

0.2.2 2024-05-29 16:40 UTC

Requires

• ext-json: *
• galbar/jsonpath: ^3.0
• opis/json-schema: ^1.0.8

Requires (Dev)

• phpunit/phpunit: ^9.4
• rector/rector: ^0.15.19
• squizlabs/php_codesniffer: ^3.7
• symfony/phpunit-bridge: ^7.0

GPL-3.0-or-later

• fmizzell
• Dan Feder

README

Access and modify JSON-based data objects while enforcing JSON Schema.

This library primarily wires together JsonPath-PHP and Opis JSON Schema, providing a JSON Object class that functions like a small internal service. Data can be added, retrieved and modified through a simple API, and any changes will immediately provoke a re-validation. Validation errors through exceptions with actionable messages.

Example:

$json = '{"number":3}';
$schema = '{"type": "object","properties": {"number":{ "type": "number" }}}';
$data = new RootedJsonData($json, $schema);
echo $data->{"$.number"}; // 3
echo $data->{"$[number]"}; // 3
echo "{$data}"; // {"number":3}
$data->{"$.number"} = "three"; // EXCEPTION