README

This package extracts JSON objects from large JSON sources like files, endpoints and streams while saving memory. It parses heavy JSONs by using JsonStreamingParser and provides an easy API to declare what objects to extract and process.

Install

Via Composer

composer require simtabi/json-objects

Usage

Simply pass the JSON source (files, endpoints or streams) and optionally the key where objects are contained to create a new instance of JsonObjects. You can also call the factory method from():

$source = 'https://jsonplaceholder.typicode.com/users';

// Create a new instance specifying the JSON source to extract objects from
new JsonObjects($source);
// or
JsonObjects::from($source);

// Create a new instance specifying the JSON source and the key to extract objects from
new JsonObjects($source, 'address.geo');
// or
JsonObjects::from($source, 'address.geo');

When providing a key to extract objects from, you can use the dot notation to indicate nested sections of a JSON. For example nested.*.key extracts all the objects in the property key of every object contained in nested.

Under the hood JsonObjects supports PSR-7, hence any implementation of MessageInterface or StreamInterface is a valid source. This makes interactions with other packages supporting PSR-7 (e.g. Guzzle) even more convenient:

$response = $guzzle->get('https://jsonplaceholder.typicode.com/users');

// Create a new instance by passing an implementation of MessageInterface
JsonObjects::from($response);

// Create a new instance by passing an implementation of StreamInterface
JsonObjects::from($response->getBody());

Finally you can decide whether to extract and process objects one by one or in chunks. The memory will be allocated to read only these objects instead of the whole JSON document:

// Extract and process one object at a time from the given JSON source
JsonObjects::from($source)->each(function (array $object) {
    // Process one object
});

// Extract and process a chunk of objects at a time from the given JSON source
JsonObjects::from($source)->chunk(100, function (array $objects) {
    // Process 100 objects
});

Change log

Please see CHANGELOG for more information on what has changed recently.

Testing

$ composer test

Contributing

Please see CONTRIBUTING and CODE_OF_CONDUCT for details.

Security

If you discover any security related issues, please email andrea.marco.sartori@gmail.com instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.

simtabi / json-objects

Maintainers

Details