webmozart / json Goto Github PK

A robust JSON decoder/encoder with support for schema validation.

License: MIT License

PHP 100.00%

json's Introduction

Webmozart JSON

Latest release: 1.2.2

A robust wrapper for json_encode()/json_decode() that normalizes their behavior across PHP versions, throws meaningful exceptions and supports schema validation by default.

Installation

Use Composer to install the package:

$ composer require webmozart/json

Encoding

Use the JsonEncoder to encode data as JSON:

use Webmozart\Json\JsonEncoder;

$encoder = new JsonEncoder();

// Store JSON in string
$string = $encoder->encode($data);

// Store JSON in file
$encoder->encodeFile($data, '/path/to/file.json');

By default, the JSON schema stored in the $schema property of the JSON document is used to validate the file. You can also pass the path to the schema in the last optional argument of both methods:

use Webmozart\Json\ValidationFailedException;

try {
    $string = $encoder->encode($data, '/path/to/schema.json');
} catch (ValidationFailedException $e) {
    // data did not match schema 
}

Decoding

Use the JsonDecoder to decode a JSON string/file:

use Webmozart\Json\JsonDecoder;

$decoder = new JsonDecoder();

// Read JSON string
$data = $decoder->decode($string);

// Read JSON file
$data = $decoder->decodeFile('/path/to/file.json');

Like JsonEncoder, the decoder accepts the path to a JSON schema in the last optional argument of its methods:

use Webmozart\Json\ValidationFailedException;

try {
    $data = $decoder->decodeFile('/path/to/file.json', '/path/to/schema.json');
} catch (ValidationFailedException $e) {
    // data did not match schema 
}

Validation

Sometimes it is necessary to separate the steps of encoding/decoding JSON data and validating it against a schema. In this case, you can omit the schema argument during encoding/decoding and use the JsonValidator to validate the data manually later on:

use Webmozart\Json\JsonDecoder;
use Webmozart\Json\JsonValidator;
use Webmozart\Json\ValidationFailedException;

$decoder = new JsonDecoder();
$validator = new JsonValidator();

$data = $decoder->decodeFile('/path/to/file.json');

// process $data...

$errors = $validator->validate($data, '/path/to/schema.json');

if (count($errors) > 0) {
    // data did not match schema 
}

Note: This does not work if you use the $schema property to set the schema (see next section). If that property is set, the schema is always used for validation during encoding and decoding.

Schemas

You are encouraged to store the schema of your JSON documents in the $schema property:

{
    "$schema": "http://example.org/schemas/1.0/schema"
}

The utilities in this package will load the schema from the URL and use it for validating the document. Obviously, this has a hit on performance and depends on the availability of the server and an internet connection. Hence you are encouraged to ship the schema with your package. Use the LocalUriRetriever to map the URL to your local schema file:

$uriRetriever = new UriRetriever();
$uriRetriever->setUriRetriever(new LocalUriRetriever(
    // base directory
    __DIR__.'/../res/schemas',
    // list of schema mappings
    array(
        'http://example.org/schemas/1.0/schema' => 'schema-1.0.json',
    )
));

$validator = new JsonValidator(null, $uriRetriever);
$encoder = new JsonEncoder($validator);
$decoder = new JsonDecoder($validator);

// ...

Conversion

You can implement JsonConverter to encapsulate the conversion of objects from and to JSON structures in a single class:

use stdClass;
use Webmozart\Json\Conversion\JsonConverter;

class ConfigFileJsonConverter implements JsonConverter
{
    const SCHEMA = 'http://example.org/schemas/1.0/schema';
    
    public function toJson($configFile, array $options = array())
    {
        $jsonData = new stdClass();
        $jsonData->{'$schema'} = self::SCHEMA;
         
        if (null !== $configFile->getApplicationName()) {
            $jsonData->application = $configFile->getApplicationName();
        }
        
        // ...
        
        return $jsonData;
    }
    
    public function fromJson($jsonData, array $options = array())
    {
        $configFile = new ConfigFile();
        
        if (isset($jsonData->application)) {
            $configFile->setApplicationName($jsonData->application);
        }
        
        // ...
        
        return $configFile;
    }
}

Loading and dumping ConfigFile objects is very simple now:

$converter = new ConfigFileJsonConverter();

// Load config.json as ConfigFile object
$jsonData = $decoder->decodeFile('/path/to/config.json');
$configFile = $converter->fromJson($jsonData);

