lukasros/json-include

Combine JSON data from multiple files.

dev-master 2014-08-19 15:10 UTC

Requires

• php: >=5.3.0

MPL

• Lukas Rosenstock

• json

README

What is JSONInclude?

XML has XInclude which allows to combine XML from different files into one. There is no generic equivalent for JSON that I am aware of, so I came up with a simple idea for it. I believe having this can be useful if we want to dynamically combine JSON output, e.g. in an API, from different static files without duplicating information in those files.

Let's explain it with an example ... assume we have one file:

{
 "key1" : "value1",
 "key2" : "@file2.txt"
}

The "@" is an include symbol which indicates the string behind it should be treated as the filename for inclusion. The content of the second file is this:

{
 "key1" : "value2"
}

Loading the first file with a JSONInclude parser would return the following output:

{
 "key1" : "value1",
 "key2" : {
  "key1" : "value2"
 }
}

The include symbol can also be changed in case a leading "@" is used for a different purpose.

What is JSONInclude-PHP?

A simple parser for JSONInclude as a reference implementation written in PHP. It also supports parsing JSON files with comments and generic preprocessing of JSON data.

How can I use it?

1. Add "lukasros/json-include": "dev-master" to the composer.json file for your project.
2. Install/update dependencies with composer.
3. Initialize an instance in your code: $jsonInclude = new LukasRos\JSONInclude\JSONInclude();
4. Load and parse a JSON file: $parsedJson = $jsonInclude->parseFileWithIncludes('filename.json');

Please check the demo folder for an example.

Who's behind it?

JSONInclude-PHP was created by Lukas Rosenstock. Contact me through my website at lukasrosenstock.net.

Terms

This software is released under the MPL - see LICENSE file for details.