stolt/json-lines

Library for the JSON Lines text file format.

JsonLines

, _(*1)

This is a library to enline to the JSON Lines format and to deline back from it to JSON., _(*2)

Installation via Composer

``` bash composer require stolt/json-lines, <sub>(*3)</sub>

#### Usage
To __enline__ a data structure into JSON Lines use the `enline` method.
```php
$jsonLines = (new JsonLines())->enline([
    ["one" => 1, "two" => 2],
    ["three" => 3, "four" => 4, "five" => 5],
    ["six" => 6, "seven" => 7, "key" => "value"],
    ["nested" => ["a", "b", "c"]],
]);
var_dump($jsonLines);

Which will give you the following JSON Lines string., <sub>(*4)</sub>

string(107) "{"one":1,"two":2}
{"three":3,"four":4,"five":5}
{"six":6,"seven":7,"key":"value"}
{"nested":["a","b","c"]}
"

To enline a data structure into a JSON Lines file use the enlineToFile method, adding the gz extension will gzip compress the JSON Lines as shown next., <sub>(*5)</sub>

(new JsonLines())->enlineToFile([
    ["one" => 1, "two" => 2],
    ["three" => 3, "four" => 4, "five" => 5],
    ["six" => 6, "seven" => 7, "key" => "value"],
    ["nested" => ["a", "b", "c"]],
    'out.jsonl.gz'
]);

To deline JSON Lines back into JSON use the deline method., <sub>(*6)</sub>

$json = (new JsonLines())->deline('{"one":1,"two":2}
{"three":3,"four":4,"five":5}
{"six":6,"seven":7,"key":"value"}
{"nested":["a","b","c"]}'
);
var_dump($json)

Which will give you the following JSON string, which is only beautified here to illustrate the data structure., <sub>(*7)</sub>

string(287) "[
    {
        "one": 1,
        "two": 2
    },
    {
        "three": 3,
        "four": 4,
        "five": 5
    },
    {
        "six": 6,
        "seven": 7,
        "key": "value"
    },
    {
        "nested": [
            "a",
            "b",
            "c"
        ]
    }
]"

To deline a complete JSON Lines file back into JSON use the delineFromFile method., <sub>(*8)</sub>

$json = (new JsonLines())->delineFromFile('/path/to/enlined.jsonl');

To deline a complete JSON Lines file line-by-line, use the delineEachLineFromFile method. This allows to iterate over a large file without storing the entire delined file in memory., <sub>(*9)</sub>

$json_lines = (new JsonLines())->delineEachLineFromFile('/path/to/enlined.jsonl');
foreach ($json_lines as $json_line) {
    var_dump($json_line);
}

Running tests

bash composer test, <sub>(*10)</sub>

License

This library is licensed under the MIT license. Please see LICENSE for more details., <sub>(*11)</sub>

Changelog

Please see CHANGELOG for more details., <sub>(*12)</sub>

Contributing

Please see CONTRIBUTING for more details., <sub>(*13)</sub>