xp-forge/json

Reads and writes JSON to and from various input sources

Thursday, February 1, 2018
by thekid
Repository
3 Watchers
2 Stars
37,106 Installations

PHP
5 Dependents
0 Suggesters
0 Forks
0 Open issues
19 Versions
9 % Grown

The README.md

JSON

, _(*1)

Reads and writes JSON to and from various input sources., _(*2)

Examples

Reading can be done from a string, file or stream:, _(*3)

use text\json\Json;
use io\File;
use peer\SocketInputStream;

// Strings
$value= Json::read('"Test"');

// Input
$in= '{"Hello": "World"}');
$in= new File('input.json');
$in= new SocketInputStream(/* ... */);

$value= Json::read($in);

Writing can be done to a string, file or stream:, _(*4)

use text\json\Json;
use io\File;
use peer\SocketOutputStream;

// Strings
$json= Json::of('Test');

// Output
$out= new File('output.json');
$out= new SocketOuputStream(/* ... */);

Json::write($value, $out);

Formatted output

To change the output format, use one of the Output implementations and pass a Format instance to the output's constructor. The formats available are:, _(*5)

DenseFormat($options): Best for network I/O, no unsignificant whitespace, default if nothing given and accessible via Format::dense($options= ~Format::ESCAPE_SLASHES).
WrappedFormat($indent, $options): Wraps first-level arrays and all objects, uses whitespace after commas colons. An instance of this format using 4 spaces for indentation and per default leaving forward slashes unescaped is available via Format::wrapped($indent= " ", $options= ~Format::ESCAPE_SLASHES).

The available options that can be or'ed together are:, _(*6)

Format::ESCAPE_SLASHES: Escape forward-slashes with "\" - default behavior.
Format::ESCAPE_UNICODE: Escape unicode with "\uXXXX" - default behavior.
Format::ESCAPE_ENTITIES: Escape XML entities &, ", < and >. Per default, these are represented in their literal form.

use text\json\{FileOutput, Format};

$out= new FileOutput('glue.json', Format::wrapped());
$out->write([
  'name'    => 'example/package',
  'version' => '1.0.0',
  'require' => [
    'xp-forge/json'     => '^3.0',
    'xp-framework/core' => '^10.0'
  ]
]);

The above code will yield the following output:, _(*7)

{
    "name": "example/package",
    "version": "1.0.0'",
    "require": {
        "xp-forge/json": "^3.0",
        "xp-framework/core": "^10.0"
    }
}

Sequential processing

Processing elements sequentially can save you memory and give a better performance in certain situations., _(*8)

Reading

You can use the elements() method to receive an iterator over a JSON array. Instead of loading the entire source into memory and then returning the parsed array, it will parse one array element at a time, yielding them while going., _(*9)

use peer\http\HttpConnection;
use text\json\StreamInput;

$conn= new HttpConnection(...);
$in= new StreamInput($conn->get('/search?q=example&limit=1000')->in());
foreach ($in->elements() as $element) {
  // Process
}

If you get a huge object, you can also process it sequentially using the pairs() method. This will parse a single key/value pair at a time., _(*10)

use peer\http\HttpConnection;
use text\json\StreamInput;

$conn= new HttpConnection(...);
$in= new StreamInput($conn->get('/resources/4711?expand=*')->in());
foreach ($in->pairs() as $key => $value) {
  // Process
}

To detect the type of the data on the stream (again, without reading it completely), you can use the type() method., _(*11)

use peer\http\HttpConnection;
use text\json\StreamInput;

$conn= new HttpConnection(...);
$in= new StreamInput($conn->get($resource)->in());
$type= $in->type();
if ($type->isArray()) {
  // Handle arrays
} else if ($type->isObject()) {
  // Handle objects
} else {
  // Handle primitives
}

Writing

To write data sequentially, you can use the begin() method and the stream it returns. This makes sense when the source offers a way to read data sequentially, if you already have the entire data in memory, using write() has the same effect., _(*12)

use text\json\{StreamOutput, Types};

$query= $conn->query('select * from person');

$stream= (new StreamOutput(...))->begin(Types::$ARRAY);
while ($record= $query->next()) {
  $stream->element($record);
}
$stream->close();

As the Stream class implements the Closeable interface, it can be used in the with statement:, _(*13)

use text\json\{StreamOutput, Types};

$query= $conn->query('select * from person');

with ((new StreamOutput(...))->begin(Types::$ARRAY), function($stream) use($query) {
  while ($record= $query->next()) {
    $stream->element($record);
  }
});

library json

Reads and writes JSON to and from various input sources

xp-forge/json

The README.md

JSON

Examples

Formatted output

Sequential processing

Reading

Writing

Further reading

The Versions

dev-master

The Requires

The Development Requires

v3.1.0

The Requires

The Development Requires

v3.0.2

The Requires

The Development Requires

v3.0.1

The Requires

The Development Requires

v3.0.0

The Requires

The Development Requires

v2.3.1

The Requires

The Development Requires

v2.3.0

The Requires

The Development Requires

v2.2.0

The Requires

The Development Requires

v2.1.1

The Requires

The Development Requires

v2.1.0

The Requires

The Development Requires

v2.0.1

The Requires

The Development Requires

v2.0.0

The Requires

The Development Requires

v1.0.1

The Requires

v1.0.0

The Requires

dev-refactor/drop-php54

The Requires

dev-fix/read-after-close

The Requires

v0.9.0

The Requires

v0.8.5

The Requires

v0.8.4

The Requires