// Save ConfigFile object as config.json
$jsonData = $converter->toJson($configFile);
$encoder->encodeFile($jsonData, '/path/to/config.json');

You can automate the schema validation of your ConfigFile by wrapping the converter in a ValidatingConverter:

use Webmozart\Json\Validation\ValidatingConverter;

$converter = new ValidatingConverter(new ConfigFileJsonConverter());

You can also validate against an explicit schema by passing the schema to the ValidatingConverter:

use Webmozart\Json\Validation\ValidatingConverter;

$converter = new ValidatingConverter(
    new ConfigFileJsonConverter(),
    __DIR__.'/../res/schema/config-schema.json'
);

Versioning and Migration

When you continuously develop an application, you will enter the situation that you need to change your JSON schemas. Updating JSON files to match their changed schemas can be challenging and time consuming. This package supports a versioning mechanism to automate this migration.

Imagine config.json files in three different versions: 1.0, 2.0 and 3.0. The name of a key changed between those versions:

config.json (version 1.0)

{
    "$schema": "http://example.org/schemas/1.0/schema",
    "application": "Hello world!"
}

config.json (version 2.0)

{
    "$schema": "http://example.org/schemas/2.0/schema",
    "application.name": "Hello world!"
}

config.json (version 3.0)

{
    "$schema": "http://example.org/schemas/3.0/schema",
    "application": {
        "name": "Hello world!"
    }
}

You can support files in any of these versions by implementing:

