yiisoft/json

Yii JSON encoding and decoding

1.0.0 2020-08-26 12:21 UTC

This package is auto-updated.

Last update: 2021-09-07 20:59:18 UTC


README

68747470733a2f2f796969736f66742e6769746875622e696f2f646f63732f696d616765732f7969695f6c6f676f2e737667

Yii JSON


Latest Stable Version Total Downloads Build Status Scrutinizer Code Quality Code Coverage Mutation testing badge static analysis type-coverage

The package provides methods to encode and decode JSON.

  • It always throws \JsonException instead of returning false on error.
  • It has sensible defaults, so you don't have to specify flags all the time.
  • It has handy method to encode for HTML safely.
  • It handles \JsonSerializable, \DateTimeInterface, and \SimpleXMLElement well.

Requirements

  • PHP 7.4 or higher.
  • JSON PHP extension.
  • SimpleXML PHP extension.

Installation

The package could be installed with composer:

composer require yiisoft/json --prefer-dist

General usage

Encoding:

use \Yiisoft\Json\Json;

$data = ['name' => 'Alex', 'team' => 'Yii'];
$json = Json::encode($data);

Encoding for HTML:

use \Yiisoft\Json\Json;

$data = ['name' => 'Alex', 'team' => 'Yii'];
$json = Json::htmlEncode($data);

Decoding:

use \Yiisoft\Json\Json;

$json = '{"name":"Alex","team":"Yii"}';
$data = Json::decode($json);

Testing

Unit testing

The package is tested with PHPUnit. To run tests:

./vendor/bin/phpunit

Mutation testing

The package tests are checked with Infection mutation framework with Infection Static Analysis Plugin. To run it:

./vendor/bin/roave-infection-static-analysis-plugin

Static analysis

The code is statically analyzed with Psalm. To run static analysis:

./vendor/bin/psalm

License

The Yii JSON is free software. It is released under the terms of the BSD License. Please see LICENSE for more information.

Maintained by Yii Software.

Support the project

Open Collective

Follow updates

Official website Twitter Telegram Facebook Slack