README

A dot-notated, chainable JSON editor for PHP with built-in file support and robust array handling.

Installation

Install via Composer.

$> composer require seworqs/json-editor

Usage

use Seworqs\Json\JsonEditor;

// Create a new file.
$newJson1 = JsonEditor::createNew("/path/to/save/json/file.json");

// If you want to overwrite a file when it already exists.
$newJson2 = JsonEditor::createNew("/path/to/save/json/file.json", true);

// Create a new file.
$newJson3 = JsonEditor::createFromFile("/path/to/existing/json/file.json");

// Overwrite boolean.
$overwrite = false;

// Add key/value
$newJson3->add('some-key', 'some-value', $overwrite);

// Add key/value in levels deep using dot notation.
$newJson3->add('level1.level2.level3', 'a-deep-value', $overwrite);

// OR Add key/value in levels deep using an array.
$newJson3->add('level1', ['level2' => ['level3' => 'a-deep-level']], $overwrite);

/* Both (using dots or array) will create this:
{
...
    "level1": {
        "level2": {
            "level3": "deep-value"
        }
    },
...
}
*/

More examples

Features

Create and edit new JSON file
Edit existing JSON file
Use easy dot notation to get to your keys
Add/delete single or multiple keys at once
Bump version with seworqs/semver integration

See our examples

Classes and namespaces

Namespace	Class	Description
Seworqs\JsonEditor	JsonEditor	Nice JSON editor

License

Apache-2.0, see LICENSE

About SEworqs

Seworqs builds clean, reusable modules for PHP and Mendix developers.

Learn more at github.com/seworqs

seworqs / json-editor

Maintainers

Details