A converter compatible with the latest version (e.g. 3.0)
Migrations that migrate older versions to newer versions (e.g. 1.0 to 2.0 and 2.0 to 3.0.

Let's look at an example of a ConfigFileJsonConverter for version 3.0:

use stdClass;
use Webmozart\Json\Conversion\JsonConverter;

class ConfigFileJsonConverter implements JsonConverter
{
    const SCHEMA = 'http://example.org/schemas/3.0/schema';
    
    public function toJson($configFile, array $options = array())
    {
        $jsonData = new stdClass();
        $jsonData->{'$schema'} = self::SCHEMA;
         
        if (null !== $configFile->getApplicationName()) {
            $jsonData->application = new stdClass();
            $jsonData->application->name = $configFile->getApplicationName();
        }
        
        // ...
        
        return $jsonData;
    }
    
    public function fromJson($jsonData, array $options = array())
    {
        $configFile = new ConfigFile();
        
        if (isset($jsonData->application->name)) {
            $configFile->setApplicationName($jsonData->application->name);
        }
        
        // ...
        
        return $configFile;
    }
}

This converter can be used as described in the previous section. However, it can only be used with config.json files in version 3.0.

We can add support for older files by implementing the JsonMigration interface. This interface contains four methods:

getSourceVersion(): returns the source version of the migration
getTargetVersion(): returns the target version of the migration
up(stdClass $jsonData): migrates from the source to the target version
down(stdClass $jsonData): migrates from the target to the source version

use Webmozart\Json\Migration\JsonMigration;

class ConfigFileJson20To30Migration implements JsonMigration
{
    const SOURCE_SCHEMA = 'http://example.org/schemas/2.0/schema';
    
    const TARGET_SCHEMA = 'http://example.org/schemas/3.0/schema';
    
    public function getSourceVersion()
    {
        return '2.0';
    }
    
    public function getTargetVersion()
    {
        return '3.0';
    }
    
    public function up(stdClass $jsonData)
    {
        $jsonData->{'$schema'} = self::TARGET_SCHEMA;
        
        if (isset($jsonData->{'application.name'})) {
            $jsonData->application = new stdClass();
            $jsonData->application->name = $jsonData->{'application.name'};
            
            unset($jsonData->{'application.name'});
        )
    }
    
    public function down(stdClass $jsonData)
    {
        $jsonData->{'$schema'} = self::SOURCE_SCHEMA;
        
        if (isset($jsonData->application->name)) {
            $jsonData->{'application.name'} = $jsonData->application->name;
            
            unset($jsonData->application);
        )
    }
}

With a list of such migrations, we can create a MigratingConverter that decorates our ConfigFileJsonConverter:

use Webmozart\Json\Migration\MigratingConverter;
use Webmozart\Json\Migration\MigrationManager;

// Written for version 3.0
$converter = new ConfigFileJsonConverter();

// Support for older versions. The order of migrations does not matter.
$migrationManager = new MigrationManager(array(
    new ConfigFileJson10To20Migration(),
    new ConfigFileJson20To30Migration(),
));

// Decorate the converter
$converter = new MigratingConverter($converter, $migrationManager);

The resulting converter is able to load and dump JSON files in any of the versions 1.0, 2.0 and 3.0.

// Loads a file in version 1.0, 2.0 or 3.0
$jsonData = $decoder->decodeFile('/path/to/config.json');
$configFile = $converter->fromJson($jsonData);

// Writes the file in the latest version by default (3.0)
$jsonData = $converter->toJson($configFile);
$encoder->encodeFile($jsonData, '/path/to/config.json');

// Writes the file in a specific version
$jsonData = $converter->toJson($configFile, array(
    'targetVersion' => '2.0',
));
$encoder->encodeFile($jsonData, '/path/to/config.json');

Validation of Different Versions

If you want to add schema validation, wrap your encoder into a ValidatingConverter. You can wrap both the inner and the outer converter to make sure that both the JSON before and after running the migrations complies to the corresponding schemas.

// Written for version 3.0
$converter = new ConfigFileJsonConverter();

// Decorate to validate against the schema at version 3.0
$converter = new ValidatingConverter($converter);

// Decorate to support different versions
$converter = new MigratingConverter($converter, $migrationManager);

// Decorate to validate against the old schema
$converter = new ValidatingConverter($converter);

If you store the version in a version field (see below) and want to use a custom schema depending on that version, you can pass schema paths or closures for resolving the schema paths:

// Written for version 3.0
$converter = new ConfigFileJsonConverter();

// Decorate to validate against the schema at version 3.0
$converter = new ValidatingConverter($converter, __DIR__.'/../res/schema/config-schema-3.0.json');

// Decorate to support different versions
$converter = new MigratingConverter($converter, $migrationManager);

// Decorate to validate against the old schema
$converter = new ValidatingConverter($converter, function ($jsonData) {
    return __DIR__.'/../res/schema/config-schema-'.$jsonData->version.'.json'
});

Using Custom Schema Versioning

By default, the version of the schema is stored in the schema name:

{
    "$schema": "http://example.com/schemas/1.0/my-schema"
}

The version must be enclosed by slashes. Appending the version to the schema, for example, won't work:

{
    "$schema": "http://example.com/schemas/my-schema-1.0"
}

You can however customize the format of the schema URI by creating a SchemaUriVersioner with a custom regular expression:

use Webmozart\Json\Versioning\SchemaUriVersioner;

$versioner = new SchemaUriVersioner('~(?<=-)\d+\.\d+(?=$)~');

$migrationManager = new MigrationManager(array(
    // migrations...
), $versioner);

// ...

The regular expression must match the version only. Make sure to wrap characters before and after the version in look-around assertions ((?<=...), (?=...)).

Storing the Version in a Field

Instead of storing the version in the schema URI, you could also store it in a separate field. For example, the field "version":

{
    "version": "1.0"
}

This use case is supported by the VersionFieldVersioner class:

use Webmozart\Json\Versioning\VersionFieldVersioner;

$versioner = new VersionFieldVersioner();

$migrationManager = new MigrationManager(array(
    // migrations...
), $versioner);

// ...

The constructor of VersionFieldVersioner optionally accepts a custom field name used to store the version. The default field name is "version".

Authors

Bernhard Schussek a.k.a. @webmozart
The Community Contributors

Contribute

Contributions to the package are always welcome!

Report any bugs or issues you find on the issue tracker.
You can grab the source code at the package's Git repository.

Support

If you are having problems, send a mail to [email protected] or shout out to @webmozart on Twitter.

License

All contents of this package are licensed under the MIT license.

json's People

Contributors

Stargazers

Watchers

json's Issues

Is the RefResolver intentionally not being used?

Thanks for this library. I'm using it and now that I'm trying to use references in schemas I'm asking myself whether you not resolve references on purpose? See this gist for an example. Without doing the reference resolution the schema contains

    "properties": {
        "billing_address": {
            "$ref": "#/definitions/address"
        },
        "shipping_address": {
            "$ref": "#/definitions/address"
        }
    },

instead of

"properties": {
        "billing_address": {
            "type": "object",
            "properties": {
                "street_address": {
                    "type": "string"
                },
                "city": {
                    "type": "string"
                },
                "state": {
                    "type": "string"
                }
            },
            "required": [
                "street_address",
                "city",
                "state"
            ],
            "id": "file:///srv/www/json-schema/schema-address.json#/definitions/address"
        },
        "shipping_address": {
            "type": "object",
            "properties": {
                "street_address": {
                    "type": "string"
                },
                "city": {
                    "type": "string"
                },
                "state": {
                    "type": "string"
                }
            },
            "required": [
                "street_address",
                "city",
                "state"
            ],
            "id": "file:///srv/www/json-schema/schema-address.json#/definitions/address"
        }
    }

Apart from the underlying library not supporting all cases of definitions and $ref usage I just wanted to make sure whether you're deviating intentionally from the README example of justinrainbow/json-schema.

json/src/Conversion/JsonConverter.php missing from 1.2.2 tag?

Is this correct for missing json/src/Conversion/JsonConverter.php file and other folders from 1.2.2 tag?

use Puli to load json schemas in JsonValidator

res/meta-schema.json could be mapped to /webmozart/json/meta-schema.json and JsonValidator::loadSchema should load Puli ressources

note: I have no idea how it could be done without introducing a BC break :/

Problem with big int

Following code:

$json = '{"int_overflow":9223372036854775807}';
$decoder = new JsonDecoder();
$decode = $decoder->decode($json);

Throws exception: json_decode(): integer overflow detected. This should be translate from a big int to the string value.

Release tag does not include complete library.

I think most of your library is missing from the release. See release tag 1.2.2 here : https://github.com/webmozart/json/tree/a1fb3da904b8364e3db47eed68f76bfb6cd0031a/src

composer require webmozart/json gives "webmozart/json": "^1.2", installs version 1.2.2

Comparing repository at tag 1.2.2 with master reveals obvious lack of code : https://github.com/webmozart/json/tree/master/src

Working with empty keys in JSON

Hi,

I have empty keys in my json that represent empty values in dropdowns. When I use native json_decode, empty keys are transformed to _empty_ string. This is a known PHP bug: https://bugs.php.net/bug.php?id=46600

So the following json decoded and encoded again is not the same as original:

$json = '{"test": {"": "foo"}}';
var_dump(json_encode(json_decode($json))); // "{"test":{"_empty_":"foo"}}"

Notice an _empty_ key instead of '' key.

The same behaviour is when I use this package:

$encoder = new JsonEncoder();
$decoder = new JsonDecoder();

$decoded = $decoder->decode('{"test": {"": "foo"}}');
dump($decoded);
dump($encoder->encode($decoded));

// output
{#1316
  +"test": {#1317
    +"_empty_": "foo"
  }
}
"{"test":{"_empty_":"foo"}}"

Do you have any recommendations on how to avoid this? I cant use assoc = true because in my json there are many keys with empty objects that are converted back as arrays when you use assoc = true

For now I use an ugly solution with replacing all _empty_ keys with empty strings:

private function jsonEncode($content)
{
    $jsonString = json_encode($content, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE);

    $fixedJsonString = str_replace('"_empty_":', '"":', $jsonString);

    return $fixedJsonString;
}

Write to file

Are you seriously?
https://github.com/webmozart/json/blob/master/src/JsonEncoder.php#L288

How about sharing file between multiple threads? You mush use something like this http://php.net/manual/en/function.flock.php

Recommend tag 'em and bag 'em

Herr webmozart, may I respectfully ask for a tag with the new shiny JsonValidator in it? Vielen dank.

RFC use develop branch for next changes

Hey @webmozart ,

I was looking for a way to handle json schema $ref locally and was happy that your package provides a nice mechanism: https://github.com/webmozart/json#schemas

We have the latest version installed 1.2.2 but the JsonValidator looks different in this version. So I was confused. Wouldn't it be better to work on upcoming feature in a develop branch so that the README in the master branch reflects the latest released version instead of the next?

The justinrainbow/json-schema package version is out of date

Currently, the library requires version ^1.6 of justinrainbow/json-schema. The current stable version is 5.2.0: https://packagist.org/packages/justinrainbow/json-schema

Support for PHP 8

Hello :)

Is it actually planned to support PHP 8?

This project requires php ^5.3.3|^7.0

Thank you

SCIM

This is not a bug report bug a general question about this library, validation and SCIM (https://tools.ietf.org/html/rfc7643).

Do you know if it is possible to use schemas described in the RFC7643 to validate SCIM resources using that library?

composer installs outdated package

Hello!

For some reason, composer require webmozart/json yields outdated package from Jan 14, which does not contain none of VersionFieldVersioner, SchemaUriVersioner, MigrationManager, MigratingConverter, JsonMigration, JsonConverter, ValidatingConverter, etc.

Please advise asap.

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.