johnstevenson/json-works

Create, edit, query and validate json

Installs: 640

Dependents: 0

Suggesters: 0

Stars: 9

Watchers: 2

Forks: 1

Open Issues: 0

v1.1.0 2016-01-05 16:23 UTC

README

Build Status

A PHP library to create, edit, query and validate JSON.

Contents

About

The library is intended to be used with nested json structures, or with json data that needs validation. Or in any situation where you would find it is easier to do something like this:

<?php
$document = new JohnStevenson\JsonWorks\Document();

$document->addValue('/path/to/nested/array/-', array('firstName'=> 'Fred', 'lastName' => 'Blogg'));

# prettyPrint
$json = $document->toJson(true);

which will give you the following json:

{
    "path": {
        "to": {
            "nested": {
                "array": [
                    {
                        "firstName": "Fred",
                        "lastName": "Blogg"
                    }
                ]
            }
        }
    }
}

You can query this value by calling:

$person = $document->getValue('/path/to/nested/array/0');

and update it with:

$document->addValue('/path/to/nested/array/0/lastName', 'Bloggs');

and move it with:

$document->moveValue('/path/to/nested/array/0', '/users/-');

$document->tidy();
$json = $document->toJson(true);

to end up with:

{
    "users": [
        {
            "firstName": "Fred",
            "lastName": "Bloggs"
        }
    ]
}

then delete it with:

$document->deleteValue('/users/0');

Validation

Json-Works includes an implementation of JSON Schema, version 4. This allows you to validate your data. The following example schema describes an array containing objects whose properties are all required and whose types are defined.

{
    "items": {
        "properties": {
            "firstName": {"type": "string"},
            "lastName": {"type": "string"}
        },
        "required": ["firstName", "lastName"]
    }
}

Now when you try to add values, Json-Works will only do so if they are valid. So you have to check.

$document->loadSchema($schema);

$result = $document->addValue('/-', array('firstName'=> 'Fred', 'lastName' => 'Bloggs'));
# true

$result = $document->addValue('/-', array('firstName'=> 'Fred', 'lastName' => 3));
# false, lastName is not a string

$result = $document->addValue('/0', array('firstName'=> 'Fred'));
# true, required values are not checked when we are building

# but are checked if we validate directly

$result = $document->validate();
# false - required lastName is missing

Without a schema, any value can be added anywhere.

Installation

This package is available via Composer as johnstevenson/json-works. Either run the following command in your project directory:

composer require "johnstevenson/json-works=1.1.*"

or add the requirement to your composer.json file:

{
    "require": {
        "johnstevenson/json-works": "1.1.*"
    }
}

Usage

Full usage documentation is available in the Wiki.

License

Json-Works is licensed under the MIT License - see the LICENSE file for details.